blob: 2d06fdd562524849bfaf67f7ded3c18188a5a146 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Hanno Beckerccc13d02020-05-04 12:30:04 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
297 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100298
299static size_t ssl_compute_padding_length( size_t len,
300 size_t granularity )
301{
302 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
303}
304
Hanno Becker581bc1b2020-05-04 12:20:03 +0100305/* This functions transforms a (D)TLS plaintext fragment and a record content
306 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
307 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
308 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100309 *
310 * struct {
311 * opaque content[DTLSPlaintext.length];
312 * ContentType real_type;
313 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100314 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100315 *
316 * Input:
317 * - `content`: The beginning of the buffer holding the
318 * plaintext to be wrapped.
319 * - `*content_size`: The length of the plaintext in Bytes.
320 * - `max_len`: The number of Bytes available starting from
321 * `content`. This must be `>= *content_size`.
322 * - `rec_type`: The desired record content type.
323 *
324 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100325 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
326 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100327 *
328 * Returns:
329 * - `0` on success.
330 * - A negative error code if `max_len` didn't offer enough space
331 * for the expansion.
332 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333static int ssl_build_inner_plaintext( unsigned char *content,
334 size_t *content_size,
335 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100336 uint8_t rec_type,
337 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338{
339 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340
341 /* Write real content type */
342 if( remaining == 0 )
343 return( -1 );
344 content[ len ] = rec_type;
345 len++;
346 remaining--;
347
348 if( remaining < pad )
349 return( -1 );
350 memset( content + len, 0, pad );
351 len += pad;
352 remaining -= pad;
353
354 *content_size = len;
355 return( 0 );
356}
357
Hanno Becker581bc1b2020-05-04 12:20:03 +0100358/* This function parses a (D)TLSInnerPlaintext structure.
359 * See ssl_build_inner_plaintext() for details. */
360static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 size_t *content_size,
362 uint8_t *rec_type )
363{
364 size_t remaining = *content_size;
365
366 /* Determine length of padding by skipping zeroes from the back. */
367 do
368 {
369 if( remaining == 0 )
370 return( -1 );
371 remaining--;
372 } while( content[ remaining ] == 0 );
373
374 *content_size = remaining;
375 *rec_type = content[ remaining ];
376
377 return( 0 );
378}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
380 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100381
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100382/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100383 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000384static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100385 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100386 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 unsigned minor_ver,
388 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000407 * Moreover, the additional data involves the length of the TLS
408 * ciphertext, not the TLS plaintext as in earlier versions.
409 * Quoting RFC 8446 (TLS 1.3):
410 *
411 * additional_data = TLSCiphertext.opaque_type ||
412 * TLSCiphertext.legacy_record_version ||
413 * TLSCiphertext.length
414 *
415 * We pass the tag length to this function in order to compute the
416 * ciphertext length from the inner plaintext length rec->data_len via
417 *
418 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
419 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 */
421
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000423 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424
425#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
427 {
428 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
429 * which differs from the length of the TLSInnerPlaintext
430 * by the length of the authentication tag. */
431 ad_len_field += taglen;
432 }
433 else
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
435 {
436 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Joe Subbiani6dd73642021-07-19 11:56:54 +0100457 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100458 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 }
460 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100462 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100463 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100465 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466
467 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000468}
469
Hanno Becker67a37db2020-05-28 16:27:07 +0100470#if defined(MBEDTLS_GCM_C) || \
471 defined(MBEDTLS_CCM_C) || \
472 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100473static int ssl_transform_aead_dynamic_iv_is_explicit(
474 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475{
Hanno Becker17263802020-05-28 07:05:48 +0100476 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477}
478
Hanno Becker17263802020-05-28 07:05:48 +0100479/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
480 *
481 * Concretely, this occurs in two variants:
482 *
483 * a) Fixed and dynamic IV lengths add up to total IV length, giving
484 * IV = fixed_iv || dynamic_iv
485 *
Hanno Becker15952812020-06-04 13:31:46 +0100486 * This variant is used in TLS 1.2 when used with GCM or CCM.
487 *
Hanno Becker17263802020-05-28 07:05:48 +0100488 * b) Fixed IV lengths matches total IV length, giving
489 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100490 *
491 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
492 *
493 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100494 *
495 * This function has the precondition that
496 *
497 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
498 *
499 * which has to be ensured by the caller. If this precondition
500 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100501 */
502static void ssl_build_record_nonce( unsigned char *dst_iv,
503 size_t dst_iv_len,
504 unsigned char const *fixed_iv,
505 size_t fixed_iv_len,
506 unsigned char const *dynamic_iv,
507 size_t dynamic_iv_len )
508{
509 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100510
511 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100512 memset( dst_iv, 0, dst_iv_len );
513 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100514
Hanno Becker17263802020-05-28 07:05:48 +0100515 dst_iv += dst_iv_len - dynamic_iv_len;
516 for( i = 0; i < dynamic_iv_len; i++ )
517 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518}
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520
Hanno Beckera18d1322018-01-03 14:27:32 +0000521int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
522 mbedtls_ssl_transform *transform,
523 mbedtls_record *rec,
524 int (*f_rng)(void *, unsigned char *, size_t),
525 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000526{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
573 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
574
575 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
576 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
578 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000579 rec->data_len,
580 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
582 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100583
Hanno Becker92313402020-05-20 13:58:58 +0100584 /* The following two code paths implement the (D)TLSInnerPlaintext
585 * structure present in TLS 1.3 and DTLS 1.2 + CID.
586 *
587 * See ssl_build_inner_plaintext() for more information.
588 *
589 * Note that this changes `rec->data_len`, and hence
590 * `post_avail` needs to be recalculated afterwards.
591 *
592 * Note also that the two code paths cannot occur simultaneously
593 * since they apply to different versions of the protocol. There
594 * is hence no risk of double-addition of the inner plaintext.
595 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100596#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
597 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
598 {
Hanno Becker13996922020-05-28 16:15:19 +0100599 size_t padding =
600 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200601 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100602 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100603 &rec->data_len,
604 post_avail,
605 rec->type,
606 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100607 {
608 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
609 }
610
611 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
612 }
613#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
614
Hanno Beckera0e20d02019-05-15 14:03:01 +0100615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100616 /*
617 * Add CID information
618 */
619 rec->cid_len = transform->out_cid_len;
620 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
621 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
623 if( rec->cid_len != 0 )
624 {
Hanno Becker13996922020-05-28 16:15:19 +0100625 size_t padding =
626 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200627 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100628 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100629 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100630 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100631 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100632 * Note that this changes `rec->data_len`, and hence
633 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100635 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 &rec->data_len,
637 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100638 rec->type,
639 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100640 {
641 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
642 }
643
644 rec->type = MBEDTLS_SSL_MSG_CID;
645 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100646#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100647
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100648 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
649
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100651 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000653#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 if( mode == MBEDTLS_MODE_STREAM ||
655 ( mode == MBEDTLS_MODE_CBC
656#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100658#endif
659 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000660 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 if( post_avail < transform->maclen )
662 {
663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
664 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
665 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200667 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000668
TRodziewicz345165c2021-07-06 13:42:11 +0200669 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000670 transform->minor_ver,
671 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000672
TRodziewicz345165c2021-07-06 13:42:11 +0200673 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
674 add_data_len );
675 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
676 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
677 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678
TRodziewicz345165c2021-07-06 13:42:11 +0200679 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
683 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200684
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000685 rec->data_len += transform->maclen;
686 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100687 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100688 mbedtls_platform_zeroize( mac, transform->maclen );
Paul Bakker577e0062013-08-28 11:57:20 +0200689 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000690#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000691
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200692 /*
693 * Encrypt
694 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000695#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000699 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000700 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 "including %d bytes of padding",
702 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000703
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
705 transform->iv_enc, transform->ivlen,
706 data, rec->data_len,
707 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200708 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200710 return( ret );
711 }
712
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000713 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
716 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200717 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000718 }
Paul Bakker68884e32013-01-07 18:20:04 +0100719 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000720#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000721
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200722#if defined(MBEDTLS_GCM_C) || \
723 defined(MBEDTLS_CCM_C) || \
724 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200726 mode == MBEDTLS_MODE_CCM ||
727 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000728 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200730 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100731 unsigned char *dynamic_iv;
732 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100733 int dynamic_iv_is_explicit =
734 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000735
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100736 /* Check that there's space for the authentication tag. */
737 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000738 {
739 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
740 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
741 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000742
Paul Bakker68884e32013-01-07 18:20:04 +0100743 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100744 * Build nonce for AEAD encryption.
745 *
746 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
747 * part of the IV is prepended to the ciphertext and
748 * can be chosen freely - in particular, it need not
749 * agree with the record sequence number.
750 * However, since ChaChaPoly as well as all AEAD modes
751 * in TLS 1.3 use the record sequence number as the
752 * dynamic part of the nonce, we uniformly use the
753 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100754 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100755 dynamic_iv = rec->ctr;
756 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200757
Hanno Becker17263802020-05-28 07:05:48 +0100758 ssl_build_record_nonce( iv, sizeof( iv ),
759 transform->iv_enc,
760 transform->fixed_ivlen,
761 dynamic_iv,
762 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100763
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100764 /*
765 * Build additional data for AEAD encryption.
766 * This depends on the TLS version.
767 */
768 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000769 transform->minor_ver,
770 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100771
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200772 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100773 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200774 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100775 dynamic_iv,
776 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000777 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100778 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000779 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200780 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000781 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000782
Paul Bakker68884e32013-01-07 18:20:04 +0100783 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200784 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200785 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000786
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100787 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000788 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100789 add_data, add_data_len,
790 data, rec->data_len, /* src */
791 data, rec->buf_len - (data - rec->buf), /* dst */
792 &rec->data_len,
793 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200794 {
TRodziewicz18efb732021-04-29 23:12:19 +0200795 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200796 return( ret );
797 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000798 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100799 data + rec->data_len - transform->taglen,
800 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100801 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000802 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100803
804 /*
805 * Prefix record content with dynamic IV in case it is explicit.
806 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100807 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100808 {
809 if( rec->data_offset < dynamic_iv_len )
810 {
811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
812 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
813 }
814
815 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
816 rec->data_offset -= dynamic_iv_len;
817 rec->data_len += dynamic_iv_len;
818 }
819
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100820 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000821 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000822 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100823#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200824#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000826 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 size_t padlen, i;
829 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000830
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000831 /* Currently we're always using minimal padding
832 * (up to 255 bytes would be allowed). */
833 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
834 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000835 padlen = 0;
836
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000837 /* Check there's enough space in the buffer for the padding. */
838 if( post_avail < padlen + 1 )
839 {
840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
841 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
842 }
843
Paul Bakker5121ce52009-01-03 21:22:43 +0000844 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000845 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000846
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 rec->data_len += padlen + 1;
848 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000849
TRodziewicz0f82ec62021-05-12 17:49:18 +0200850#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000851 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200852 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000853 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000854 */
TRodziewicz345165c2021-07-06 13:42:11 +0200855 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000856 {
TRodziewicz345165c2021-07-06 13:42:11 +0200857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000859 }
TRodziewicz345165c2021-07-06 13:42:11 +0200860
861 if( rec->data_offset < transform->ivlen )
862 {
863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
864 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
865 }
866
867 /*
868 * Generate IV
869 */
870 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
871 if( ret != 0 )
872 return( ret );
873
874 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200875#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000876
Paul Elliottd48d5c62021-01-07 14:47:05 +0000877 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
878 "including %" MBEDTLS_PRINTF_SIZET
879 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000880 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200881 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000882
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000883 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
884 transform->iv_enc,
885 transform->ivlen,
886 data, rec->data_len,
887 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200888 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200890 return( ret );
891 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200892
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200894 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
896 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200897 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200898
TRodziewicz0f82ec62021-05-12 17:49:18 +0200899 data -= transform->ivlen;
900 rec->data_offset -= transform->ivlen;
901 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100902
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100904 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100905 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000906 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
907
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100908 /*
909 * MAC(MAC_write_key, seq_num +
910 * TLSCipherText.type +
911 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100912 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200913 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100914 * ENC(content + padding + padding_length));
915 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916
917 if( post_avail < transform->maclen)
918 {
919 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
920 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
921 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100922
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100923 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000924 rec, transform->minor_ver,
925 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000928 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100929 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100930
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000931 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100932 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 mbedtls_md_hmac_update( &transform->md_ctx_enc,
934 data, rec->data_len );
935 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
936 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100937
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100939
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000940 rec->data_len += transform->maclen;
941 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100942 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100943 mbedtls_platform_zeroize( mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000946 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200947 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200948#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200949 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
951 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200952 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000953
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100954 /* Make extra sure authentication was performed, exactly once */
955 if( auth_done != 1 )
956 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
958 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100959 }
960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000962
963 return( 0 );
964}
965
Hanno Becker605949f2019-07-12 08:23:59 +0100966int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000967 mbedtls_ssl_transform *transform,
968 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000969{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000970 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000972 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000973#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100974 size_t padlen = 0, correct = 1;
975#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000976 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100977 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100978 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000979
Hanno Beckera18d1322018-01-03 14:27:32 +0000980#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200981 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000982 ((void) ssl);
983#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000986 if( rec == NULL ||
987 rec->buf == NULL ||
988 rec->buf_len < rec->data_offset ||
989 rec->buf_len - rec->data_offset < rec->data_len )
990 {
991 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100993 }
994
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000995 data = rec->buf + rec->data_offset;
996 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000997
Hanno Beckera0e20d02019-05-15 14:03:01 +0100998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100999 /*
1000 * Match record's CID with incoming CID.
1001 */
Hanno Becker938489a2019-05-08 13:02:22 +01001002 if( rec->cid_len != transform->in_cid_len ||
1003 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1004 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001005 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001006 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001007#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001008
Hanno Beckerd086bf02021-03-22 13:01:27 +00001009#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001011 {
1012 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001013 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1014 transform->iv_dec,
1015 transform->ivlen,
1016 data, rec->data_len,
1017 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001018 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001020 return( ret );
1021 }
1022
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001023 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001024 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1026 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001027 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001028 }
Paul Bakker68884e32013-01-07 18:20:04 +01001029 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001030#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001031#if defined(MBEDTLS_GCM_C) || \
1032 defined(MBEDTLS_CCM_C) || \
1033 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001035 mode == MBEDTLS_MODE_CCM ||
1036 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001037 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001038 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001039 unsigned char *dynamic_iv;
1040 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001041
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001042 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001043 * Extract dynamic part of nonce for AEAD decryption.
1044 *
1045 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1046 * part of the IV is prepended to the ciphertext and
1047 * can be chosen freely - in particular, it need not
1048 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001049 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001050 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001051 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001052 {
1053 if( rec->data_len < dynamic_iv_len )
1054 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001055 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1056 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001057 rec->data_len,
1058 dynamic_iv_len ) );
1059 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1060 }
1061 dynamic_iv = data;
1062
1063 data += dynamic_iv_len;
1064 rec->data_offset += dynamic_iv_len;
1065 rec->data_len -= dynamic_iv_len;
1066 }
Hanno Becker17263802020-05-28 07:05:48 +01001067 else
1068 {
1069 dynamic_iv = rec->ctr;
1070 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001071
1072 /* Check that there's space for the authentication tag. */
1073 if( rec->data_len < transform->taglen )
1074 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001075 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1076 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001077 rec->data_len,
1078 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001080 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001081 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001082
Hanno Beckerdf8be222020-05-21 15:30:57 +01001083 /*
1084 * Prepare nonce from dynamic and static parts.
1085 */
Hanno Becker17263802020-05-28 07:05:48 +01001086 ssl_build_record_nonce( iv, sizeof( iv ),
1087 transform->iv_dec,
1088 transform->fixed_ivlen,
1089 dynamic_iv,
1090 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001091
Hanno Beckerdf8be222020-05-21 15:30:57 +01001092 /*
1093 * Build additional data for AEAD encryption.
1094 * This depends on the TLS version.
1095 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001096 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001097 transform->minor_ver,
1098 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001099 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001100 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001101
Hanno Beckerd96a6522019-07-10 13:55:25 +01001102 /* Because of the check above, we know that there are
1103 * explicit_iv_len Bytes preceeding data, and taglen
1104 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001105 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001106 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001107
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001108 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001109 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001110 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001111
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001112 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001113 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001114 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001115 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001116 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001117 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001118 data, rec->data_len + transform->taglen, /* src */
1119 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001120 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001121 {
TRodziewicz18efb732021-04-29 23:12:19 +02001122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1125 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001126
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001127 return( ret );
1128 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001129 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001130
Hanno Beckerd96a6522019-07-10 13:55:25 +01001131 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001132 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001133 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1135 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001136 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001137 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001138 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001140#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001142 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001143 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001144
Paul Bakker5121ce52009-01-03 21:22:43 +00001145 /*
Paul Bakker45829992013-01-03 14:52:21 +01001146 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001147 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001148#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001149 /* The ciphertext is prefixed with the CBC IV. */
1150 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001151#endif
Paul Bakker45829992013-01-03 14:52:21 +01001152
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001153 /* Size considerations:
1154 *
1155 * - The CBC cipher text must not be empty and hence
1156 * at least of size transform->ivlen.
1157 *
1158 * Together with the potential IV-prefix, this explains
1159 * the first of the two checks below.
1160 *
1161 * - The record must contain a MAC, either in plain or
1162 * encrypted, depending on whether Encrypt-then-MAC
1163 * is used or not.
1164 * - If it is, the message contains the IV-prefix,
1165 * the CBC ciphertext, and the MAC.
1166 * - If it is not, the padded plaintext, and hence
1167 * the CBC ciphertext, has at least length maclen + 1
1168 * because there is at least the padding length byte.
1169 *
1170 * As the CBC ciphertext is not empty, both cases give the
1171 * lower bound minlen + maclen + 1 on the record size, which
1172 * we test for in the second check below.
1173 */
1174 if( rec->data_len < minlen + transform->ivlen ||
1175 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001176 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1178 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1179 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001180 "+ 1 ) ( + expl IV )", rec->data_len,
1181 transform->ivlen,
1182 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001183 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001184 }
1185
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001186 /*
1187 * Authenticate before decrypt if enabled
1188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001190 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001191 {
Hanno Becker992b6872017-11-09 18:57:39 +00001192 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001195
Hanno Beckerd96a6522019-07-10 13:55:25 +01001196 /* Update data_len in tandem with add_data.
1197 *
1198 * The subtraction is safe because of the previous check
1199 * data_len >= minlen + maclen + 1.
1200 *
1201 * Afterwards, we know that data + data_len is followed by at
1202 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001203 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001204 *
1205 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001207 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001208 transform->minor_ver,
1209 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001210
Hanno Beckerd96a6522019-07-10 13:55:25 +01001211 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001212 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1213 add_data_len );
1214 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1215 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1217 data, rec->data_len );
1218 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1219 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001220
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001221 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1222 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001223 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001224 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001225
Hanno Beckerd96a6522019-07-10 13:55:25 +01001226 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001227 ret = 0;
Gabor Mezei90437e32021-10-20 11:59:27 +02001228 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001229 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001232 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1233 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001234 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001235 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001236
1237 hmac_failed_etm_enabled:
1238 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1239 if( ret != 0 )
1240 return( ret );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001241 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001243
1244 /*
1245 * Check length sanity
1246 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001247
1248 /* We know from above that data_len > minlen >= 0,
1249 * so the following check in particular implies that
1250 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001252 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1254 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001255 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001256 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001257 }
1258
TRodziewicz0f82ec62021-05-12 17:49:18 +02001259#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001260 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001261 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001262 */
TRodziewicz345165c2021-07-06 13:42:11 +02001263 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1264 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001265
TRodziewicz345165c2021-07-06 13:42:11 +02001266 data += transform->ivlen;
1267 rec->data_offset += transform->ivlen;
1268 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001269#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001270
Hanno Beckerd96a6522019-07-10 13:55:25 +01001271 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1272
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001273 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1274 transform->iv_dec, transform->ivlen,
1275 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001278 return( ret );
1279 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001280
Hanno Beckerd96a6522019-07-10 13:55:25 +01001281 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001282 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001283 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1285 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001286 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001287
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001288 /* Safe since data_len >= minlen + maclen + 1, so after having
1289 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001290 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1291 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001292 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001293
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294 if( auth_done == 1 )
1295 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001296 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001297 rec->data_len,
1298 padlen + 1 );
1299 correct &= mask;
1300 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001301 }
1302 else
Paul Bakker45829992013-01-03 14:52:21 +01001303 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001305 if( rec->data_len < transform->maclen + padlen + 1 )
1306 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001307 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1308 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1309 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001310 rec->data_len,
1311 transform->maclen,
1312 padlen + 1 ) );
1313 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001314#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315
Gabor Mezei90437e32021-10-20 11:59:27 +02001316 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001317 rec->data_len,
1318 transform->maclen + padlen + 1 );
1319 correct &= mask;
1320 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001321 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001322
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001323 padlen++;
1324
1325 /* Regardless of the validity of the padding,
1326 * we have data_len >= padlen here. */
1327
TRodziewicz0f82ec62021-05-12 17:49:18 +02001328#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001329 /* The padding check involves a series of up to 256
1330 * consecutive memory reads at the end of the record
1331 * plaintext buffer. In order to hide the length and
1332 * validity of the padding, always perform exactly
1333 * `min(256,plaintext_len)` reads (but take into account
1334 * only the last `padlen` bytes for the padding check). */
1335 size_t pad_count = 0;
1336 volatile unsigned char* const check = data;
1337
1338 /* Index of first padding byte; it has been ensured above
1339 * that the subtraction is safe. */
1340 size_t const padding_idx = rec->data_len - padlen;
1341 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1342 size_t const start_idx = rec->data_len - num_checks;
1343 size_t idx;
1344
1345 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001346 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001347 /* pad_count += (idx >= padding_idx) &&
1348 * (check[idx] == padlen - 1);
1349 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001350 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1351 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001352 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001353 pad_count += mask & equal;
1354 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001355 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001358 if( padlen > 0 && correct == 0 )
1359 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001360#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001361 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001362
TRodziewicz0f82ec62021-05-12 17:49:18 +02001363#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001364
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001365 /* If the padding was found to be invalid, padlen == 0
1366 * and the subtraction is safe. If the padding was found valid,
1367 * padlen hasn't been changed and the previous assertion
1368 * data_len >= padlen still holds. */
1369 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001370 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001371 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001372#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1375 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001376 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001378#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001381#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001382
1383 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001384 * Authenticate if not done yet.
1385 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001386 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001387#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001388 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001389 {
Hanno Becker992b6872017-11-09 18:57:39 +00001390 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001391 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001392
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001393 /* If the initial value of padlen was such that
1394 * data_len < maclen + padlen + 1, then padlen
1395 * got reset to 1, and the initial check
1396 * data_len >= minlen + maclen + 1
1397 * guarantees that at this point we still
1398 * have at least data_len >= maclen.
1399 *
1400 * If the initial value of padlen was such that
1401 * data_len >= maclen + padlen + 1, then we have
1402 * subtracted either padlen + 1 (if the padding was correct)
1403 * or 0 (if the padding was incorrect) since then,
1404 * hence data_len >= maclen in any case.
1405 */
1406 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001407 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001408 transform->minor_ver,
1409 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001410
TRodziewicz0f82ec62021-05-12 17:49:18 +02001411#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001412 /*
1413 * The next two sizes are the minimum and maximum values of
1414 * data_len over all padlen values.
1415 *
1416 * They're independent of padlen, since we previously did
1417 * data_len -= padlen.
1418 *
1419 * Note that max_len + maclen is never more than the buffer
1420 * length, as we previously did in_msglen -= maclen too.
1421 */
1422 const size_t max_len = rec->data_len + padlen;
1423 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1424
Gabor Mezei90437e32021-10-20 11:59:27 +02001425 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001426 add_data, add_data_len,
1427 data, rec->data_len, min_len, max_len,
1428 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001429 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001430 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001431 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001432 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001433 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001434
Gabor Mezei90437e32021-10-20 11:59:27 +02001435 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001436 rec->data_len,
1437 min_len, max_len,
1438 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001439#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001440
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001441#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001443 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001444#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001445
Gabor Mezei90437e32021-10-20 11:59:27 +02001446 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001447 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001448 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449#if defined(MBEDTLS_SSL_DEBUG_ALL)
1450 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001451#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001452 correct = 0;
1453 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001454 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001455
1456 hmac_failed_etm_disabled:
1457 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1458 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1459 if( ret != 0 )
1460 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001461 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001462
1463 /*
1464 * Finally check the correct flag
1465 */
1466 if( correct == 0 )
1467 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001468#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001469
1470 /* Make extra sure authentication was performed, exactly once */
1471 if( auth_done != 1 )
1472 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1474 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001475 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001476
Hanno Beckerccc13d02020-05-04 12:30:04 +01001477#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1478 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1479 {
1480 /* Remove inner padding and infer true content type. */
1481 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1482 &rec->type );
1483
1484 if( ret != 0 )
1485 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1486 }
1487#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1488
Hanno Beckera0e20d02019-05-15 14:03:01 +01001489#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001490 if( rec->cid_len != 0 )
1491 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001492 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1493 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001494 if( ret != 0 )
1495 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1496 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001497#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001498
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001500
1501 return( 0 );
1502}
1503
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001504#undef MAC_NONE
1505#undef MAC_PLAINTEXT
1506#undef MAC_CIPHERTEXT
1507
Paul Bakker5121ce52009-01-03 21:22:43 +00001508/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001509 * Fill the input message buffer by appending data to it.
1510 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001511 *
1512 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1513 * available (from this read and/or a previous one). Otherwise, an error code
1514 * is returned (possibly EOF or WANT_READ).
1515 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001516 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1517 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1518 * since we always read a whole datagram at once.
1519 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001520 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001521 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001524{
Janos Follath865b3eb2019-12-16 11:46:15 +00001525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001526 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001527#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1528 size_t in_buf_len = ssl->in_buf_len;
1529#else
1530 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1531#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001534
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001535 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1536 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001538 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001540 }
1541
Darryl Greenb33cc762019-11-28 14:29:44 +00001542 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001543 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1545 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001546 }
1547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001549 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001550 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001551 uint32_t timeout;
1552
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001553 /*
1554 * The point is, we need to always read a full datagram at once, so we
1555 * sometimes read more then requested, and handle the additional data.
1556 * It could be the rest of the current record (while fetching the
1557 * header) and/or some other records in the same datagram.
1558 */
1559
1560 /*
1561 * Move to the next record in the already read datagram if applicable
1562 */
1563 if( ssl->next_record_offset != 0 )
1564 {
1565 if( ssl->in_left < ssl->next_record_offset )
1566 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1568 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001569 }
1570
1571 ssl->in_left -= ssl->next_record_offset;
1572
1573 if( ssl->in_left != 0 )
1574 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001575 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1576 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001577 ssl->next_record_offset ) );
1578 memmove( ssl->in_hdr,
1579 ssl->in_hdr + ssl->next_record_offset,
1580 ssl->in_left );
1581 }
1582
1583 ssl->next_record_offset = 0;
1584 }
1585
Paul Elliottd48d5c62021-01-07 14:47:05 +00001586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1587 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001588 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001589
1590 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001591 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001592 */
1593 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001596 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001597 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001598
1599 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001600 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001601 * are not at the beginning of a new record, the caller did something
1602 * wrong.
1603 */
1604 if( ssl->in_left != 0 )
1605 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1607 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001608 }
1609
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001610 /*
1611 * Don't even try to read if time's out already.
1612 * This avoids by-passing the timer when repeatedly receiving messages
1613 * that will end up being dropped.
1614 */
Hanno Becker7876d122020-02-05 10:39:31 +00001615 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001616 {
1617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001618 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001619 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001620 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001621 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001622 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001625 timeout = ssl->handshake->retransmit_timeout;
1626 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001627 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001628
Paul Elliott9f352112020-12-09 14:55:45 +00001629 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001630
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001631 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001632 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1633 timeout );
1634 else
1635 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001638
1639 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001641 }
1642
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001643 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001644 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001646 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001649 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001650 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1651 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001653 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001654 }
1655
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001657 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001659 return( ret );
1660 }
1661
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001662 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001663 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001665 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001667 {
Hanno Becker786300f2020-02-05 10:46:40 +00001668 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001669 {
Hanno Becker786300f2020-02-05 10:46:40 +00001670 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1671 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001672 return( ret );
1673 }
1674
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001675 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001676 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001678 }
1679
Paul Bakker5121ce52009-01-03 21:22:43 +00001680 if( ret < 0 )
1681 return( ret );
1682
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001683 ssl->in_left = ret;
1684 }
1685 else
1686#endif
1687 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001688 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1689 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001690 ssl->in_left, nb_want ) );
1691
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001692 while( ssl->in_left < nb_want )
1693 {
1694 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001695
Hanno Becker7876d122020-02-05 10:39:31 +00001696 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001697 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1698 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001699 {
1700 if( ssl->f_recv_timeout != NULL )
1701 {
1702 ret = ssl->f_recv_timeout( ssl->p_bio,
1703 ssl->in_hdr + ssl->in_left, len,
1704 ssl->conf->read_timeout );
1705 }
1706 else
1707 {
1708 ret = ssl->f_recv( ssl->p_bio,
1709 ssl->in_hdr + ssl->in_left, len );
1710 }
1711 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001712
Paul Elliottd48d5c62021-01-07 14:47:05 +00001713 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1714 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001715 ssl->in_left, nb_want ) );
1716 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001717
1718 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001720
1721 if( ret < 0 )
1722 return( ret );
1723
makise-homuraaf9513b2020-08-24 18:26:27 +03001724 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001725 {
Darryl Green11999bb2018-03-13 15:22:58 +00001726 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001727 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001728 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1730 }
1731
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001732 ssl->in_left += ret;
1733 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001734 }
1735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001737
1738 return( 0 );
1739}
1740
1741/*
1742 * Flush any data not yet written
1743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001745{
Janos Follath865b3eb2019-12-16 11:46:15 +00001746 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001747 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001750
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001751 if( ssl->f_send == NULL )
1752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001754 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001756 }
1757
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001758 /* Avoid incrementing counter if data is flushed */
1759 if( ssl->out_left == 0 )
1760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001762 return( 0 );
1763 }
1764
Paul Bakker5121ce52009-01-03 21:22:43 +00001765 while( ssl->out_left > 0 )
1766 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1768 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001769 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
Hanno Becker2b1e3542018-08-06 11:19:13 +01001771 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001772 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001775
1776 if( ret <= 0 )
1777 return( ret );
1778
makise-homuraaf9513b2020-08-24 18:26:27 +03001779 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001780 {
Darryl Green11999bb2018-03-13 15:22:58 +00001781 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001782 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001783 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001784 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1785 }
1786
Paul Bakker5121ce52009-01-03 21:22:43 +00001787 ssl->out_left -= ret;
1788 }
1789
Hanno Becker2b1e3542018-08-06 11:19:13 +01001790#if defined(MBEDTLS_SSL_PROTO_DTLS)
1791 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001792 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001793 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001794 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001795 else
1796#endif
1797 {
1798 ssl->out_hdr = ssl->out_buf + 8;
1799 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001800 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001803
1804 return( 0 );
1805}
1806
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001807/*
1808 * Functions to handle the DTLS retransmission state machine
1809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001811/*
1812 * Append current handshake message to current outgoing flight
1813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001815{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1818 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1819 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001820
1821 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001822 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001823 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001824 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001826 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001827 }
1828
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001829 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001830 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
1832 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001834 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001835 }
1836
1837 /* Copy current handshake message with headers */
1838 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1839 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001840 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001841 msg->next = NULL;
1842
1843 /* Append to the current flight */
1844 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001845 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001846 else
1847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001849 while( cur->next != NULL )
1850 cur = cur->next;
1851 cur->next = msg;
1852 }
1853
Hanno Becker3b235902018-08-06 09:54:53 +01001854 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001855 return( 0 );
1856}
1857
1858/*
1859 * Free the current flight of handshake messages
1860 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00001861void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001862{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863 mbedtls_ssl_flight_item *cur = flight;
1864 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001865
1866 while( cur != NULL )
1867 {
1868 next = cur->next;
1869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 mbedtls_free( cur->p );
1871 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001872
1873 cur = next;
1874 }
1875}
1876
1877/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001878 * Swap transform_out and out_ctr with the alternative ones
1879 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001880static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001881{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08001883 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001884
1885 if( ssl->transform_out == ssl->handshake->alt_transform_out )
1886 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001888 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001889 }
1890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001892
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001893 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001894 tmp_transform = ssl->transform_out;
1895 ssl->transform_out = ssl->handshake->alt_transform_out;
1896 ssl->handshake->alt_transform_out = tmp_transform;
1897
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001898 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08001899 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
1900 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
1901 sizeof( ssl->cur_out_ctr ) );
1902 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
1903 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001904
1905 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001906 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001907
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001908 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001909}
1910
1911/*
1912 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001913 */
1914int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
1915{
1916 int ret = 0;
1917
1918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
1919
1920 ret = mbedtls_ssl_flight_transmit( ssl );
1921
1922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
1923
1924 return( ret );
1925}
1926
1927/*
1928 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001929 *
1930 * Need to remember the current message in case flush_output returns
1931 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001932 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001933 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001934int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001935{
Janos Follath865b3eb2019-12-16 11:46:15 +00001936 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001940 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02001941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001942
1943 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001944 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001945 ret = ssl_swap_epochs( ssl );
1946 if( ret != 0 )
1947 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001950 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001951
1952 while( ssl->handshake->cur_msg != NULL )
1953 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001954 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001955 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01001956
Hanno Beckere1dcb032018-08-17 16:47:58 +01001957 int const is_finished =
1958 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
1959 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
1960
Hanno Becker04da1892018-08-14 13:22:10 +01001961 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
1962 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
1963
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001964 /* Swap epochs before sending Finished: we can't do it after
1965 * sending ChangeCipherSpec, in case write returns WANT_READ.
1966 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01001967 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001968 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01001970 ret = ssl_swap_epochs( ssl );
1971 if( ret != 0 )
1972 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02001973 }
1974
Hanno Becker67bc7c32018-08-06 11:33:50 +01001975 ret = ssl_get_remaining_payload_in_datagram( ssl );
1976 if( ret < 0 )
1977 return( ret );
1978 max_frag_len = (size_t) ret;
1979
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001980 /* CCS is copied as is, while HS messages may need fragmentation */
1981 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
1982 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01001983 if( max_frag_len == 0 )
1984 {
1985 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
1986 return( ret );
1987
1988 continue;
1989 }
1990
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001991 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01001992 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001993 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001994
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02001995 /* Update position inside current message */
1996 ssl->handshake->cur_msg_p += cur->len;
1997 }
1998 else
1999 {
2000 const unsigned char * const p = ssl->handshake->cur_msg_p;
2001 const size_t hs_len = cur->len - 12;
2002 const size_t frag_off = p - ( cur->p + 12 );
2003 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002004 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002005
Hanno Beckere1dcb032018-08-17 16:47:58 +01002006 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002007 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002008 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002009 {
2010 ret = ssl_swap_epochs( ssl );
2011 if( ret != 0 )
2012 return( ret );
2013 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002014
Hanno Becker67bc7c32018-08-06 11:33:50 +01002015 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2016 return( ret );
2017
2018 continue;
2019 }
2020 max_hs_frag_len = max_frag_len - 12;
2021
2022 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2023 max_hs_frag_len : rem_len;
2024
2025 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002026 {
2027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002028 (unsigned) cur_hs_frag_len,
2029 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002030 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002031
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002032 /* Messages are stored with handshake headers as if not fragmented,
2033 * copy beginning of headers then fill fragmentation fields.
2034 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2035 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036
Joe Subbiani5ecac212021-06-24 13:00:03 +01002037 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2038 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2039 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002040
Joe Subbiani5ecac212021-06-24 13:00:03 +01002041 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2042 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2043 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002044
2045 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2046
Hanno Becker3f7b9732018-08-28 09:53:25 +01002047 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002048 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2049 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002050 ssl->out_msgtype = cur->type;
2051
2052 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002053 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002054 }
2055
2056 /* If done with the current message move to the next one if any */
2057 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2058 {
2059 if( cur->next != NULL )
2060 {
2061 ssl->handshake->cur_msg = cur->next;
2062 ssl->handshake->cur_msg_p = cur->next->p + 12;
2063 }
2064 else
2065 {
2066 ssl->handshake->cur_msg = NULL;
2067 ssl->handshake->cur_msg_p = NULL;
2068 }
2069 }
2070
2071 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002072 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002073 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002075 return( ret );
2076 }
2077 }
2078
Hanno Becker67bc7c32018-08-06 11:33:50 +01002079 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2080 return( ret );
2081
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002082 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2084 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002085 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002086 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002088 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002089 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002090
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002092
2093 return( 0 );
2094}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002095
2096/*
2097 * To be called when the last message of an incoming flight is received.
2098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002100{
2101 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002102 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002103 ssl->handshake->flight = NULL;
2104 ssl->handshake->cur_msg = NULL;
2105
2106 /* The next incoming flight will start with this msg_seq */
2107 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2108
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002109 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002110 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002111
Hanno Becker0271f962018-08-16 13:23:47 +01002112 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002113 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002114
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002115 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002116 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2119 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002120 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002122 }
2123 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002125}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002126
2127/*
2128 * To be called when the last message of an outgoing flight is send.
2129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002131{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002132 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002133 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2136 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002137 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002139 }
2140 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002142}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144
Paul Bakker5121ce52009-01-03 21:22:43 +00002145/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002146 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148
2149/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002150 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002151 *
2152 * - fill in handshake headers
2153 * - update handshake checksum
2154 * - DTLS: save message for resending
2155 * - then pass to the record layer
2156 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002157 * DTLS: except for HelloRequest, messages are only queued, and will only be
2158 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002159 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002160 * Inputs:
2161 * - ssl->out_msglen: 4 + actual handshake message len
2162 * (4 is the size of handshake headers for TLS)
2163 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2164 * - ssl->out_msg + 4: the handshake message body
2165 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002166 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002167 * - ssl->out_msglen: the length of the record contents
2168 * (including handshake headers but excluding record headers)
2169 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002170 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002171int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2172 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002173{
Janos Follath865b3eb2019-12-16 11:46:15 +00002174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002175 const size_t hs_len = ssl->out_msglen - 4;
2176 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002177
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2179
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002180 /*
2181 * Sanity checks
2182 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002183 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002184 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2185 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002186 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2187 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002188 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002189
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002190 /* Whenever we send anything different from a
2191 * HelloRequest we should be in a handshake - double check. */
2192 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2193 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002194 ssl->handshake == NULL )
2195 {
2196 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2197 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2198 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002201 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2206 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002207 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002208#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002209
Hanno Beckerb50a2532018-08-06 11:52:54 +01002210 /* Double-check that we did not exceed the bounds
2211 * of the outgoing record buffer.
2212 * This should never fail as the various message
2213 * writing functions must obey the bounds of the
2214 * outgoing record buffer, but better be safe.
2215 *
2216 * Note: We deliberately do not check for the MTU or MFL here.
2217 */
2218 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2219 {
2220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002221 "size %" MBEDTLS_PRINTF_SIZET
2222 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002223 ssl->out_msglen,
2224 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002225 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2226 }
2227
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002228 /*
2229 * Fill handshake headers
2230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002232 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002233 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2234 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2235 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002236
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002237 /*
2238 * DTLS has additional fields in the Handshake layer,
2239 * between the length field and the actual payload:
2240 * uint16 message_seq;
2241 * uint24 fragment_offset;
2242 * uint24 fragment_length;
2243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002245 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002246 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002247 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002248 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002249 {
2250 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002251 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002252 hs_len,
2253 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002254 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2255 }
2256
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002257 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002258 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002259
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002260 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002261 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002262 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002263 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002264 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002265 }
2266 else
2267 {
2268 ssl->out_msg[4] = 0;
2269 ssl->out_msg[5] = 0;
2270 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002271
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002272 /* Handshake hashes are computed without fragmentation,
2273 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002274 memset( ssl->out_msg + 6, 0x00, 3 );
2275 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002276 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002278
Hanno Becker0207e532018-08-28 10:28:28 +01002279 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002280 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002281 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002282 }
2283
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002284 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002286 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002287 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2288 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002289 {
2290 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2291 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002293 return( ret );
2294 }
2295 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002296 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002297#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002298 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002299 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002300 {
2301 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2302 return( ret );
2303 }
2304 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002305
2306 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2307
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002308 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002309}
2310
2311/*
2312 * Record layer functions
2313 */
2314
2315/*
2316 * Write current record.
2317 *
2318 * Uses:
2319 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2320 * - ssl->out_msglen: length of the record content (excl headers)
2321 * - ssl->out_msg: record content
2322 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002323int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002324{
2325 int ret, done = 0;
2326 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002327 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002328
2329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002330
Paul Bakker05ef8352012-05-08 09:17:57 +00002331 if( !done )
2332 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002333 unsigned i;
2334 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002335#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2336 size_t out_buf_len = ssl->out_buf_len;
2337#else
2338 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2339#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002340 /* Skip writing the record content type to after the encryption,
2341 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002342 int minor_ver = ssl->minor_ver;
2343#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002344 /* TLS 1.3 still uses the TLS 1.2 version identifier
2345 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002346 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2347 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
2348#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
2349 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2350 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002351
Jerry Yuae0b2e22021-10-08 15:21:19 +08002352 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002353 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002354
Paul Bakker48916f92012-09-16 19:57:18 +00002355 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002356 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002357 mbedtls_record rec;
2358
2359 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002360 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002361 rec.data_len = ssl->out_msglen;
2362 rec.data_offset = ssl->out_msg - rec.buf;
2363
Jerry Yud96a5c22021-09-29 17:46:51 +08002364 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002365 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002366 ssl->conf->transport, rec.ver );
2367 rec.type = ssl->out_msgtype;
2368
Hanno Beckera0e20d02019-05-15 14:03:01 +01002369#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002370 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002371 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002372#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002373
Hanno Beckera18d1322018-01-03 14:27:32 +00002374 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002375 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002376 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002378 return( ret );
2379 }
2380
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002381 if( rec.data_offset != 0 )
2382 {
2383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2384 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2385 }
2386
Hanno Becker6430faf2019-05-08 11:57:13 +01002387 /* Update the record content type and CID. */
2388 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002389#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002390 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002391#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002392 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002393 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002394 }
2395
Hanno Becker5903de42019-05-03 14:46:38 +01002396 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002397
2398#if defined(MBEDTLS_SSL_PROTO_DTLS)
2399 /* In case of DTLS, double-check that we don't exceed
2400 * the remaining space in the datagram. */
2401 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2402 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002403 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002404 if( ret < 0 )
2405 return( ret );
2406
2407 if( protected_record_size > (size_t) ret )
2408 {
2409 /* Should never happen */
2410 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2411 }
2412 }
2413#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002414
Hanno Becker6430faf2019-05-08 11:57:13 +01002415 /* Now write the potentially updated record content type. */
2416 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2417
Paul Elliott9f352112020-12-09 14:55:45 +00002418 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002419 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002420 ssl->out_hdr[0], ssl->out_hdr[1],
2421 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002424 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002425
2426 ssl->out_left += protected_record_size;
2427 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002428 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002429
Hanno Beckerdd772292020-02-05 10:38:31 +00002430 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002431 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2432 break;
2433
2434 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002435 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002436 {
2437 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2438 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2439 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002440 }
2441
Hanno Becker67bc7c32018-08-06 11:33:50 +01002442#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002443 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2444 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002445 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002446 size_t remaining;
2447 ret = ssl_get_remaining_payload_in_datagram( ssl );
2448 if( ret < 0 )
2449 {
2450 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2451 ret );
2452 return( ret );
2453 }
2454
2455 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002456 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002457 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002458 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002459 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002460 else
2461 {
Hanno Becker513815a2018-08-20 11:56:09 +01002462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002463 }
2464 }
2465#endif /* MBEDTLS_SSL_PROTO_DTLS */
2466
2467 if( ( flush == SSL_FORCE_FLUSH ) &&
2468 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002471 return( ret );
2472 }
2473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002475
2476 return( 0 );
2477}
2478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002480
2481static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2482{
2483 if( ssl->in_msglen < ssl->in_hslen ||
2484 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2485 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2486 {
2487 return( 1 );
2488 }
2489 return( 0 );
2490}
Hanno Becker44650b72018-08-16 12:51:11 +01002491
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002492static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002493{
2494 return( ( ssl->in_msg[9] << 16 ) |
2495 ( ssl->in_msg[10] << 8 ) |
2496 ssl->in_msg[11] );
2497}
2498
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002499static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002500{
2501 return( ( ssl->in_msg[6] << 16 ) |
2502 ( ssl->in_msg[7] << 8 ) |
2503 ssl->in_msg[8] );
2504}
2505
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002506static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002507{
2508 uint32_t msg_len, frag_off, frag_len;
2509
2510 msg_len = ssl_get_hs_total_len( ssl );
2511 frag_off = ssl_get_hs_frag_off( ssl );
2512 frag_len = ssl_get_hs_frag_len( ssl );
2513
2514 if( frag_off > msg_len )
2515 return( -1 );
2516
2517 if( frag_len > msg_len - frag_off )
2518 return( -1 );
2519
2520 if( frag_len + 12 > ssl->in_msglen )
2521 return( -1 );
2522
2523 return( 0 );
2524}
2525
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002526/*
2527 * Mark bits in bitmask (used for DTLS HS reassembly)
2528 */
2529static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2530{
2531 unsigned int start_bits, end_bits;
2532
2533 start_bits = 8 - ( offset % 8 );
2534 if( start_bits != 8 )
2535 {
2536 size_t first_byte_idx = offset / 8;
2537
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002538 /* Special case */
2539 if( len <= start_bits )
2540 {
2541 for( ; len != 0; len-- )
2542 mask[first_byte_idx] |= 1 << ( start_bits - len );
2543
2544 /* Avoid potential issues with offset or len becoming invalid */
2545 return;
2546 }
2547
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002548 offset += start_bits; /* Now offset % 8 == 0 */
2549 len -= start_bits;
2550
2551 for( ; start_bits != 0; start_bits-- )
2552 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2553 }
2554
2555 end_bits = len % 8;
2556 if( end_bits != 0 )
2557 {
2558 size_t last_byte_idx = ( offset + len ) / 8;
2559
2560 len -= end_bits; /* Now len % 8 == 0 */
2561
2562 for( ; end_bits != 0; end_bits-- )
2563 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2564 }
2565
2566 memset( mask + offset / 8, 0xFF, len / 8 );
2567}
2568
2569/*
2570 * Check that bitmask is full
2571 */
2572static int ssl_bitmask_check( unsigned char *mask, size_t len )
2573{
2574 size_t i;
2575
2576 for( i = 0; i < len / 8; i++ )
2577 if( mask[i] != 0xFF )
2578 return( -1 );
2579
2580 for( i = 0; i < len % 8; i++ )
2581 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2582 return( -1 );
2583
2584 return( 0 );
2585}
2586
Hanno Becker56e205e2018-08-16 09:06:12 +01002587/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002588static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002589 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002590{
Hanno Becker56e205e2018-08-16 09:06:12 +01002591 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002592
Hanno Becker56e205e2018-08-16 09:06:12 +01002593 alloc_len = 12; /* Handshake header */
2594 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002595
Hanno Beckerd07df862018-08-16 09:14:58 +01002596 if( add_bitmap )
2597 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002598
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002599 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002600}
Hanno Becker56e205e2018-08-16 09:06:12 +01002601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002603
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002604static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002605{
2606 return( ( ssl->in_msg[1] << 16 ) |
2607 ( ssl->in_msg[2] << 8 ) |
2608 ssl->in_msg[3] );
2609}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002610
Simon Butcher99000142016-10-13 17:21:01 +01002611int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002612{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002614 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002616 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002618 }
2619
Hanno Becker12555c62018-08-16 12:47:53 +01002620 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002623 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002624 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002627 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002628 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002630 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002631
Hanno Becker44650b72018-08-16 12:51:11 +01002632 if( ssl_check_hs_header( ssl ) != 0 )
2633 {
2634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2635 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2636 }
2637
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002638 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002639 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2640 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2641 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2642 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002643 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002644 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2645 {
2646 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2647 recv_msg_seq,
2648 ssl->handshake->in_msg_seq ) );
2649 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2650 }
2651
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002652 /* Retransmit only on last message from previous flight, to avoid
2653 * too many retransmissions.
2654 * Besides, No sane server ever retransmits HelloVerifyRequest */
2655 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002657 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002659 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002660 recv_msg_seq,
2661 ssl->handshake->in_flight_start_seq ) );
2662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002666 return( ret );
2667 }
2668 }
2669 else
2670 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002672 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002673 recv_msg_seq,
2674 ssl->handshake->in_msg_seq ) );
2675 }
2676
Hanno Becker90333da2017-10-10 11:27:13 +01002677 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002678 }
2679 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002680
Hanno Becker6d97ef52018-08-16 13:09:04 +01002681 /* Message reassembly is handled alongside buffering of future
2682 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002683 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002684 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002685 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002688 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002689 }
2690 }
2691 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002693 /* With TLS we don't handle fragmentation (for now) */
2694 if( ssl->in_msglen < ssl->in_hslen )
2695 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2697 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002698 }
2699
Simon Butcher99000142016-10-13 17:21:01 +01002700 return( 0 );
2701}
2702
2703void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2704{
Hanno Becker0271f962018-08-16 13:23:47 +01002705 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002706
Hanno Becker0271f962018-08-16 13:23:47 +01002707 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002708 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002709 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002710 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002711
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002712 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002714 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002715 ssl->handshake != NULL )
2716 {
Hanno Becker0271f962018-08-16 13:23:47 +01002717 unsigned offset;
2718 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002719
Hanno Becker0271f962018-08-16 13:23:47 +01002720 /* Increment handshake sequence number */
2721 hs->in_msg_seq++;
2722
2723 /*
2724 * Clear up handshake buffering and reassembly structure.
2725 */
2726
2727 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002728 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002729
2730 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002731 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2732 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002733 offset++, hs_buf++ )
2734 {
2735 *hs_buf = *(hs_buf + 1);
2736 }
2737
2738 /* Create a fresh last entry */
2739 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002740 }
2741#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002742}
2743
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002744/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002745 * DTLS anti-replay: RFC 6347 4.1.2.6
2746 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002747 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2748 * Bit n is set iff record number in_window_top - n has been seen.
2749 *
2750 * Usually, in_window_top is the last record number seen and the lsb of
2751 * in_window is set. The only exception is the initial state (record number 0
2752 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002755void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002756{
2757 ssl->in_window_top = 0;
2758 ssl->in_window = 0;
2759}
2760
2761static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2762{
2763 return( ( (uint64_t) buf[0] << 40 ) |
2764 ( (uint64_t) buf[1] << 32 ) |
2765 ( (uint64_t) buf[2] << 24 ) |
2766 ( (uint64_t) buf[3] << 16 ) |
2767 ( (uint64_t) buf[4] << 8 ) |
2768 ( (uint64_t) buf[5] ) );
2769}
2770
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002771static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2772{
Janos Follath865b3eb2019-12-16 11:46:15 +00002773 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002774 unsigned char *original_in_ctr;
2775
2776 // save original in_ctr
2777 original_in_ctr = ssl->in_ctr;
2778
2779 // use counter from record
2780 ssl->in_ctr = record_in_ctr;
2781
2782 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2783
2784 // restore the counter
2785 ssl->in_ctr = original_in_ctr;
2786
2787 return ret;
2788}
2789
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002790/*
2791 * Return 0 if sequence number is acceptable, -1 otherwise
2792 */
Hanno Becker0183d692019-07-12 08:50:37 +01002793int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002794{
2795 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2796 uint64_t bit;
2797
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002798 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002799 return( 0 );
2800
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002801 if( rec_seqnum > ssl->in_window_top )
2802 return( 0 );
2803
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002804 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002805
2806 if( bit >= 64 )
2807 return( -1 );
2808
2809 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2810 return( -1 );
2811
2812 return( 0 );
2813}
2814
2815/*
2816 * Update replay window on new validated record
2817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002819{
2820 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2821
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002822 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002823 return;
2824
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002825 if( rec_seqnum > ssl->in_window_top )
2826 {
2827 /* Update window_top and the contents of the window */
2828 uint64_t shift = rec_seqnum - ssl->in_window_top;
2829
2830 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002831 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002832 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002833 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002834 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002835 ssl->in_window |= 1;
2836 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002837
2838 ssl->in_window_top = rec_seqnum;
2839 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002840 else
2841 {
2842 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002843 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002844
2845 if( bit < 64 ) /* Always true, but be extra sure */
2846 ssl->in_window |= (uint64_t) 1 << bit;
2847 }
2848}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002850
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02002851#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002852/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002853 * Without any SSL context, check if a datagram looks like a ClientHello with
2854 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01002855 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002856 *
2857 * - if cookie is valid, return 0
2858 * - if ClientHello looks superficially valid but cookie is not,
2859 * fill obuf and set olen, then
2860 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
2861 * - otherwise return a specific error code
2862 */
2863static int ssl_check_dtls_clihlo_cookie(
2864 mbedtls_ssl_cookie_write_t *f_cookie_write,
2865 mbedtls_ssl_cookie_check_t *f_cookie_check,
2866 void *p_cookie,
2867 const unsigned char *cli_id, size_t cli_id_len,
2868 const unsigned char *in, size_t in_len,
2869 unsigned char *obuf, size_t buf_len, size_t *olen )
2870{
2871 size_t sid_len, cookie_len;
2872 unsigned char *p;
2873
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002874 /*
2875 * Structure of ClientHello with record and handshake headers,
2876 * and expected values. We don't need to check a lot, more checks will be
2877 * done when actually parsing the ClientHello - skipping those checks
2878 * avoids code duplication and does not make cookie forging any easier.
2879 *
2880 * 0-0 ContentType type; copied, must be handshake
2881 * 1-2 ProtocolVersion version; copied
2882 * 3-4 uint16 epoch; copied, must be 0
2883 * 5-10 uint48 sequence_number; copied
2884 * 11-12 uint16 length; (ignored)
2885 *
2886 * 13-13 HandshakeType msg_type; (ignored)
2887 * 14-16 uint24 length; (ignored)
2888 * 17-18 uint16 message_seq; copied
2889 * 19-21 uint24 fragment_offset; copied, must be 0
2890 * 22-24 uint24 fragment_length; (ignored)
2891 *
2892 * 25-26 ProtocolVersion client_version; (ignored)
2893 * 27-58 Random random; (ignored)
2894 * 59-xx SessionID session_id; 1 byte len + sid_len content
2895 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
2896 * ...
2897 *
2898 * Minimum length is 61 bytes.
2899 */
2900 if( in_len < 61 ||
2901 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
2902 in[3] != 0 || in[4] != 0 ||
2903 in[19] != 0 || in[20] != 0 || in[21] != 0 )
2904 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01002905 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002906 }
2907
2908 sid_len = in[59];
2909 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002910 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002911
2912 cookie_len = in[60 + sid_len];
2913 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01002914 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002915
2916 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
2917 cli_id, cli_id_len ) == 0 )
2918 {
2919 /* Valid cookie */
2920 return( 0 );
2921 }
2922
2923 /*
2924 * If we get here, we've got an invalid cookie, let's prepare HVR.
2925 *
2926 * 0-0 ContentType type; copied
2927 * 1-2 ProtocolVersion version; copied
2928 * 3-4 uint16 epoch; copied
2929 * 5-10 uint48 sequence_number; copied
2930 * 11-12 uint16 length; olen - 13
2931 *
2932 * 13-13 HandshakeType msg_type; hello_verify_request
2933 * 14-16 uint24 length; olen - 25
2934 * 17-18 uint16 message_seq; copied
2935 * 19-21 uint24 fragment_offset; copied
2936 * 22-24 uint24 fragment_length; olen - 25
2937 *
2938 * 25-26 ProtocolVersion server_version; 0xfe 0xff
2939 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
2940 *
2941 * Minimum length is 28.
2942 */
2943 if( buf_len < 28 )
2944 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
2945
2946 /* Copy most fields and adapt others */
2947 memcpy( obuf, in, 25 );
2948 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
2949 obuf[25] = 0xfe;
2950 obuf[26] = 0xff;
2951
2952 /* Generate and write actual cookie */
2953 p = obuf + 28;
2954 if( f_cookie_write( p_cookie,
2955 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
2956 {
2957 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2958 }
2959
2960 *olen = p - obuf;
2961
2962 /* Go back and fill length fields */
2963 obuf[27] = (unsigned char)( *olen - 28 );
2964
Joe Subbianifbeb6922021-07-16 14:27:50 +01002965 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
2966 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
2967 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002968
Joe Subbiani6dd73642021-07-19 11:56:54 +01002969 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002970
2971 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
2972}
2973
2974/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002975 * Handle possible client reconnect with the same UDP quadruplet
2976 * (RFC 6347 Section 4.2.8).
2977 *
2978 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
2979 * that looks like a ClientHello.
2980 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002981 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002982 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002983 * - if the input looks like a ClientHello with a valid cookie,
2984 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02002985 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002986 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002987 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01002988 * This function is called (through ssl_check_client_reconnect()) when an
2989 * unexpected record is found in ssl_get_next_record(), which will discard the
2990 * record if we return 0, and bubble up the return value otherwise (this
2991 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
2992 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002993 */
2994static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
2995{
Janos Follath865b3eb2019-12-16 11:46:15 +00002996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02002997 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02002998
Hanno Becker2fddd372019-07-10 14:37:41 +01002999 if( ssl->conf->f_cookie_write == NULL ||
3000 ssl->conf->f_cookie_check == NULL )
3001 {
3002 /* If we can't use cookies to verify reachability of the peer,
3003 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3005 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003006 return( 0 );
3007 }
3008
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003009 ret = ssl_check_dtls_clihlo_cookie(
3010 ssl->conf->f_cookie_write,
3011 ssl->conf->f_cookie_check,
3012 ssl->conf->p_cookie,
3013 ssl->cli_id, ssl->cli_id_len,
3014 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003015 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003016
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003017 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3018
3019 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003020 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003021 int send_ret;
3022 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3023 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3024 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003025 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003026 * If the error is permanent we'll catch it later,
3027 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003028 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3029 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3030 (void) send_ret;
3031
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003032 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003033 }
3034
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003035 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003036 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003038 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003039 {
3040 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3041 return( ret );
3042 }
3043
3044 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003045 }
3046
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003047 return( ret );
3048}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003049#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003050
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003051static int ssl_check_record_type( uint8_t record_type )
3052{
3053 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3054 record_type != MBEDTLS_SSL_MSG_ALERT &&
3055 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3056 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3057 {
3058 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3059 }
3060
3061 return( 0 );
3062}
3063
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003064/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003065 * ContentType type;
3066 * ProtocolVersion version;
3067 * uint16 epoch; // DTLS only
3068 * uint48 sequence_number; // DTLS only
3069 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003070 *
3071 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003072 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003073 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3074 *
3075 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003076 * 1. proceed with the record if this function returns 0
3077 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3078 * 3. return CLIENT_RECONNECT if this function return that value
3079 * 4. drop the whole datagram if this function returns anything else.
3080 * Point 2 is needed when the peer is resending, and we have already received
3081 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003082 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003083static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003084 unsigned char *buf,
3085 size_t len,
3086 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003087{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003088 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003089
Hanno Beckere5e7e782019-07-11 12:29:35 +01003090 size_t const rec_hdr_type_offset = 0;
3091 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003092
Hanno Beckere5e7e782019-07-11 12:29:35 +01003093 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3094 rec_hdr_type_len;
3095 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003096
Hanno Beckere5e7e782019-07-11 12:29:35 +01003097 size_t const rec_hdr_ctr_len = 8;
3098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003099 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003100 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3101 rec_hdr_version_len;
3102
Hanno Beckera0e20d02019-05-15 14:03:01 +01003103#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003104 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3105 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003106 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003107#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3108#endif /* MBEDTLS_SSL_PROTO_DTLS */
3109
3110 size_t rec_hdr_len_offset; /* To be determined */
3111 size_t const rec_hdr_len_len = 2;
3112
3113 /*
3114 * Check minimum lengths for record header.
3115 */
3116
3117#if defined(MBEDTLS_SSL_PROTO_DTLS)
3118 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3119 {
3120 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3121 }
3122 else
3123#endif /* MBEDTLS_SSL_PROTO_DTLS */
3124 {
3125 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3126 }
3127
3128 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3129 {
3130 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3131 (unsigned) len,
3132 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3133 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3134 }
3135
3136 /*
3137 * Parse and validate record content type
3138 */
3139
3140 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003141
3142 /* Check record content type */
3143#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3144 rec->cid_len = 0;
3145
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003146 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003147 ssl->conf->cid_len != 0 &&
3148 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003149 {
3150 /* Shift pointers to account for record header including CID
3151 * struct {
3152 * ContentType special_type = tls12_cid;
3153 * ProtocolVersion version;
3154 * uint16 epoch;
3155 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003156 * opaque cid[cid_length]; // Additional field compared to
3157 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003158 * uint16 length;
3159 * opaque enc_content[DTLSCiphertext.length];
3160 * } DTLSCiphertext;
3161 */
3162
3163 /* So far, we only support static CID lengths
3164 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003165 rec_hdr_cid_len = ssl->conf->cid_len;
3166 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003167
Hanno Beckere5e7e782019-07-11 12:29:35 +01003168 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003169 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3171 (unsigned) len,
3172 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003173 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003174 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003175
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003176 /* configured CID len is guaranteed at most 255, see
3177 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3178 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003179 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003180 }
3181 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003182#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003183 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003184 if( ssl_check_record_type( rec->type ) )
3185 {
Hanno Becker54229812019-07-12 14:40:00 +01003186 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3187 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003188 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3189 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003190 }
3191
Hanno Beckere5e7e782019-07-11 12:29:35 +01003192 /*
3193 * Parse and validate record version
3194 */
3195
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003196 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3197 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003198 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3199 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003200 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003201
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003202 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003203 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003204 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3205 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003206 }
3207
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003208 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003209 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3211 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003212 }
3213
Hanno Beckere5e7e782019-07-11 12:29:35 +01003214 /*
3215 * Parse/Copy record sequence number.
3216 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003217
Hanno Beckere5e7e782019-07-11 12:29:35 +01003218#if defined(MBEDTLS_SSL_PROTO_DTLS)
3219 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003220 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003221 /* Copy explicit record sequence number from input buffer. */
3222 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3223 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003224 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003225 else
3226#endif /* MBEDTLS_SSL_PROTO_DTLS */
3227 {
3228 /* Copy implicit record sequence number from SSL context structure. */
3229 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3230 }
Paul Bakker40e46942009-01-03 21:51:57 +00003231
Hanno Beckere5e7e782019-07-11 12:29:35 +01003232 /*
3233 * Parse record length.
3234 */
3235
Hanno Beckere5e7e782019-07-11 12:29:35 +01003236 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003237 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3238 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003239 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003240
Paul Elliott9f352112020-12-09 14:55:45 +00003241 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003242 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003243 rec->type,
3244 major_ver, minor_ver, rec->data_len ) );
3245
3246 rec->buf = buf;
3247 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003248
Hanno Beckerd417cc92019-07-26 08:20:27 +01003249 if( rec->data_len == 0 )
3250 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003251
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003252 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003253 * DTLS-related tests.
3254 * Check epoch before checking length constraint because
3255 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3256 * message gets duplicated before the corresponding Finished message,
3257 * the second ChangeCipherSpec should be discarded because it belongs
3258 * to an old epoch, but not because its length is shorter than
3259 * the minimum record length for packets using the new record transform.
3260 * Note that these two kinds of failures are handled differently,
3261 * as an unexpected record is silently skipped but an invalid
3262 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003263 */
3264#if defined(MBEDTLS_SSL_PROTO_DTLS)
3265 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3266 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003267 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003268
Hanno Becker955a5c92019-07-10 17:12:07 +01003269 /* Check that the datagram is large enough to contain a record
3270 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003271 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003272 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003273 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3274 (unsigned) len,
3275 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003276 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3277 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003278
Hanno Becker37cfe732019-07-10 17:20:01 +01003279 /* Records from other, non-matching epochs are silently discarded.
3280 * (The case of same-port Client reconnects must be considered in
3281 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003282 if( rec_epoch != ssl->in_epoch )
3283 {
3284 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003285 "expected %u, received %lu",
3286 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003287
Hanno Becker552f7472019-07-19 10:59:12 +01003288 /* Records from the next epoch are considered for buffering
3289 * (concretely: early Finished messages). */
3290 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003291 {
Hanno Becker552f7472019-07-19 10:59:12 +01003292 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3293 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003294 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003295
Hanno Becker2fddd372019-07-10 14:37:41 +01003296 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003297 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003298#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003299 /* For records from the correct epoch, check whether their
3300 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003301 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3302 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003303 {
3304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3305 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3306 }
3307#endif
3308 }
3309#endif /* MBEDTLS_SSL_PROTO_DTLS */
3310
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003311 return( 0 );
3312}
Paul Bakker5121ce52009-01-03 21:22:43 +00003313
Paul Bakker5121ce52009-01-03 21:22:43 +00003314
Hanno Becker2fddd372019-07-10 14:37:41 +01003315#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3316static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3317{
3318 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3319
3320 /*
3321 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3322 * access the first byte of record content (handshake type), as we
3323 * have an active transform (possibly iv_len != 0), so use the
3324 * fact that the record header len is 13 instead.
3325 */
3326 if( rec_epoch == 0 &&
3327 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3328 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3329 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3330 ssl->in_left > 13 &&
3331 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3332 {
3333 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3334 "from the same port" ) );
3335 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003336 }
3337
3338 return( 0 );
3339}
Hanno Becker2fddd372019-07-10 14:37:41 +01003340#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003341
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003342/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003343 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003344 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003345static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3346 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003347{
3348 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003351 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003352
Ronald Cron7e38cba2021-11-24 12:43:39 +01003353 /*
3354 * In TLS 1.3, always treat ChangeCipherSpec records
3355 * as unencrypted. The only thing we do with them is
3356 * check the length and content and ignore them.
3357 */
3358#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
3359 if( ssl->transform_in != NULL &&
3360 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3361 {
3362 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3363 done = 1;
3364 }
3365#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
3366
Paul Bakker48916f92012-09-16 19:57:18 +00003367 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003368 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003369 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003370
Hanno Beckera18d1322018-01-03 14:27:32 +00003371 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003372 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003375
Hanno Beckera0e20d02019-05-15 14:03:01 +01003376#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003377 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3378 ssl->conf->ignore_unexpected_cid
3379 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3380 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003381 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003382 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003383 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003384#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003385
Paul Bakker5121ce52009-01-03 21:22:43 +00003386 return( ret );
3387 }
3388
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003389 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003390 {
3391 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003392 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003393 }
3394
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003395 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003396 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003397
Hanno Beckera0e20d02019-05-15 14:03:01 +01003398#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003399 /* We have already checked the record content type
3400 * in ssl_parse_record_header(), failing or silently
3401 * dropping the record in the case of an unknown type.
3402 *
3403 * Since with the use of CIDs, the record content type
3404 * might change during decryption, re-check the record
3405 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003406 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003407 {
3408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3409 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3410 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003411#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003412
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003413 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003414 {
3415#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3416 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003417 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003418 {
3419 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3421 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3422 }
3423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3424
3425 ssl->nb_zero++;
3426
3427 /*
3428 * Three or more empty messages may be a DoS attack
3429 * (excessive CPU consumption).
3430 */
3431 if( ssl->nb_zero > 3 )
3432 {
3433 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003434 "messages, possible DoS attack" ) );
3435 /* Treat the records as if they were not properly authenticated,
3436 * thereby failing the connection if we see more than allowed
3437 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003438 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3439 }
3440 }
3441 else
3442 ssl->nb_zero = 0;
3443
3444#if defined(MBEDTLS_SSL_PROTO_DTLS)
3445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3446 {
3447 ; /* in_ctr read from peer, not maintained internally */
3448 }
3449 else
3450#endif
3451 {
3452 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003453 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3454 i > mbedtls_ssl_ep_len( ssl ); i-- )
3455 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003456 if( ++ssl->in_ctr[i - 1] != 0 )
3457 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003458 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003459
3460 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003461 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003462 {
3463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3464 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3465 }
3466 }
3467
Paul Bakker5121ce52009-01-03 21:22:43 +00003468 }
3469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003471 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003472 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003474 }
3475#endif
3476
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003477 /* Check actual (decrypted) record content length against
3478 * configured maximum. */
3479 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3480 {
3481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3482 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3483 }
3484
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003485 return( 0 );
3486}
3487
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003488/*
3489 * Read a record.
3490 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003491 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3492 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3493 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003494 */
Hanno Becker1097b342018-08-15 14:09:41 +01003495
3496/* Helper functions for mbedtls_ssl_read_record(). */
3497static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003498static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3499static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003500
Hanno Becker327c93b2018-08-15 13:56:18 +01003501int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003502 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003503{
Janos Follath865b3eb2019-12-16 11:46:15 +00003504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003507
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003508 if( ssl->keep_current_message == 0 )
3509 {
3510 do {
Simon Butcher99000142016-10-13 17:21:01 +01003511
Hanno Becker26994592018-08-15 14:14:59 +01003512 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003513 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003514 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003515
Hanno Beckere74d5562018-08-15 14:26:08 +01003516 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003517 {
Hanno Becker40f50842018-08-15 14:48:01 +01003518#if defined(MBEDTLS_SSL_PROTO_DTLS)
3519 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003520
Hanno Becker40f50842018-08-15 14:48:01 +01003521 /* We only check for buffered messages if the
3522 * current datagram is fully consumed. */
3523 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003524 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003525 {
Hanno Becker40f50842018-08-15 14:48:01 +01003526 if( ssl_load_buffered_message( ssl ) == 0 )
3527 have_buffered = 1;
3528 }
3529
3530 if( have_buffered == 0 )
3531#endif /* MBEDTLS_SSL_PROTO_DTLS */
3532 {
3533 ret = ssl_get_next_record( ssl );
3534 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3535 continue;
3536
3537 if( ret != 0 )
3538 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003539 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003540 return( ret );
3541 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003542 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003543 }
3544
3545 ret = mbedtls_ssl_handle_message_type( ssl );
3546
Hanno Becker40f50842018-08-15 14:48:01 +01003547#if defined(MBEDTLS_SSL_PROTO_DTLS)
3548 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3549 {
3550 /* Buffer future message */
3551 ret = ssl_buffer_message( ssl );
3552 if( ret != 0 )
3553 return( ret );
3554
3555 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3556 }
3557#endif /* MBEDTLS_SSL_PROTO_DTLS */
3558
Hanno Becker90333da2017-10-10 11:27:13 +01003559 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3560 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003561
3562 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003563 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003564 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003565 return( ret );
3566 }
3567
Hanno Becker327c93b2018-08-15 13:56:18 +01003568 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003569 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003570 {
3571 mbedtls_ssl_update_handshake_status( ssl );
3572 }
Simon Butcher99000142016-10-13 17:21:01 +01003573 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003574 else
Simon Butcher99000142016-10-13 17:21:01 +01003575 {
Hanno Becker02f59072018-08-15 14:00:24 +01003576 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003577 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003578 }
3579
3580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3581
3582 return( 0 );
3583}
3584
Hanno Becker40f50842018-08-15 14:48:01 +01003585#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003586static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003587{
Hanno Becker40f50842018-08-15 14:48:01 +01003588 if( ssl->in_left > ssl->next_record_offset )
3589 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003590
Hanno Becker40f50842018-08-15 14:48:01 +01003591 return( 0 );
3592}
3593
3594static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3595{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003596 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003597 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003598 int ret = 0;
3599
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003600 if( hs == NULL )
3601 return( -1 );
3602
Hanno Beckere00ae372018-08-20 09:39:42 +01003603 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3604
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003605 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3606 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3607 {
3608 /* Check if we have seen a ChangeCipherSpec before.
3609 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003610 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003611 {
3612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3613 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003614 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003615 }
3616
Hanno Becker39b8bc92018-08-28 17:17:13 +01003617 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003618 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3619 ssl->in_msglen = 1;
3620 ssl->in_msg[0] = 1;
3621
3622 /* As long as they are equal, the exact value doesn't matter. */
3623 ssl->in_left = 0;
3624 ssl->next_record_offset = 0;
3625
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003626 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003627 goto exit;
3628 }
Hanno Becker37f95322018-08-16 13:55:32 +01003629
Hanno Beckerb8f50142018-08-28 10:01:34 +01003630#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003631 /* Debug only */
3632 {
3633 unsigned offset;
3634 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3635 {
3636 hs_buf = &hs->buffering.hs[offset];
3637 if( hs_buf->is_valid == 1 )
3638 {
3639 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3640 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003641 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003642 }
3643 }
3644 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003645#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003646
3647 /* Check if we have buffered and/or fully reassembled the
3648 * next handshake message. */
3649 hs_buf = &hs->buffering.hs[0];
3650 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3651 {
3652 /* Synthesize a record containing the buffered HS message. */
3653 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3654 ( hs_buf->data[2] << 8 ) |
3655 hs_buf->data[3];
3656
3657 /* Double-check that we haven't accidentally buffered
3658 * a message that doesn't fit into the input buffer. */
3659 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3660 {
3661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3662 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3663 }
3664
3665 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3666 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3667 hs_buf->data, msg_len + 12 );
3668
3669 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3670 ssl->in_hslen = msg_len + 12;
3671 ssl->in_msglen = msg_len + 12;
3672 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3673
3674 ret = 0;
3675 goto exit;
3676 }
3677 else
3678 {
3679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3680 hs->in_msg_seq ) );
3681 }
3682
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003683 ret = -1;
3684
3685exit:
3686
3687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3688 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003689}
3690
Hanno Beckera02b0b42018-08-21 17:20:27 +01003691static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3692 size_t desired )
3693{
3694 int offset;
3695 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3697 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003698
Hanno Becker01315ea2018-08-21 17:22:17 +01003699 /* Get rid of future records epoch first, if such exist. */
3700 ssl_free_buffered_record( ssl );
3701
3702 /* Check if we have enough space available now. */
3703 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3704 hs->buffering.total_bytes_buffered ) )
3705 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003706 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003707 return( 0 );
3708 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003709
Hanno Becker4f432ad2018-08-28 10:02:32 +01003710 /* We don't have enough space to buffer the next expected handshake
3711 * message. Remove buffers used for future messages to gain space,
3712 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003713 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3714 offset >= 0; offset-- )
3715 {
3716 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3717 offset ) );
3718
Hanno Beckerb309b922018-08-23 13:18:05 +01003719 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003720
3721 /* Check if we have enough space available now. */
3722 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3723 hs->buffering.total_bytes_buffered ) )
3724 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003726 return( 0 );
3727 }
3728 }
3729
3730 return( -1 );
3731}
3732
Hanno Becker40f50842018-08-15 14:48:01 +01003733static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3734{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003735 int ret = 0;
3736 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3737
3738 if( hs == NULL )
3739 return( 0 );
3740
3741 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3742
3743 switch( ssl->in_msgtype )
3744 {
3745 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003747
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003748 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003749 break;
3750
3751 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003752 {
3753 unsigned recv_msg_seq_offset;
3754 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3755 mbedtls_ssl_hs_buffer *hs_buf;
3756 size_t msg_len = ssl->in_hslen - 12;
3757
3758 /* We should never receive an old handshake
3759 * message - double-check nonetheless. */
3760 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3761 {
3762 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3763 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3764 }
3765
3766 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3767 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3768 {
3769 /* Silently ignore -- message too far in the future */
3770 MBEDTLS_SSL_DEBUG_MSG( 2,
3771 ( "Ignore future HS message with sequence number %u, "
3772 "buffering window %u - %u",
3773 recv_msg_seq, ssl->handshake->in_msg_seq,
3774 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3775
3776 goto exit;
3777 }
3778
3779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3780 recv_msg_seq, recv_msg_seq_offset ) );
3781
3782 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3783
3784 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003785 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003786 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003787 size_t reassembly_buf_sz;
3788
Hanno Becker37f95322018-08-16 13:55:32 +01003789 hs_buf->is_fragmented =
3790 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3791
3792 /* We copy the message back into the input buffer
3793 * after reassembly, so check that it's not too large.
3794 * This is an implementation-specific limitation
3795 * and not one from the standard, hence it is not
3796 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003797 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003798 {
3799 /* Ignore message */
3800 goto exit;
3801 }
3802
Hanno Beckere0b150f2018-08-21 15:51:03 +01003803 /* Check if we have enough space to buffer the message. */
3804 if( hs->buffering.total_bytes_buffered >
3805 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3806 {
3807 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3808 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3809 }
3810
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003811 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3812 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003813
3814 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3815 hs->buffering.total_bytes_buffered ) )
3816 {
3817 if( recv_msg_seq_offset > 0 )
3818 {
3819 /* If we can't buffer a future message because
3820 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00003821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3822 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3823 " (already %" MBEDTLS_PRINTF_SIZET
3824 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003825 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003826 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003827 goto exit;
3828 }
Hanno Beckere1801392018-08-21 16:51:05 +01003829 else
3830 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
3832 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
3833 " (already %" MBEDTLS_PRINTF_SIZET
3834 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00003835 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003836 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01003837 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003838
Hanno Beckera02b0b42018-08-21 17:20:27 +01003839 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003840 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
3842 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
3843 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
3844 " (already %" MBEDTLS_PRINTF_SIZET
3845 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00003846 msg_len,
3847 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00003848 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00003849 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01003850 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3851 goto exit;
3852 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003853 }
3854
Paul Elliottd48d5c62021-01-07 14:47:05 +00003855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01003856 msg_len ) );
3857
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003858 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
3859 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01003860 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01003861 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01003862 goto exit;
3863 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01003864 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003865
3866 /* Prepare final header: copy msg_type, length and message_seq,
3867 * then add standardised fragment_offset and fragment_length */
3868 memcpy( hs_buf->data, ssl->in_msg, 6 );
3869 memset( hs_buf->data + 6, 0, 3 );
3870 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
3871
3872 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01003873
3874 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01003875 }
3876 else
3877 {
3878 /* Make sure msg_type and length are consistent */
3879 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
3880 {
3881 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
3882 /* Ignore */
3883 goto exit;
3884 }
3885 }
3886
Hanno Becker4422bbb2018-08-20 09:40:19 +01003887 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01003888 {
3889 size_t frag_len, frag_off;
3890 unsigned char * const msg = hs_buf->data + 12;
3891
3892 /*
3893 * Check and copy current fragment
3894 */
3895
3896 /* Validation of header fields already done in
3897 * mbedtls_ssl_prepare_handshake_record(). */
3898 frag_off = ssl_get_hs_frag_off( ssl );
3899 frag_len = ssl_get_hs_frag_len( ssl );
3900
Paul Elliottd48d5c62021-01-07 14:47:05 +00003901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
3902 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01003903 frag_off, frag_len ) );
3904 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
3905
3906 if( hs_buf->is_fragmented )
3907 {
3908 unsigned char * const bitmask = msg + msg_len;
3909 ssl_bitmask_set( bitmask, frag_off, frag_len );
3910 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
3911 msg_len ) == 0 );
3912 }
3913 else
3914 {
3915 hs_buf->is_complete = 1;
3916 }
3917
3918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
3919 hs_buf->is_complete ? "" : "not yet " ) );
3920 }
3921
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003922 break;
Hanno Becker37f95322018-08-16 13:55:32 +01003923 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003924
3925 default:
Hanno Becker360bef32018-08-28 10:04:33 +01003926 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003927 break;
3928 }
3929
3930exit:
3931
3932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
3933 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003934}
3935#endif /* MBEDTLS_SSL_PROTO_DTLS */
3936
Hanno Becker1097b342018-08-15 14:09:41 +01003937static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003938{
Hanno Becker4a810fb2017-05-24 16:27:30 +01003939 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01003940 * Consume last content-layer message and potentially
3941 * update in_msglen which keeps track of the contents'
3942 * consumption state.
3943 *
3944 * (1) Handshake messages:
3945 * Remove last handshake message, move content
3946 * and adapt in_msglen.
3947 *
3948 * (2) Alert messages:
3949 * Consume whole record content, in_msglen = 0.
3950 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01003951 * (3) Change cipher spec:
3952 * Consume whole record content, in_msglen = 0.
3953 *
3954 * (4) Application data:
3955 * Don't do anything - the record layer provides
3956 * the application data as a stream transport
3957 * and consumes through mbedtls_ssl_read only.
3958 *
3959 */
3960
3961 /* Case (1): Handshake messages */
3962 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003963 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003964 /* Hard assertion to be sure that no application data
3965 * is in flight, as corrupting ssl->in_msglen during
3966 * ssl->in_offt != NULL is fatal. */
3967 if( ssl->in_offt != NULL )
3968 {
3969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3970 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3971 }
3972
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003973 /*
3974 * Get next Handshake message in the current record
3975 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003976
Hanno Becker4a810fb2017-05-24 16:27:30 +01003977 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01003978 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01003979 * current handshake content: If DTLS handshake
3980 * fragmentation is used, that's the fragment
3981 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01003982 * size here is faulty and should be changed at
3983 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003984 * (2) While it doesn't seem to cause problems, one
3985 * has to be very careful not to assume that in_hslen
3986 * is always <= in_msglen in a sensible communication.
3987 * Again, it's wrong for DTLS handshake fragmentation.
3988 * The following check is therefore mandatory, and
3989 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01003990 * Additionally, ssl->in_hslen might be arbitrarily out of
3991 * bounds after handling a DTLS message with an unexpected
3992 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01003993 */
3994 if( ssl->in_hslen < ssl->in_msglen )
3995 {
3996 ssl->in_msglen -= ssl->in_hslen;
3997 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
3998 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003999
Hanno Becker4a810fb2017-05-24 16:27:30 +01004000 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4001 ssl->in_msg, ssl->in_msglen );
4002 }
4003 else
4004 {
4005 ssl->in_msglen = 0;
4006 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004007
Hanno Becker4a810fb2017-05-24 16:27:30 +01004008 ssl->in_hslen = 0;
4009 }
4010 /* Case (4): Application data */
4011 else if( ssl->in_offt != NULL )
4012 {
4013 return( 0 );
4014 }
4015 /* Everything else (CCS & Alerts) */
4016 else
4017 {
4018 ssl->in_msglen = 0;
4019 }
4020
Hanno Becker1097b342018-08-15 14:09:41 +01004021 return( 0 );
4022}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004023
Hanno Beckere74d5562018-08-15 14:26:08 +01004024static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4025{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004026 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004027 return( 1 );
4028
4029 return( 0 );
4030}
4031
Hanno Becker5f066e72018-08-16 14:56:31 +01004032#if defined(MBEDTLS_SSL_PROTO_DTLS)
4033
4034static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4035{
4036 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4037 if( hs == NULL )
4038 return;
4039
Hanno Becker01315ea2018-08-21 17:22:17 +01004040 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004041 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004042 hs->buffering.total_bytes_buffered -=
4043 hs->buffering.future_record.len;
4044
4045 mbedtls_free( hs->buffering.future_record.data );
4046 hs->buffering.future_record.data = NULL;
4047 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004048}
4049
4050static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4051{
4052 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4053 unsigned char * rec;
4054 size_t rec_len;
4055 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004056#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4057 size_t in_buf_len = ssl->in_buf_len;
4058#else
4059 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4060#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004061 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4062 return( 0 );
4063
4064 if( hs == NULL )
4065 return( 0 );
4066
Hanno Becker5f066e72018-08-16 14:56:31 +01004067 rec = hs->buffering.future_record.data;
4068 rec_len = hs->buffering.future_record.len;
4069 rec_epoch = hs->buffering.future_record.epoch;
4070
4071 if( rec == NULL )
4072 return( 0 );
4073
Hanno Becker4cb782d2018-08-20 11:19:05 +01004074 /* Only consider loading future records if the
4075 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004076 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004077 return( 0 );
4078
Hanno Becker5f066e72018-08-16 14:56:31 +01004079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4080
4081 if( rec_epoch != ssl->in_epoch )
4082 {
4083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4084 goto exit;
4085 }
4086
4087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4088
4089 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004090 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004091 {
4092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4093 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4094 }
4095
4096 memcpy( ssl->in_hdr, rec, rec_len );
4097 ssl->in_left = rec_len;
4098 ssl->next_record_offset = 0;
4099
4100 ssl_free_buffered_record( ssl );
4101
4102exit:
4103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4104 return( 0 );
4105}
4106
Hanno Becker519f15d2019-07-11 12:43:20 +01004107static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4108 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004109{
4110 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004111
4112 /* Don't buffer future records outside handshakes. */
4113 if( hs == NULL )
4114 return( 0 );
4115
4116 /* Only buffer handshake records (we are only interested
4117 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004118 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004119 return( 0 );
4120
4121 /* Don't buffer more than one future epoch record. */
4122 if( hs->buffering.future_record.data != NULL )
4123 return( 0 );
4124
Hanno Becker01315ea2018-08-21 17:22:17 +01004125 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004126 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004127 hs->buffering.total_bytes_buffered ) )
4128 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4130 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4131 " (already %" MBEDTLS_PRINTF_SIZET
4132 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004133 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004134 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004135 return( 0 );
4136 }
4137
Hanno Becker5f066e72018-08-16 14:56:31 +01004138 /* Buffer record */
4139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004140 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004141 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004142
4143 /* ssl_parse_record_header() only considers records
4144 * of the next epoch as candidates for buffering. */
4145 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004146 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004147
4148 hs->buffering.future_record.data =
4149 mbedtls_calloc( 1, hs->buffering.future_record.len );
4150 if( hs->buffering.future_record.data == NULL )
4151 {
4152 /* If we run out of RAM trying to buffer a
4153 * record from the next epoch, just ignore. */
4154 return( 0 );
4155 }
4156
Hanno Becker519f15d2019-07-11 12:43:20 +01004157 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004158
Hanno Becker519f15d2019-07-11 12:43:20 +01004159 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004160 return( 0 );
4161}
4162
4163#endif /* MBEDTLS_SSL_PROTO_DTLS */
4164
Hanno Beckere74d5562018-08-15 14:26:08 +01004165static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004166{
Janos Follath865b3eb2019-12-16 11:46:15 +00004167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004168 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004169
Hanno Becker5f066e72018-08-16 14:56:31 +01004170#if defined(MBEDTLS_SSL_PROTO_DTLS)
4171 /* We might have buffered a future record; if so,
4172 * and if the epoch matches now, load it.
4173 * On success, this call will set ssl->in_left to
4174 * the length of the buffered record, so that
4175 * the calls to ssl_fetch_input() below will
4176 * essentially be no-ops. */
4177 ret = ssl_load_buffered_record( ssl );
4178 if( ret != 0 )
4179 return( ret );
4180#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004181
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004182 /* Ensure that we have enough space available for the default form
4183 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4184 * with no space for CIDs counted in). */
4185 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4186 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004187 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004188 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004189 return( ret );
4190 }
4191
Hanno Beckere5e7e782019-07-11 12:29:35 +01004192 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4193 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004194 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004195#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004196 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004197 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004198 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4199 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004200 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004201 if( ret != 0 )
4202 return( ret );
4203
4204 /* Fall through to handling of unexpected records */
4205 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4206 }
4207
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004208 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4209 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004210#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004211 /* Reset in pointers to default state for TLS/DTLS records,
4212 * assuming no CID and no offset between record content and
4213 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004214 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004215
Hanno Becker7ae20e02019-07-12 08:33:49 +01004216 /* Setup internal message pointers from record structure. */
4217 ssl->in_msgtype = rec.type;
4218#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4219 ssl->in_len = ssl->in_cid + rec.cid_len;
4220#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4221 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4222 ssl->in_msglen = rec.data_len;
4223
Hanno Becker2fddd372019-07-10 14:37:41 +01004224 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004225 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004226 if( ret != 0 )
4227 return( ret );
4228#endif
4229
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004230 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004231 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004232
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4234 "(header)" ) );
4235 }
4236 else
4237 {
4238 /* Skip invalid record and the rest of the datagram */
4239 ssl->next_record_offset = 0;
4240 ssl->in_left = 0;
4241
4242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4243 "(header)" ) );
4244 }
4245
4246 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004247 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004248 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004249 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004250#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004251 {
4252 return( ret );
4253 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004254 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004256#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004257 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004258 {
Hanno Beckera8814792019-07-10 15:01:45 +01004259 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004260 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004261 if( ssl->next_record_offset < ssl->in_left )
4262 {
4263 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4264 }
4265 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004266 else
4267#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004268 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004269 /*
4270 * Fetch record contents from underlying transport.
4271 */
Hanno Beckera3175662019-07-11 12:50:29 +01004272 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004273 if( ret != 0 )
4274 {
4275 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4276 return( ret );
4277 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004278
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004279 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004280 }
4281
4282 /*
4283 * Decrypt record contents.
4284 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004285
Hanno Beckerfdf66042019-07-11 13:07:45 +01004286 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004287 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004288#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004289 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004290 {
4291 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004292 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004293 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004294 /* Except when waiting for Finished as a bad mac here
4295 * probably means something went wrong in the handshake
4296 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4297 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4298 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4299 {
4300#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4301 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4302 {
4303 mbedtls_ssl_send_alert_message( ssl,
4304 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4305 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4306 }
4307#endif
4308 return( ret );
4309 }
4310
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004311 if( ssl->conf->badmac_limit != 0 &&
4312 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004314 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4315 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004316 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004317
Hanno Becker4a810fb2017-05-24 16:27:30 +01004318 /* As above, invalid records cause
4319 * dismissal of the whole datagram. */
4320
4321 ssl->next_record_offset = 0;
4322 ssl->in_left = 0;
4323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004325 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004326 }
4327
4328 return( ret );
4329 }
4330 else
4331#endif
4332 {
4333 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004334#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4335 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004337 mbedtls_ssl_send_alert_message( ssl,
4338 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4339 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004340 }
4341#endif
4342 return( ret );
4343 }
4344 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004345
Hanno Becker44d89b22019-07-12 09:40:44 +01004346
4347 /* Reset in pointers to default state for TLS/DTLS records,
4348 * assuming no CID and no offset between record content and
4349 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004350 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004351#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4352 ssl->in_len = ssl->in_cid + rec.cid_len;
4353#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004354 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004355
Hanno Becker8685c822019-07-12 09:37:30 +01004356 /* The record content type may change during decryption,
4357 * so re-read it. */
4358 ssl->in_msgtype = rec.type;
4359 /* Also update the input buffer, because unfortunately
4360 * the server-side ssl_parse_client_hello() reparses the
4361 * record header when receiving a ClientHello initiating
4362 * a renegotiation. */
4363 ssl->in_hdr[0] = rec.type;
4364 ssl->in_msg = rec.buf + rec.data_offset;
4365 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004366 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004367
Simon Butcher99000142016-10-13 17:21:01 +01004368 return( 0 );
4369}
4370
4371int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4372{
Janos Follath865b3eb2019-12-16 11:46:15 +00004373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004374
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004375 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004376 * Handle particular types of records
4377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004378 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004379 {
Simon Butcher99000142016-10-13 17:21:01 +01004380 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4381 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004382 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004383 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004384 }
4385
Hanno Beckere678eaa2018-08-21 14:57:46 +01004386 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004387 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004388 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004389 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004391 ssl->in_msglen ) );
4392 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004393 }
4394
Hanno Beckere678eaa2018-08-21 14:57:46 +01004395 if( ssl->in_msg[0] != 1 )
4396 {
4397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4398 ssl->in_msg[0] ) );
4399 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4400 }
4401
4402#if defined(MBEDTLS_SSL_PROTO_DTLS)
4403 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4404 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4405 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4406 {
4407 if( ssl->handshake == NULL )
4408 {
4409 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4410 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4411 }
4412
4413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4414 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4415 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004416#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004417
4418#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
4419 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4420 {
4421#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4422 MBEDTLS_SSL_DEBUG_MSG( 1,
4423 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4424 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4425#else
4426 MBEDTLS_SSL_DEBUG_MSG( 1,
4427 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4428 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4429#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4430 }
4431#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004432 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004434 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004435 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004436 if( ssl->in_msglen != 2 )
4437 {
4438 /* Note: Standard allows for more than one 2 byte alert
4439 to be packed in a single message, but Mbed TLS doesn't
4440 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004442 ssl->in_msglen ) );
4443 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4444 }
4445
Paul Elliott9f352112020-12-09 14:55:45 +00004446 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004447 ssl->in_msg[0], ssl->in_msg[1] ) );
4448
4449 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004450 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004453 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004455 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004456 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004457 }
4458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004459 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4460 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4463 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004464 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004465
4466#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4467 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4468 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4469 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004470 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004471 /* Will be handled when trying to parse ServerHello */
4472 return( 0 );
4473 }
4474#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004475 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004476 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004477 }
4478
Hanno Beckerc76c6192017-06-06 10:03:17 +01004479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004480 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004481 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004482 /* Drop unexpected ApplicationData records,
4483 * except at the beginning of renegotiations */
4484 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4485 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4486#if defined(MBEDTLS_SSL_RENEGOTIATION)
4487 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4488 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004489#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004490 )
4491 {
4492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4493 return( MBEDTLS_ERR_SSL_NON_FATAL );
4494 }
4495
4496 if( ssl->handshake != NULL &&
4497 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4498 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004499 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004500 }
4501 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004502#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004503
Paul Bakker5121ce52009-01-03 21:22:43 +00004504 return( 0 );
4505}
4506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004507int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004508{
irwir6c0da642019-09-26 21:07:41 +03004509 return( mbedtls_ssl_send_alert_message( ssl,
4510 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4511 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004512}
4513
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004514int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004515 unsigned char level,
4516 unsigned char message )
4517{
Janos Follath865b3eb2019-12-16 11:46:15 +00004518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004519
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004520 if( ssl == NULL || ssl->conf == NULL )
4521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004524 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004526 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004527 ssl->out_msglen = 2;
4528 ssl->out_msg[0] = level;
4529 ssl->out_msg[1] = message;
4530
Hanno Becker67bc7c32018-08-06 11:33:50 +01004531 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004534 return( ret );
4535 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004536 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004537
4538 return( 0 );
4539}
4540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004542{
Janos Follath865b3eb2019-12-16 11:46:15 +00004543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004547 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004548 ssl->out_msglen = 1;
4549 ssl->out_msg[0] = 1;
4550
Paul Bakker5121ce52009-01-03 21:22:43 +00004551 ssl->state++;
4552
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004553 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004554 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004555 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004556 return( ret );
4557 }
4558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004560
4561 return( 0 );
4562}
4563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004565{
Janos Follath865b3eb2019-12-16 11:46:15 +00004566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004569
Hanno Becker327c93b2018-08-15 13:56:18 +01004570 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004571 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004572 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004573 return( ret );
4574 }
4575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004576 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004579 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4580 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004582 }
4583
Hanno Beckere678eaa2018-08-21 14:57:46 +01004584 /* CCS records are only accepted if they have length 1 and content '1',
4585 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004586
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004587 /*
4588 * Switch to our negotiated transform and session parameters for inbound
4589 * data.
4590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004592 ssl->transform_in = ssl->transform_negotiate;
4593 ssl->session_in = ssl->session_negotiate;
4594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004596 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004597 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004599 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004600#endif
4601
4602 /* Increment epoch */
4603 if( ++ssl->in_epoch == 0 )
4604 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004606 /* This is highly unlikely to happen for legitimate reasons, so
4607 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004608 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004609 }
4610 }
4611 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004612#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004613 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004614
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004615 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004616
Paul Bakker5121ce52009-01-03 21:22:43 +00004617 ssl->state++;
4618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004620
4621 return( 0 );
4622}
4623
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004624/* Once ssl->out_hdr as the address of the beginning of the
4625 * next outgoing record is set, deduce the other pointers.
4626 *
4627 * Note: For TLS, we save the implicit record sequence number
4628 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4629 * and the caller has to make sure there's space for this.
4630 */
4631
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004632static size_t ssl_transform_get_explicit_iv_len(
4633 mbedtls_ssl_transform const *transform )
4634{
TRodziewiczef73f012021-05-13 14:53:36 +02004635 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004636 return( 0 );
4637
4638 return( transform->ivlen - transform->fixed_ivlen );
4639}
4640
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004641void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4642 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004643{
4644#if defined(MBEDTLS_SSL_PROTO_DTLS)
4645 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4646 {
4647 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004648#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004649 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004650 ssl->out_len = ssl->out_cid;
4651 if( transform != NULL )
4652 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004653#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004654 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004655#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004656 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004657 }
4658 else
4659#endif
4660 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004661 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004662#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004663 ssl->out_cid = ssl->out_len;
4664#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004665 ssl->out_iv = ssl->out_hdr + 5;
4666 }
4667
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004668 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004669 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004670 if( transform != NULL )
4671 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004672}
4673
4674/* Once ssl->in_hdr as the address of the beginning of the
4675 * next incoming record is set, deduce the other pointers.
4676 *
4677 * Note: For TLS, we save the implicit record sequence number
4678 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4679 * and the caller has to make sure there's space for this.
4680 */
4681
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004682void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004683{
Hanno Becker79594fd2019-05-08 09:38:41 +01004684 /* This function sets the pointers to match the case
4685 * of unprotected TLS/DTLS records, with both ssl->in_iv
4686 * and ssl->in_msg pointing to the beginning of the record
4687 * content.
4688 *
4689 * When decrypting a protected record, ssl->in_msg
4690 * will be shifted to point to the beginning of the
4691 * record plaintext.
4692 */
4693
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004694#if defined(MBEDTLS_SSL_PROTO_DTLS)
4695 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4696 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004697 /* This sets the header pointers to match records
4698 * without CID. When we receive a record containing
4699 * a CID, the fields are shifted accordingly in
4700 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004701 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004702#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004703 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004704 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004705#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004706 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004707#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004708 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004709 }
4710 else
4711#endif
4712 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004713 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004714 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004715#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004716 ssl->in_cid = ssl->in_len;
4717#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004718 ssl->in_iv = ssl->in_hdr + 5;
4719 }
4720
Hanno Becker79594fd2019-05-08 09:38:41 +01004721 /* This will be adjusted at record decryption time. */
4722 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004723}
4724
Paul Bakker5121ce52009-01-03 21:22:43 +00004725/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004726 * Setup an SSL context
4727 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004728
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004729void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004730{
4731 /* Set the incoming and outgoing record pointers. */
4732#if defined(MBEDTLS_SSL_PROTO_DTLS)
4733 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4734 {
4735 ssl->out_hdr = ssl->out_buf;
4736 ssl->in_hdr = ssl->in_buf;
4737 }
4738 else
4739#endif /* MBEDTLS_SSL_PROTO_DTLS */
4740 {
Hanno Becker12078f42021-03-02 15:28:41 +00004741 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004742 ssl->out_hdr = ssl->out_buf + 8;
4743 ssl->in_hdr = ssl->in_buf + 8;
4744 }
4745
4746 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004747 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4748 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004749}
4750
Paul Bakker5121ce52009-01-03 21:22:43 +00004751/*
4752 * SSL get accessors
4753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004755{
4756 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4757}
4758
Hanno Becker8b170a02017-10-10 11:51:19 +01004759int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4760{
4761 /*
4762 * Case A: We're currently holding back
4763 * a message for further processing.
4764 */
4765
4766 if( ssl->keep_current_message == 1 )
4767 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004769 return( 1 );
4770 }
4771
4772 /*
4773 * Case B: Further records are pending in the current datagram.
4774 */
4775
4776#if defined(MBEDTLS_SSL_PROTO_DTLS)
4777 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4778 ssl->in_left > ssl->next_record_offset )
4779 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004780 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004781 return( 1 );
4782 }
4783#endif /* MBEDTLS_SSL_PROTO_DTLS */
4784
4785 /*
4786 * Case C: A handshake message is being processed.
4787 */
4788
Hanno Becker8b170a02017-10-10 11:51:19 +01004789 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4790 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004791 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004792 return( 1 );
4793 }
4794
4795 /*
4796 * Case D: An application data message is being processed
4797 */
4798 if( ssl->in_offt != NULL )
4799 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004800 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004801 return( 1 );
4802 }
4803
4804 /*
4805 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004806 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004807 * we implement support for multiple alerts in single records.
4808 */
4809
4810 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4811 return( 0 );
4812}
4813
Paul Bakker43ca69c2011-01-15 17:35:19 +00004814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004815int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004816{
Hanno Becker3136ede2018-08-17 15:28:19 +01004817 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004818 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004819 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004820
Hanno Becker5903de42019-05-03 14:46:38 +01004821 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
4822
Hanno Becker78640902018-08-13 16:35:15 +01004823 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01004824 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01004825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004826 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004827 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004828 case MBEDTLS_MODE_GCM:
4829 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004830 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004832 transform_expansion = transform->minlen;
4833 break;
4834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01004836
4837 block_size = mbedtls_cipher_get_block_size(
4838 &transform->cipher_ctx_enc );
4839
Hanno Becker3136ede2018-08-17 15:28:19 +01004840 /* Expansion due to the addition of the MAC. */
4841 transform_expansion += transform->maclen;
4842
4843 /* Expansion due to the addition of CBC padding;
4844 * Theoretically up to 256 bytes, but we never use
4845 * more than the block size of the underlying cipher. */
4846 transform_expansion += block_size;
4847
TRodziewicz4ca18aa2021-05-20 14:46:20 +02004848 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01004849 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02004850#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004851 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02004852#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01004853
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004854 break;
4855
4856 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004859 }
4860
Hanno Beckera0e20d02019-05-15 14:03:01 +01004861#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01004862 if( transform->out_cid_len != 0 )
4863 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004864#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01004865
Hanno Becker5903de42019-05-03 14:46:38 +01004866 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004867}
4868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004870/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004871 * Check record counters and renegotiate if they're above the limit.
4872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004874{
Hanno Beckerdd772292020-02-05 10:38:31 +00004875 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00004876 int in_ctr_cmp;
4877 int out_ctr_cmp;
4878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004879 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
4880 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004881 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004882 {
4883 return( 0 );
4884 }
4885
Andres AG2196c7f2016-12-15 17:01:16 +00004886 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08004887 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08004888 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08004889 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
4890 &ssl->conf->renego_period[ep_len],
4891 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00004892
4893 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004894 {
4895 return( 0 );
4896 }
4897
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02004898 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004899 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01004900}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004901#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004902
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004903/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01004904 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004905 * may only be sent for the purpose of initiating renegotiations.
4906 *
4907 * This function is introduced as a separate helper since the handling
4908 * of post-handshake handshake messages changes significantly in TLS 1.3,
4909 * and having a helper function allows to distinguish between TLS <= 1.2 and
4910 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
4911 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00004912static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004913{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01004914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004915
4916 /*
4917 * - For client-side, expect SERVER_HELLO_REQUEST.
4918 * - For server-side, expect CLIENT_HELLO.
4919 * - Fail (TLS) or silently drop record (DTLS) in other cases.
4920 */
4921
4922#if defined(MBEDTLS_SSL_CLI_C)
4923 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
4924 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
4925 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
4926 {
4927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
4928
4929 /* With DTLS, drop the packet (probably from last handshake) */
4930#if defined(MBEDTLS_SSL_PROTO_DTLS)
4931 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4932 {
4933 return( 0 );
4934 }
4935#endif
4936 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4937 }
4938#endif /* MBEDTLS_SSL_CLI_C */
4939
4940#if defined(MBEDTLS_SSL_SRV_C)
4941 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4942 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
4943 {
4944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
4945
4946 /* With DTLS, drop the packet (probably from last handshake) */
4947#if defined(MBEDTLS_SSL_PROTO_DTLS)
4948 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4949 {
4950 return( 0 );
4951 }
4952#endif
4953 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
4954 }
4955#endif /* MBEDTLS_SSL_SRV_C */
4956
4957#if defined(MBEDTLS_SSL_RENEGOTIATION)
4958 /* Determine whether renegotiation attempt should be accepted */
4959 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
4960 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
4961 ssl->conf->allow_legacy_renegotiation ==
4962 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
4963 {
4964 /*
4965 * Accept renegotiation request
4966 */
4967
4968 /* DTLS clients need to know renego is server-initiated */
4969#if defined(MBEDTLS_SSL_PROTO_DTLS)
4970 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4971 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
4972 {
4973 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
4974 }
4975#endif
4976 ret = mbedtls_ssl_start_renegotiation( ssl );
4977 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
4978 ret != 0 )
4979 {
4980 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
4981 ret );
4982 return( ret );
4983 }
4984 }
4985 else
4986#endif /* MBEDTLS_SSL_RENEGOTIATION */
4987 {
4988 /*
4989 * Refuse renegotiation
4990 */
4991
4992 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
4993
TRodziewicz0f82ec62021-05-12 17:49:18 +02004994#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02004995 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
4996 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
4997 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00004998 {
TRodziewicz345165c2021-07-06 13:42:11 +02004999 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005000 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005001#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005002 }
5003
5004 return( 0 );
5005}
5006
Paul Bakker48916f92012-09-16 19:57:18 +00005007/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005008 * Receive application data decrypted from the SSL layer
5009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005011{
Janos Follath865b3eb2019-12-16 11:46:15 +00005012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005013 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005014
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005015 if( ssl == NULL || ssl->conf == NULL )
5016 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005020#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005021 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005023 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005024 return( ret );
5025
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005026 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005027 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005028 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005029 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005030 return( ret );
5031 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005032 }
5033#endif
5034
Hanno Becker4a810fb2017-05-24 16:27:30 +01005035 /*
5036 * Check if renegotiation is necessary and/or handshake is
5037 * in process. If yes, perform/continue, and fall through
5038 * if an unexpected packet is received while the client
5039 * is waiting for the ServerHello.
5040 *
5041 * (There is no equivalent to the last condition on
5042 * the server-side as it is not treated as within
5043 * a handshake while waiting for the ClientHello
5044 * after a renegotiation request.)
5045 */
5046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005048 ret = ssl_check_ctr_renegotiate( ssl );
5049 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5050 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005051 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005052 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005053 return( ret );
5054 }
5055#endif
5056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005057 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005060 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5061 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005063 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005064 return( ret );
5065 }
5066 }
5067
Hanno Beckere41158b2017-10-23 13:30:32 +01005068 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005069 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005070 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005071 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005072 if( ssl->f_get_timer != NULL &&
5073 ssl->f_get_timer( ssl->p_timer ) == -1 )
5074 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005075 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005076 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005077
Hanno Becker327c93b2018-08-15 13:56:18 +01005078 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005079 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005080 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5081 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005082
Hanno Becker4a810fb2017-05-24 16:27:30 +01005083 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5084 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005085 }
5086
5087 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005089 {
5090 /*
5091 * OpenSSL sends empty messages to randomize the IV
5092 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005093 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005094 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005096 return( 0 );
5097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005099 return( ret );
5100 }
5101 }
5102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005103 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005104 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005105 ret = ssl_handle_hs_message_post_handshake( ssl );
5106 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005107 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005108 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5109 ret );
5110 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005111 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005112
Hanno Beckerf26cc722021-04-21 07:30:13 +01005113 /* At this point, we don't know whether the renegotiation triggered
5114 * by the post-handshake message has been completed or not. The cases
5115 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005116 * 1) The renegotiation is complete. In this case, no new record
5117 * has been read yet.
5118 * 2) The renegotiation is incomplete because the client received
5119 * an application data record while awaiting the ServerHello.
5120 * 3) The renegotiation is incomplete because the client received
5121 * a non-handshake, non-application data message while awaiting
5122 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005123 *
5124 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005125 * - For 1), the next iteration will read a new record and check
5126 * if it's application data.
5127 * - For 2), the loop condition isn't satisfied as application data
5128 * is present, hence continue is the same as break
5129 * - For 3), the loop condition is satisfied and read_record
5130 * will re-deliver the message that was held back by the client
5131 * when expecting the ServerHello.
5132 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005133
Hanno Becker90333da2017-10-10 11:27:13 +01005134 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005135 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005136#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005138 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005139 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005140 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005141 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005144 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005145 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005146 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005147 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005148 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005149#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005151 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5152 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005153 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005155 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005156 }
5157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005158 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005159 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5161 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005162 }
5163
5164 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005165
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005166 /* We're going to return something now, cancel timer,
5167 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005168 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005169 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005170
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005171#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005172 /* If we requested renego but received AppData, resend HelloRequest.
5173 * Do it now, after setting in_offt, to avoid taking this branch
5174 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005175#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005176 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005177 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005178 {
Hanno Becker786300f2020-02-05 10:46:40 +00005179 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005180 {
Hanno Becker786300f2020-02-05 10:46:40 +00005181 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5182 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005183 return( ret );
5184 }
5185 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005186#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005187#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005188 }
5189
5190 n = ( len < ssl->in_msglen )
5191 ? len : ssl->in_msglen;
5192
5193 memcpy( buf, ssl->in_offt, n );
5194 ssl->in_msglen -= n;
5195
gabor-mezei-arma3214132020-07-15 10:55:00 +02005196 /* Zeroising the plaintext buffer to erase unused application data
5197 from the memory. */
5198 mbedtls_platform_zeroize( ssl->in_offt, n );
5199
Paul Bakker5121ce52009-01-03 21:22:43 +00005200 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005201 {
5202 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005203 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005204 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005205 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005206 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005207 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005208 /* more data available */
5209 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005210 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005213
Paul Bakker23986e52011-04-24 08:57:21 +00005214 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005215}
5216
5217/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005218 * Send application data to be encrypted by the SSL layer, taking care of max
5219 * fragment length and buffer size.
5220 *
5221 * According to RFC 5246 Section 6.2.1:
5222 *
5223 * Zero-length fragments of Application data MAY be sent as they are
5224 * potentially useful as a traffic analysis countermeasure.
5225 *
5226 * Therefore, it is possible that the input message length is 0 and the
5227 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005228 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005229static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005230 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005231{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005232 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5233 const size_t max_len = (size_t) ret;
5234
5235 if( ret < 0 )
5236 {
5237 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5238 return( ret );
5239 }
5240
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005241 if( len > max_len )
5242 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005244 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005245 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005247 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5248 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005249 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005250 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005251 }
5252 else
5253#endif
5254 len = max_len;
5255 }
Paul Bakker887bd502011-06-08 13:10:54 +00005256
Paul Bakker5121ce52009-01-03 21:22:43 +00005257 if( ssl->out_left != 0 )
5258 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005259 /*
5260 * The user has previously tried to send the data and
5261 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5262 * written. In this case, we expect the high-level write function
5263 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005268 return( ret );
5269 }
5270 }
Paul Bakker887bd502011-06-08 13:10:54 +00005271 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005272 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005273 /*
5274 * The user is trying to send a message the first time, so we need to
5275 * copy the data into the internal buffers and setup the data structure
5276 * to keep track of partial writes
5277 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005278 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005280 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005281
Hanno Becker67bc7c32018-08-06 11:33:50 +01005282 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005283 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005284 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005285 return( ret );
5286 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005287 }
5288
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005289 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005290}
5291
5292/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005293 * Write application data (public-facing wrapper)
5294 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005295int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005296{
Janos Follath865b3eb2019-12-16 11:46:15 +00005297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005298
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005300
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005301 if( ssl == NULL || ssl->conf == NULL )
5302 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5303
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005304#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005305 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5306 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005307 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005308 return( ret );
5309 }
5310#endif
5311
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005312 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005313 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005314 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005315 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005316 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005317 return( ret );
5318 }
5319 }
5320
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005321 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005322
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005323 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005324
5325 return( ret );
5326}
5327
5328/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005329 * Notify the peer that the connection is being closed
5330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005332{
Janos Follath865b3eb2019-12-16 11:46:15 +00005333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005334
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005335 if( ssl == NULL || ssl->conf == NULL )
5336 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005338 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005339
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005340 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005341 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5346 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5347 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005349 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005350 return( ret );
5351 }
5352 }
5353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005355
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005356 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005357}
5358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005359void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005360{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005361 if( transform == NULL )
5362 return;
5363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5365 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005366
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005367#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005368 mbedtls_md_free( &transform->md_ctx_enc );
5369 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005370#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005371
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005372 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005373}
5374
Jerry Yuc7875b52021-09-05 21:05:50 +08005375void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5376 mbedtls_ssl_transform *transform )
5377{
Jerry Yuc7875b52021-09-05 21:05:50 +08005378 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005379 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005380}
5381
5382void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5383 mbedtls_ssl_transform *transform )
5384{
5385 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005386 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005387}
5388
Hanno Becker0271f962018-08-16 13:23:47 +01005389#if defined(MBEDTLS_SSL_PROTO_DTLS)
5390
Hanno Becker533ab5f2020-02-05 10:49:13 +00005391void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005392{
5393 unsigned offset;
5394 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5395
5396 if( hs == NULL )
5397 return;
5398
Hanno Becker283f5ef2018-08-24 09:34:47 +01005399 ssl_free_buffered_record( ssl );
5400
Hanno Becker0271f962018-08-16 13:23:47 +01005401 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005402 ssl_buffering_free_slot( ssl, offset );
5403}
5404
5405static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5406 uint8_t slot )
5407{
5408 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5409 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005410
5411 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5412 return;
5413
Hanno Beckere605b192018-08-21 15:59:07 +01005414 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005415 {
Hanno Beckere605b192018-08-21 15:59:07 +01005416 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005417 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005418 mbedtls_free( hs_buf->data );
5419 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005420 }
5421}
5422
5423#endif /* MBEDTLS_SSL_PROTO_DTLS */
5424
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005425/*
5426 * Convert version numbers to/from wire format
5427 * and, for DTLS, to/from TLS equivalent.
5428 *
5429 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005430 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005431 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005434 unsigned char ver[2] )
5435{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436#if defined(MBEDTLS_SSL_PROTO_DTLS)
5437 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005438 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005440 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5441
5442 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5443 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5444 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005445 else
5446#else
5447 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005448#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005449 {
5450 ver[0] = (unsigned char) major;
5451 ver[1] = (unsigned char) minor;
5452 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005453}
5454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005456 const unsigned char ver[2] )
5457{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458#if defined(MBEDTLS_SSL_PROTO_DTLS)
5459 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005460 {
5461 *major = 255 - ver[0] + 2;
5462 *minor = 255 - ver[1] + 1;
5463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005465 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5466 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005467 else
5468#else
5469 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005470#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005471 {
5472 *major = ver[0];
5473 *minor = ver[1];
5474 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005475}
5476
Jerry Yue7047812021-09-13 19:26:39 +08005477/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005478 * Send pending fatal alert.
5479 * 0, No alert message.
5480 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5481 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005482 */
5483int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5484{
5485 int ret;
5486
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005487 /* No pending alert, return success*/
5488 if( ssl->send_alert == 0 )
5489 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005490
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005491 ret = mbedtls_ssl_send_alert_message( ssl,
5492 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5493 ssl->alert_type );
5494
Jerry Yu3bf1f972021-09-22 21:37:18 +08005495 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5496 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005497 */
5498 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5499 {
5500 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005501 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005502
5503 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005504 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005505
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005506 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005507}
5508
Jerry Yu394ece62021-09-14 22:17:21 +08005509/*
5510 * Set pending fatal alert flag.
5511 */
5512void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5513 unsigned char alert_type,
5514 int alert_reason )
5515{
5516 ssl->send_alert = 1;
5517 ssl->alert_type = alert_type;
5518 ssl->alert_reason = alert_reason;
5519}
5520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521#endif /* MBEDTLS_SSL_TLS_C */