blob: cf2eab56bfc20486f83b6be6449a87b95f34159d [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020043
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020044#include "ssl_invasive.h"
45
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Hanno Beckerccc13d02020-05-04 12:30:04 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
297 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100298
299static size_t ssl_compute_padding_length( size_t len,
300 size_t granularity )
301{
302 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
303}
304
Hanno Becker581bc1b2020-05-04 12:20:03 +0100305/* This functions transforms a (D)TLS plaintext fragment and a record content
306 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
307 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
308 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100309 *
310 * struct {
311 * opaque content[DTLSPlaintext.length];
312 * ContentType real_type;
313 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100314 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100315 *
316 * Input:
317 * - `content`: The beginning of the buffer holding the
318 * plaintext to be wrapped.
319 * - `*content_size`: The length of the plaintext in Bytes.
320 * - `max_len`: The number of Bytes available starting from
321 * `content`. This must be `>= *content_size`.
322 * - `rec_type`: The desired record content type.
323 *
324 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100325 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
326 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100327 *
328 * Returns:
329 * - `0` on success.
330 * - A negative error code if `max_len` didn't offer enough space
331 * for the expansion.
332 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100333static int ssl_build_inner_plaintext( unsigned char *content,
334 size_t *content_size,
335 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100336 uint8_t rec_type,
337 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338{
339 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340
341 /* Write real content type */
342 if( remaining == 0 )
343 return( -1 );
344 content[ len ] = rec_type;
345 len++;
346 remaining--;
347
348 if( remaining < pad )
349 return( -1 );
350 memset( content + len, 0, pad );
351 len += pad;
352 remaining -= pad;
353
354 *content_size = len;
355 return( 0 );
356}
357
Hanno Becker581bc1b2020-05-04 12:20:03 +0100358/* This function parses a (D)TLSInnerPlaintext structure.
359 * See ssl_build_inner_plaintext() for details. */
360static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 size_t *content_size,
362 uint8_t *rec_type )
363{
364 size_t remaining = *content_size;
365
366 /* Determine length of padding by skipping zeroes from the back. */
367 do
368 {
369 if( remaining == 0 )
370 return( -1 );
371 remaining--;
372 } while( content[ remaining ] == 0 );
373
374 *content_size = remaining;
375 *rec_type = content[ remaining ];
376
377 return( 0 );
378}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100379#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
380 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100381
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100382/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100383 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000384static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100385 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100386 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000387 unsigned minor_ver,
388 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000389{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100390 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100391 *
392 * additional_data = seq_num + TLSCompressed.type +
393 * TLSCompressed.version + TLSCompressed.length;
394 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100395 * For the CID extension, this is extended as follows
396 * (quoting draft-ietf-tls-dtls-connection-id-05,
397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100398 *
399 * additional_data = seq_num + DTLSPlaintext.type +
400 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100401 * cid +
402 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100403 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100404 *
405 * For TLS 1.3, the record sequence number is dropped from the AAD
406 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000407 * Moreover, the additional data involves the length of the TLS
408 * ciphertext, not the TLS plaintext as in earlier versions.
409 * Quoting RFC 8446 (TLS 1.3):
410 *
411 * additional_data = TLSCiphertext.opaque_type ||
412 * TLSCiphertext.legacy_record_version ||
413 * TLSCiphertext.length
414 *
415 * We pass the tag length to this function in order to compute the
416 * ciphertext length from the inner plaintext length rec->data_len via
417 *
418 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
419 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 */
421
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000423 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100424
425#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000426 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
427 {
428 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
429 * which differs from the length of the TLSInnerPlaintext
430 * by the length of the authentication tag. */
431 ad_len_field += taglen;
432 }
433 else
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
435 {
436 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000437 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000457 cur[0] = ( ad_len_field >> 8 ) & 0xFF;
458 cur[1] = ( ad_len_field >> 0 ) & 0xFF;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 }
461 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000464 cur[0] = ( ad_len_field >> 8 ) & 0xFF;
465 cur[1] = ( ad_len_field >> 0 ) & 0xFF;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468
469 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000470}
471
Hanno Becker67a37db2020-05-28 16:27:07 +0100472#if defined(MBEDTLS_GCM_C) || \
473 defined(MBEDTLS_CCM_C) || \
474 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100475static int ssl_transform_aead_dynamic_iv_is_explicit(
476 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100477{
Hanno Becker17263802020-05-28 07:05:48 +0100478 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100479}
480
Hanno Becker17263802020-05-28 07:05:48 +0100481/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
482 *
483 * Concretely, this occurs in two variants:
484 *
485 * a) Fixed and dynamic IV lengths add up to total IV length, giving
486 * IV = fixed_iv || dynamic_iv
487 *
Hanno Becker15952812020-06-04 13:31:46 +0100488 * This variant is used in TLS 1.2 when used with GCM or CCM.
489 *
Hanno Becker17263802020-05-28 07:05:48 +0100490 * b) Fixed IV lengths matches total IV length, giving
491 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100492 *
493 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
494 *
495 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100496 *
497 * This function has the precondition that
498 *
499 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
500 *
501 * which has to be ensured by the caller. If this precondition
502 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100503 */
504static void ssl_build_record_nonce( unsigned char *dst_iv,
505 size_t dst_iv_len,
506 unsigned char const *fixed_iv,
507 size_t fixed_iv_len,
508 unsigned char const *dynamic_iv,
509 size_t dynamic_iv_len )
510{
511 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
513 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100514 memset( dst_iv, 0, dst_iv_len );
515 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516
Hanno Becker17263802020-05-28 07:05:48 +0100517 dst_iv += dst_iv_len - dynamic_iv_len;
518 for( i = 0; i < dynamic_iv_len; i++ )
519 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100520}
Hanno Becker67a37db2020-05-28 16:27:07 +0100521#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100522
Hanno Beckera18d1322018-01-03 14:27:32 +0000523int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
524 mbedtls_ssl_transform *transform,
525 mbedtls_record *rec,
526 int (*f_rng)(void *, unsigned char *, size_t),
527 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000528{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100530 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000531 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100532 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100533 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000534 size_t post_avail;
535
536 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000537#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200538 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000539 ((void) ssl);
540#endif
541
542 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200544#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200545 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000546 ((void) f_rng);
547 ((void) p_rng);
548#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000551
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100553 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
555 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
556 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100557 if( rec == NULL
558 || rec->buf == NULL
559 || rec->buf_len < rec->data_offset
560 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100561#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100562 || rec->cid_len != 0
563#endif
564 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000565 {
566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100568 }
569
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000570 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100571 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000573 data, rec->data_len );
574
575 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
576
577 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
578 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
580 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000581 rec->data_len,
582 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
584 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100585
Hanno Becker92313402020-05-20 13:58:58 +0100586 /* The following two code paths implement the (D)TLSInnerPlaintext
587 * structure present in TLS 1.3 and DTLS 1.2 + CID.
588 *
589 * See ssl_build_inner_plaintext() for more information.
590 *
591 * Note that this changes `rec->data_len`, and hence
592 * `post_avail` needs to be recalculated afterwards.
593 *
594 * Note also that the two code paths cannot occur simultaneously
595 * since they apply to different versions of the protocol. There
596 * is hence no risk of double-addition of the inner plaintext.
597 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100598#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
599 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
600 {
Hanno Becker13996922020-05-28 16:15:19 +0100601 size_t padding =
602 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200603 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100604 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100605 &rec->data_len,
606 post_avail,
607 rec->type,
608 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
610 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
611 }
612
613 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
614 }
615#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
616
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100618 /*
619 * Add CID information
620 */
621 rec->cid_len = transform->out_cid_len;
622 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
623 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624
625 if( rec->cid_len != 0 )
626 {
Hanno Becker13996922020-05-28 16:15:19 +0100627 size_t padding =
628 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200629 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100632 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100634 * Note that this changes `rec->data_len`, and hence
635 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100637 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 &rec->data_len,
639 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100640 rec->type,
641 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 {
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
645
646 rec->type = MBEDTLS_SSL_MSG_CID;
647 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100648#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100649
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
651
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100653 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656 if( mode == MBEDTLS_MODE_STREAM ||
657 ( mode == MBEDTLS_MODE_CBC
658#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000659 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100660#endif
661 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000662 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000663 if( post_avail < transform->maclen )
664 {
665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
666 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
667 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200668#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200669 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Hanno Becker992b6872017-11-09 18:57:39 +0000670
TRodziewicz345165c2021-07-06 13:42:11 +0200671 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000672 transform->minor_ver,
673 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000674
TRodziewicz345165c2021-07-06 13:42:11 +0200675 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
676 add_data_len );
677 mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
678 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
679 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000680
TRodziewicz345165c2021-07-06 13:42:11 +0200681 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200682#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200683
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000684 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
685 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200686
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000687 rec->data_len += transform->maclen;
688 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100689 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200690 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000691#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000692
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200693 /*
694 * Encrypt
695 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000696#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200697 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000698 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000700 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000701 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000702 "including %d bytes of padding",
703 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000704
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000705 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
706 transform->iv_enc, transform->ivlen,
707 data, rec->data_len,
708 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200709 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200711 return( ret );
712 }
713
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000714 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200715 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
717 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200718 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000719 }
Paul Bakker68884e32013-01-07 18:20:04 +0100720 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000721#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000722
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200723#if defined(MBEDTLS_GCM_C) || \
724 defined(MBEDTLS_CCM_C) || \
725 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200727 mode == MBEDTLS_MODE_CCM ||
728 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000729 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200731 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100732 unsigned char *dynamic_iv;
733 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100734 int dynamic_iv_is_explicit =
735 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000736
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100737 /* Check that there's space for the authentication tag. */
738 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000739 {
740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
741 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
742 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000743
Paul Bakker68884e32013-01-07 18:20:04 +0100744 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100745 * Build nonce for AEAD encryption.
746 *
747 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
748 * part of the IV is prepended to the ciphertext and
749 * can be chosen freely - in particular, it need not
750 * agree with the record sequence number.
751 * However, since ChaChaPoly as well as all AEAD modes
752 * in TLS 1.3 use the record sequence number as the
753 * dynamic part of the nonce, we uniformly use the
754 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100755 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100756 dynamic_iv = rec->ctr;
757 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200758
Hanno Becker17263802020-05-28 07:05:48 +0100759 ssl_build_record_nonce( iv, sizeof( iv ),
760 transform->iv_enc,
761 transform->fixed_ivlen,
762 dynamic_iv,
763 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100764
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100765 /*
766 * Build additional data for AEAD encryption.
767 * This depends on the TLS version.
768 */
769 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000770 transform->minor_ver,
771 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100772
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100774 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200775 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100776 dynamic_iv,
777 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000778 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100779 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000780 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200781 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000782 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000783
Paul Bakker68884e32013-01-07 18:20:04 +0100784 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200785 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200786 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100788 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100790 add_data, add_data_len,
791 data, rec->data_len, /* src */
792 data, rec->buf_len - (data - rec->buf), /* dst */
793 &rec->data_len,
794 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200795 {
TRodziewicz18efb732021-04-29 23:12:19 +0200796 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200797 return( ret );
798 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000799 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100800 data + rec->data_len - transform->taglen,
801 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100802 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000803 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100804
805 /*
806 * Prefix record content with dynamic IV in case it is explicit.
807 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100808 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100809 {
810 if( rec->data_offset < dynamic_iv_len )
811 {
812 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
813 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
814 }
815
816 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
817 rec->data_offset -= dynamic_iv_len;
818 rec->data_len += dynamic_iv_len;
819 }
820
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100821 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000822 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000823 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100824#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200825#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000827 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000829 size_t padlen, i;
830 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000831
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 /* Currently we're always using minimal padding
833 * (up to 255 bytes would be allowed). */
834 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
835 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000836 padlen = 0;
837
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000838 /* Check there's enough space in the buffer for the padding. */
839 if( post_avail < padlen + 1 )
840 {
841 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
842 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
843 }
844
Paul Bakker5121ce52009-01-03 21:22:43 +0000845 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000847
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000848 rec->data_len += padlen + 1;
849 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000850
TRodziewicz0f82ec62021-05-12 17:49:18 +0200851#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000852 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200853 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000854 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000855 */
TRodziewicz345165c2021-07-06 13:42:11 +0200856 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000857 {
TRodziewicz345165c2021-07-06 13:42:11 +0200858 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
859 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000860 }
TRodziewicz345165c2021-07-06 13:42:11 +0200861
862 if( rec->data_offset < transform->ivlen )
863 {
864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
865 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
866 }
867
868 /*
869 * Generate IV
870 */
871 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
872 if( ret != 0 )
873 return( ret );
874
875 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200876#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000877
Paul Elliottd48d5c62021-01-07 14:47:05 +0000878 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
879 "including %" MBEDTLS_PRINTF_SIZET
880 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000881 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200882 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000883
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000884 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
885 transform->iv_enc,
886 transform->ivlen,
887 data, rec->data_len,
888 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200891 return( ret );
892 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200893
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000894 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200895 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
897 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200898 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200899
TRodziewicz0f82ec62021-05-12 17:49:18 +0200900 data -= transform->ivlen;
901 rec->data_offset -= transform->ivlen;
902 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100905 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100906 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000907 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
908
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100909 /*
910 * MAC(MAC_write_key, seq_num +
911 * TLSCipherText.type +
912 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100913 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +0200914 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100915 * ENC(content + padding + padding_length));
916 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000917
918 if( post_avail < transform->maclen)
919 {
920 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
921 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
922 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100923
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100924 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000925 rec, transform->minor_ver,
926 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000929 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100930 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100931
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100933 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000934 mbedtls_md_hmac_update( &transform->md_ctx_enc,
935 data, rec->data_len );
936 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
937 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100938
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 rec->data_len += transform->maclen;
942 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100943 auth_done++;
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
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200966#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200967/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200968 * Turn a bit into a mask:
969 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
970 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200971 *
972 * This function can be used to write constant-time code by replacing branches
973 * with bit operations using masks.
974 *
975 * This function is implemented without using comparison operators, as those
976 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200977 */
978static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
979{
980 /* MSVC has a warning about unary minus on unsigned integer types,
981 * but this is well-defined and precisely what we want to do here. */
982#if defined(_MSC_VER)
983#pragma warning( push )
984#pragma warning( disable : 4146 )
985#endif
986 return -bit;
987#if defined(_MSC_VER)
988#pragma warning( pop )
989#endif
990}
991
992/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200993 * Constant-flow mask generation for "less than" comparison:
994 * - if x < y, return all bits 1, that is (size_t) -1
995 * - otherwise, return all bits 0, that is 0
996 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200997 * This function can be used to write constant-time code by replacing branches
998 * with bit operations using masks.
999 *
1000 * This function is implemented without using comparison operators, as those
1001 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001002 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001003static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001004{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001005 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001006 const size_t sub = x - y;
1007
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001008 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001009 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1010
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001011 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001012 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001013
1014 return( mask );
1015}
1016
1017/*
1018 * Constant-flow mask generation for "greater or equal" comparison:
1019 * - if x >= y, return all bits 1, that is (size_t) -1
1020 * - otherwise, return all bits 0, that is 0
1021 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001022 * This function can be used to write constant-time code by replacing branches
1023 * with bit operations using masks.
1024 *
1025 * This function is implemented without using comparison operators, as those
1026 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001027 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001028static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001029{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001030 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001031}
1032
1033/*
1034 * Constant-flow boolean "equal" comparison:
1035 * return x == y
1036 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001037 * This function can be used to write constant-time code by replacing branches
1038 * with bit operations - it can be used in conjunction with
1039 * mbedtls_ssl_cf_mask_from_bit().
1040 *
1041 * This function is implemented without using comparison operators, as those
1042 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001043 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001044static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001045{
1046 /* diff = 0 if x == y, non-zero otherwise */
1047 const size_t diff = x ^ y;
1048
1049 /* MSVC has a warning about unary minus on unsigned integer types,
1050 * but this is well-defined and precisely what we want to do here. */
1051#if defined(_MSC_VER)
1052#pragma warning( push )
1053#pragma warning( disable : 4146 )
1054#endif
1055
1056 /* diff_msb's most significant bit is equal to x != y */
1057 const size_t diff_msb = ( diff | -diff );
1058
1059#if defined(_MSC_VER)
1060#pragma warning( pop )
1061#endif
1062
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001063 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001064 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1065
1066 return( 1 ^ diff1 );
1067}
1068
1069/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001070 * Constant-flow conditional memcpy:
1071 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1072 * - otherwise, a no-op,
1073 * but with execution flow independent of the values of c1 and c2.
1074 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001075 * This function is implemented without using comparison operators, as those
1076 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001077 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001078static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1079 const unsigned char *src,
1080 size_t len,
1081 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001082{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001083 /* mask = c1 == c2 ? 0xff : 0x00 */
1084 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001085 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001087 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001088 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001089 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001090}
1091
1092/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001093 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001094 *
1095 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1096 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001097 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001098MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001099 mbedtls_md_context_t *ctx,
1100 const unsigned char *add_data, size_t add_data_len,
1101 const unsigned char *data, size_t data_len_secret,
1102 size_t min_data_len, size_t max_data_len,
1103 unsigned char *output )
1104{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001105 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001106 * This function breaks the HMAC abstraction and uses the md_clone()
1107 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001108 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001109 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001110 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001111 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001112 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001113 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1114 * minlen, then cloning the context, and for each byte up to maxlen
1115 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001118 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001119 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
TRodziewicz2abf03c2021-06-25 14:40:09 +02001120 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001121 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001123 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001124 const unsigned char * const okey = ikey + block_size;
1125 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001126
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001127 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1128 mbedtls_md_context_t aux;
1129 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001130 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001131
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001132 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001133
1134#define MD_CHK( func_call ) \
1135 do { \
1136 ret = (func_call); \
1137 if( ret != 0 ) \
1138 goto cleanup; \
1139 } while( 0 )
1140
1141 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001142
1143 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1144 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001145 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1146 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001147
1148 /* For each possible length, compute the hash up to that point */
1149 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001150 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001151 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1152 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001153 /* Keep only the correct inner_hash in the output buffer */
1154 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1155 offset, data_len_secret );
1156
1157 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001158 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001159 }
1160
Manuel Pégourié-Gonnard5ca21db2021-05-17 12:28:08 +02001161 /* The context needs to finish() before it starts() again */
1162 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1163
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001164 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001165 MD_CHK( mbedtls_md_starts( ctx ) );
1166 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1167 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1168 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001169
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001170 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001171 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001172
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001173#undef MD_CHK
1174
1175cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001176 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001177 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001178}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001179
1180/*
1181 * Constant-flow memcpy from variable position in buffer.
1182 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001183 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001184 */
1185MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1186 unsigned char *dst,
1187 const unsigned char *src_base,
1188 size_t offset_secret,
1189 size_t offset_min, size_t offset_max,
1190 size_t len )
1191{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001192 size_t offset;
1193
1194 for( offset = offset_min; offset <= offset_max; offset++ )
1195 {
1196 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1197 offset, offset_secret );
1198 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001199}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001200#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001201
Hanno Becker605949f2019-07-12 08:23:59 +01001202int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001203 mbedtls_ssl_transform *transform,
1204 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001205{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001208 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001209#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001210 size_t padlen = 0, correct = 1;
1211#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001212 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001213 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001214 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001215
Hanno Beckera18d1322018-01-03 14:27:32 +00001216#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001217 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001218 ((void) ssl);
1219#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001222 if( rec == NULL ||
1223 rec->buf == NULL ||
1224 rec->buf_len < rec->data_offset ||
1225 rec->buf_len - rec->data_offset < rec->data_len )
1226 {
1227 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001229 }
1230
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001231 data = rec->buf + rec->data_offset;
1232 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001233
Hanno Beckera0e20d02019-05-15 14:03:01 +01001234#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001235 /*
1236 * Match record's CID with incoming CID.
1237 */
Hanno Becker938489a2019-05-08 13:02:22 +01001238 if( rec->cid_len != transform->in_cid_len ||
1239 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1240 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001241 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001242 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001243#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001244
Hanno Beckerd086bf02021-03-22 13:01:27 +00001245#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001247 {
1248 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001249 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1250 transform->iv_dec,
1251 transform->ivlen,
1252 data, rec->data_len,
1253 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001254 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001256 return( ret );
1257 }
1258
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001259 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001260 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1262 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001263 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001264 }
Paul Bakker68884e32013-01-07 18:20:04 +01001265 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001266#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001267#if defined(MBEDTLS_GCM_C) || \
1268 defined(MBEDTLS_CCM_C) || \
1269 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001271 mode == MBEDTLS_MODE_CCM ||
1272 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001273 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001274 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001275 unsigned char *dynamic_iv;
1276 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001277
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001278 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001279 * Extract dynamic part of nonce for AEAD decryption.
1280 *
1281 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1282 * part of the IV is prepended to the ciphertext and
1283 * can be chosen freely - in particular, it need not
1284 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001285 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001286 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001287 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001288 {
1289 if( rec->data_len < dynamic_iv_len )
1290 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001291 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1292 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001293 rec->data_len,
1294 dynamic_iv_len ) );
1295 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1296 }
1297 dynamic_iv = data;
1298
1299 data += dynamic_iv_len;
1300 rec->data_offset += dynamic_iv_len;
1301 rec->data_len -= dynamic_iv_len;
1302 }
Hanno Becker17263802020-05-28 07:05:48 +01001303 else
1304 {
1305 dynamic_iv = rec->ctr;
1306 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001307
1308 /* Check that there's space for the authentication tag. */
1309 if( rec->data_len < transform->taglen )
1310 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001311 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1312 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001313 rec->data_len,
1314 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001316 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001317 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001318
Hanno Beckerdf8be222020-05-21 15:30:57 +01001319 /*
1320 * Prepare nonce from dynamic and static parts.
1321 */
Hanno Becker17263802020-05-28 07:05:48 +01001322 ssl_build_record_nonce( iv, sizeof( iv ),
1323 transform->iv_dec,
1324 transform->fixed_ivlen,
1325 dynamic_iv,
1326 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001327
Hanno Beckerdf8be222020-05-21 15:30:57 +01001328 /*
1329 * Build additional data for AEAD encryption.
1330 * This depends on the TLS version.
1331 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001332 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001333 transform->minor_ver,
1334 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001336 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001337
Hanno Beckerd96a6522019-07-10 13:55:25 +01001338 /* Because of the check above, we know that there are
1339 * explicit_iv_len Bytes preceeding data, and taglen
1340 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001341 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001342 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001344 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001345 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001346 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001347
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001348 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001349 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001350 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001351 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001352 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001353 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001354 data, rec->data_len + transform->taglen, /* src */
1355 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001356 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001357 {
TRodziewicz18efb732021-04-29 23:12:19 +02001358 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1361 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001362
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001363 return( ret );
1364 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001365 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001366
Hanno Beckerd96a6522019-07-10 13:55:25 +01001367 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001368 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001369 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1371 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001372 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001373 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001374 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001376#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001378 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001379 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001380
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 /*
Paul Bakker45829992013-01-03 14:52:21 +01001382 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001383 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001384#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001385 /* The ciphertext is prefixed with the CBC IV. */
1386 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001387#endif
Paul Bakker45829992013-01-03 14:52:21 +01001388
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 /* Size considerations:
1390 *
1391 * - The CBC cipher text must not be empty and hence
1392 * at least of size transform->ivlen.
1393 *
1394 * Together with the potential IV-prefix, this explains
1395 * the first of the two checks below.
1396 *
1397 * - The record must contain a MAC, either in plain or
1398 * encrypted, depending on whether Encrypt-then-MAC
1399 * is used or not.
1400 * - If it is, the message contains the IV-prefix,
1401 * the CBC ciphertext, and the MAC.
1402 * - If it is not, the padded plaintext, and hence
1403 * the CBC ciphertext, has at least length maclen + 1
1404 * because there is at least the padding length byte.
1405 *
1406 * As the CBC ciphertext is not empty, both cases give the
1407 * lower bound minlen + maclen + 1 on the record size, which
1408 * we test for in the second check below.
1409 */
1410 if( rec->data_len < minlen + transform->ivlen ||
1411 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001412 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1414 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1415 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416 "+ 1 ) ( + expl IV )", rec->data_len,
1417 transform->ivlen,
1418 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001420 }
1421
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001422 /*
1423 * Authenticate before decrypt if enabled
1424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427 {
Hanno Becker992b6872017-11-09 18:57:39 +00001428 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001431
Hanno Beckerd96a6522019-07-10 13:55:25 +01001432 /* Update data_len in tandem with add_data.
1433 *
1434 * The subtraction is safe because of the previous check
1435 * data_len >= minlen + maclen + 1.
1436 *
1437 * Afterwards, we know that data + data_len is followed by at
1438 * least maclen Bytes, which justifies the call to
1439 * mbedtls_ssl_safer_memcmp() below.
1440 *
1441 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001443 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001444 transform->minor_ver,
1445 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001446
Hanno Beckerd96a6522019-07-10 13:55:25 +01001447 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001448 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1449 add_data_len );
1450 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1451 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001452 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1453 data, rec->data_len );
1454 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1455 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001456
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001457 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1458 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001459 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001460 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001461
Hanno Beckerd96a6522019-07-10 13:55:25 +01001462 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001463 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1464 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001467 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001468 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001469 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001470 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001472
1473 /*
1474 * Check length sanity
1475 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001476
1477 /* We know from above that data_len > minlen >= 0,
1478 * so the following check in particular implies that
1479 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001480 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001481 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1483 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001486 }
1487
TRodziewicz0f82ec62021-05-12 17:49:18 +02001488#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001489 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001490 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001491 */
TRodziewicz345165c2021-07-06 13:42:11 +02001492 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1493 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001494
TRodziewicz345165c2021-07-06 13:42:11 +02001495 data += transform->ivlen;
1496 rec->data_offset += transform->ivlen;
1497 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001498#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001499
Hanno Beckerd96a6522019-07-10 13:55:25 +01001500 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1501
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1503 transform->iv_dec, transform->ivlen,
1504 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001507 return( ret );
1508 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001509
Hanno Beckerd96a6522019-07-10 13:55:25 +01001510 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001511 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001515 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001516
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517 /* Safe since data_len >= minlen + maclen + 1, so after having
1518 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1520 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001522
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001523 if( auth_done == 1 )
1524 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001525 const size_t mask = mbedtls_ssl_cf_mask_ge(
1526 rec->data_len,
1527 padlen + 1 );
1528 correct &= mask;
1529 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001530 }
1531 else
Paul Bakker45829992013-01-03 14:52:21 +01001532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 if( rec->data_len < transform->maclen + padlen + 1 )
1535 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001536 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1537 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1538 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001539 rec->data_len,
1540 transform->maclen,
1541 padlen + 1 ) );
1542 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001543#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001544
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001545 const size_t mask = mbedtls_ssl_cf_mask_ge(
1546 rec->data_len,
1547 transform->maclen + padlen + 1 );
1548 correct &= mask;
1549 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001550 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001551
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001552 padlen++;
1553
1554 /* Regardless of the validity of the padding,
1555 * we have data_len >= padlen here. */
1556
TRodziewicz0f82ec62021-05-12 17:49:18 +02001557#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001558 /* The padding check involves a series of up to 256
1559 * consecutive memory reads at the end of the record
1560 * plaintext buffer. In order to hide the length and
1561 * validity of the padding, always perform exactly
1562 * `min(256,plaintext_len)` reads (but take into account
1563 * only the last `padlen` bytes for the padding check). */
1564 size_t pad_count = 0;
1565 volatile unsigned char* const check = data;
1566
1567 /* Index of first padding byte; it has been ensured above
1568 * that the subtraction is safe. */
1569 size_t const padding_idx = rec->data_len - padlen;
1570 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1571 size_t const start_idx = rec->data_len - num_checks;
1572 size_t idx;
1573
1574 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001575 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001576 /* pad_count += (idx >= padding_idx) &&
1577 * (check[idx] == padlen - 1);
1578 */
1579 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1580 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1581 padlen - 1 );
1582 pad_count += mask & equal;
1583 }
1584 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001587 if( padlen > 0 && correct == 0 )
1588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001589#endif
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001590 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
1591
TRodziewicz0f82ec62021-05-12 17:49:18 +02001592#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001593
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001594 /* If the padding was found to be invalid, padlen == 0
1595 * and the subtraction is safe. If the padding was found valid,
1596 * padlen hasn't been changed and the previous assertion
1597 * data_len >= padlen still holds. */
1598 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001599 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001600 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001601#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001602 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1604 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001605 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001606
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001607#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001609 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001610#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001611
1612 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001613 * Authenticate if not done yet.
1614 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001615 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001616#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001617 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001618 {
Hanno Becker992b6872017-11-09 18:57:39 +00001619 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001620 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001621
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001622 /* If the initial value of padlen was such that
1623 * data_len < maclen + padlen + 1, then padlen
1624 * got reset to 1, and the initial check
1625 * data_len >= minlen + maclen + 1
1626 * guarantees that at this point we still
1627 * have at least data_len >= maclen.
1628 *
1629 * If the initial value of padlen was such that
1630 * data_len >= maclen + padlen + 1, then we have
1631 * subtracted either padlen + 1 (if the padding was correct)
1632 * or 0 (if the padding was incorrect) since then,
1633 * hence data_len >= maclen in any case.
1634 */
1635 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001636 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001637 transform->minor_ver,
1638 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001639
TRodziewicz0f82ec62021-05-12 17:49:18 +02001640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001641 /*
1642 * The next two sizes are the minimum and maximum values of
1643 * data_len over all padlen values.
1644 *
1645 * They're independent of padlen, since we previously did
1646 * data_len -= padlen.
1647 *
1648 * Note that max_len + maclen is never more than the buffer
1649 * length, as we previously did in_msglen -= maclen too.
1650 */
1651 const size_t max_len = rec->data_len + padlen;
1652 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1653
1654 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1655 add_data, add_data_len,
1656 data, rec->data_len, min_len, max_len,
1657 mac_expect );
1658 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001659 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001660 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1661 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001662 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001663
1664 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1665 rec->data_len,
1666 min_len, max_len,
1667 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001668#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001669
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001670#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001671 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001672 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001673#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001675 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001676 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001677 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#if defined(MBEDTLS_SSL_DEBUG_ALL)
1679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001681 correct = 0;
1682 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001683 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001684 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001685
1686 /*
1687 * Finally check the correct flag
1688 */
1689 if( correct == 0 )
1690 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001691#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001692
1693 /* Make extra sure authentication was performed, exactly once */
1694 if( auth_done != 1 )
1695 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1697 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001698 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
Hanno Beckerccc13d02020-05-04 12:30:04 +01001700#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1701 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1702 {
1703 /* Remove inner padding and infer true content type. */
1704 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1705 &rec->type );
1706
1707 if( ret != 0 )
1708 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1709 }
1710#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1711
Hanno Beckera0e20d02019-05-15 14:03:01 +01001712#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001713 if( rec->cid_len != 0 )
1714 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001715 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1716 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001717 if( ret != 0 )
1718 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1719 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001720#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001723
1724 return( 0 );
1725}
1726
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001727#undef MAC_NONE
1728#undef MAC_PLAINTEXT
1729#undef MAC_CIPHERTEXT
1730
Paul Bakker5121ce52009-01-03 21:22:43 +00001731/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001732 * Fill the input message buffer by appending data to it.
1733 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001734 *
1735 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1736 * available (from this read and/or a previous one). Otherwise, an error code
1737 * is returned (possibly EOF or WANT_READ).
1738 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001739 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1740 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1741 * since we always read a whole datagram at once.
1742 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001743 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001744 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001747{
Janos Follath865b3eb2019-12-16 11:46:15 +00001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001749 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001750#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1751 size_t in_buf_len = ssl->in_buf_len;
1752#else
1753 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1754#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001757
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001758 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001761 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001763 }
1764
Darryl Greenb33cc762019-11-28 14:29:44 +00001765 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001766 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1768 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001769 }
1770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001772 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001773 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001774 uint32_t timeout;
1775
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001776 /*
1777 * The point is, we need to always read a full datagram at once, so we
1778 * sometimes read more then requested, and handle the additional data.
1779 * It could be the rest of the current record (while fetching the
1780 * header) and/or some other records in the same datagram.
1781 */
1782
1783 /*
1784 * Move to the next record in the already read datagram if applicable
1785 */
1786 if( ssl->next_record_offset != 0 )
1787 {
1788 if( ssl->in_left < ssl->next_record_offset )
1789 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1791 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001792 }
1793
1794 ssl->in_left -= ssl->next_record_offset;
1795
1796 if( ssl->in_left != 0 )
1797 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1799 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001800 ssl->next_record_offset ) );
1801 memmove( ssl->in_hdr,
1802 ssl->in_hdr + ssl->next_record_offset,
1803 ssl->in_left );
1804 }
1805
1806 ssl->next_record_offset = 0;
1807 }
1808
Paul Elliottd48d5c62021-01-07 14:47:05 +00001809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1810 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001811 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001812
1813 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001814 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001815 */
1816 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001817 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001819 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001820 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001821
1822 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001823 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001824 * are not at the beginning of a new record, the caller did something
1825 * wrong.
1826 */
1827 if( ssl->in_left != 0 )
1828 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1830 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001831 }
1832
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001833 /*
1834 * Don't even try to read if time's out already.
1835 * This avoids by-passing the timer when repeatedly receiving messages
1836 * that will end up being dropped.
1837 */
Hanno Becker7876d122020-02-05 10:39:31 +00001838 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001839 {
1840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001841 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001842 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001843 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001844 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001845 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001848 timeout = ssl->handshake->retransmit_timeout;
1849 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001850 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001851
Paul Elliott9f352112020-12-09 14:55:45 +00001852 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001853
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001854 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001855 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1856 timeout );
1857 else
1858 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001861
1862 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001864 }
1865
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001866 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001867 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001869 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001872 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001873 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001876 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001877 }
1878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001882 return( ret );
1883 }
1884
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001885 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001886 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001888 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001890 {
Hanno Becker786300f2020-02-05 10:46:40 +00001891 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001892 {
Hanno Becker786300f2020-02-05 10:46:40 +00001893 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1894 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001895 return( ret );
1896 }
1897
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001898 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001899 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001901 }
1902
Paul Bakker5121ce52009-01-03 21:22:43 +00001903 if( ret < 0 )
1904 return( ret );
1905
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001906 ssl->in_left = ret;
1907 }
1908 else
1909#endif
1910 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001911 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1912 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001913 ssl->in_left, nb_want ) );
1914
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001915 while( ssl->in_left < nb_want )
1916 {
1917 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001918
Hanno Becker7876d122020-02-05 10:39:31 +00001919 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001920 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1921 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001922 {
1923 if( ssl->f_recv_timeout != NULL )
1924 {
1925 ret = ssl->f_recv_timeout( ssl->p_bio,
1926 ssl->in_hdr + ssl->in_left, len,
1927 ssl->conf->read_timeout );
1928 }
1929 else
1930 {
1931 ret = ssl->f_recv( ssl->p_bio,
1932 ssl->in_hdr + ssl->in_left, len );
1933 }
1934 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001935
Paul Elliottd48d5c62021-01-07 14:47:05 +00001936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1937 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001938 ssl->in_left, nb_want ) );
1939 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001940
1941 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001943
1944 if( ret < 0 )
1945 return( ret );
1946
makise-homuraaf9513b2020-08-24 18:26:27 +03001947 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001948 {
Darryl Green11999bb2018-03-13 15:22:58 +00001949 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001950 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001951 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001952 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1953 }
1954
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001955 ssl->in_left += ret;
1956 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001957 }
1958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001960
1961 return( 0 );
1962}
1963
1964/*
1965 * Flush any data not yet written
1966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001968{
Janos Follath865b3eb2019-12-16 11:46:15 +00001969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001970 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001973
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001974 if( ssl->f_send == NULL )
1975 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001976 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001977 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001979 }
1980
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001981 /* Avoid incrementing counter if data is flushed */
1982 if( ssl->out_left == 0 )
1983 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001985 return( 0 );
1986 }
1987
Paul Bakker5121ce52009-01-03 21:22:43 +00001988 while( ssl->out_left > 0 )
1989 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001990 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1991 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001992 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001993
Hanno Becker2b1e3542018-08-06 11:19:13 +01001994 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001995 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001998
1999 if( ret <= 0 )
2000 return( ret );
2001
makise-homuraaf9513b2020-08-24 18:26:27 +03002002 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002003 {
Darryl Green11999bb2018-03-13 15:22:58 +00002004 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002005 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002006 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002007 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2008 }
2009
Paul Bakker5121ce52009-01-03 21:22:43 +00002010 ssl->out_left -= ret;
2011 }
2012
Hanno Becker2b1e3542018-08-06 11:19:13 +01002013#if defined(MBEDTLS_SSL_PROTO_DTLS)
2014 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002015 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002016 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002017 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002018 else
2019#endif
2020 {
2021 ssl->out_hdr = ssl->out_buf + 8;
2022 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002023 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002026
2027 return( 0 );
2028}
2029
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002030/*
2031 * Functions to handle the DTLS retransmission state machine
2032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002034/*
2035 * Append current handshake message to current outgoing flight
2036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002038{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002040 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2041 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2042 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002043
2044 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002045 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002046 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002047 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002049 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002050 }
2051
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002052 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002053 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2055 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002057 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002058 }
2059
2060 /* Copy current handshake message with headers */
2061 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2062 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002063 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002064 msg->next = NULL;
2065
2066 /* Append to the current flight */
2067 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002068 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002069 else
2070 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002072 while( cur->next != NULL )
2073 cur = cur->next;
2074 cur->next = msg;
2075 }
2076
Hanno Becker3b235902018-08-06 09:54:53 +01002077 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078 return( 0 );
2079}
2080
2081/*
2082 * Free the current flight of handshake messages
2083 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002084void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002085{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 mbedtls_ssl_flight_item *cur = flight;
2087 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002088
2089 while( cur != NULL )
2090 {
2091 next = cur->next;
2092
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 mbedtls_free( cur->p );
2094 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002095
2096 cur = next;
2097 }
2098}
2099
2100/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002101 * Swap transform_out and out_ctr with the alternative ones
2102 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002103static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002104{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002106 unsigned char tmp_out_ctr[8];
2107
2108 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002111 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002112 }
2113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002116 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002117 tmp_transform = ssl->transform_out;
2118 ssl->transform_out = ssl->handshake->alt_transform_out;
2119 ssl->handshake->alt_transform_out = tmp_transform;
2120
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002121 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002122 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2123 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002124 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002125
2126 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002127 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002128
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002129 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002130}
2131
2132/*
2133 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002134 */
2135int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2136{
2137 int ret = 0;
2138
2139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2140
2141 ret = mbedtls_ssl_flight_transmit( ssl );
2142
2143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2144
2145 return( ret );
2146}
2147
2148/*
2149 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150 *
2151 * Need to remember the current message in case flush_output returns
2152 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002153 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002155int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156{
Janos Follath865b3eb2019-12-16 11:46:15 +00002157 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002163
2164 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002165 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002166 ret = ssl_swap_epochs( ssl );
2167 if( ret != 0 )
2168 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002172
2173 while( ssl->handshake->cur_msg != NULL )
2174 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002175 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002176 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002177
Hanno Beckere1dcb032018-08-17 16:47:58 +01002178 int const is_finished =
2179 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2180 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2181
Hanno Becker04da1892018-08-14 13:22:10 +01002182 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2183 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2184
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002185 /* Swap epochs before sending Finished: we can't do it after
2186 * sending ChangeCipherSpec, in case write returns WANT_READ.
2187 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002188 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002189 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002190 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002191 ret = ssl_swap_epochs( ssl );
2192 if( ret != 0 )
2193 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002194 }
2195
Hanno Becker67bc7c32018-08-06 11:33:50 +01002196 ret = ssl_get_remaining_payload_in_datagram( ssl );
2197 if( ret < 0 )
2198 return( ret );
2199 max_frag_len = (size_t) ret;
2200
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002201 /* CCS is copied as is, while HS messages may need fragmentation */
2202 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2203 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002204 if( max_frag_len == 0 )
2205 {
2206 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2207 return( ret );
2208
2209 continue;
2210 }
2211
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002212 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002213 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002214 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002215
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002216 /* Update position inside current message */
2217 ssl->handshake->cur_msg_p += cur->len;
2218 }
2219 else
2220 {
2221 const unsigned char * const p = ssl->handshake->cur_msg_p;
2222 const size_t hs_len = cur->len - 12;
2223 const size_t frag_off = p - ( cur->p + 12 );
2224 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002225 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002226
Hanno Beckere1dcb032018-08-17 16:47:58 +01002227 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002228 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002229 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002230 {
2231 ret = ssl_swap_epochs( ssl );
2232 if( ret != 0 )
2233 return( ret );
2234 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235
Hanno Becker67bc7c32018-08-06 11:33:50 +01002236 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2237 return( ret );
2238
2239 continue;
2240 }
2241 max_hs_frag_len = max_frag_len - 12;
2242
2243 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2244 max_hs_frag_len : rem_len;
2245
2246 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002247 {
2248 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002249 (unsigned) cur_hs_frag_len,
2250 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002251 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002252
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002253 /* Messages are stored with handshake headers as if not fragmented,
2254 * copy beginning of headers then fill fragmentation fields.
2255 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2256 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002258 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2259 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2260 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2261
Hanno Becker67bc7c32018-08-06 11:33:50 +01002262 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2263 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2264 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002265
2266 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2267
Hanno Becker3f7b9732018-08-28 09:53:25 +01002268 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002269 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2270 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002271 ssl->out_msgtype = cur->type;
2272
2273 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002274 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002275 }
2276
2277 /* If done with the current message move to the next one if any */
2278 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2279 {
2280 if( cur->next != NULL )
2281 {
2282 ssl->handshake->cur_msg = cur->next;
2283 ssl->handshake->cur_msg_p = cur->next->p + 12;
2284 }
2285 else
2286 {
2287 ssl->handshake->cur_msg = NULL;
2288 ssl->handshake->cur_msg_p = NULL;
2289 }
2290 }
2291
2292 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002293 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002294 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296 return( ret );
2297 }
2298 }
2299
Hanno Becker67bc7c32018-08-06 11:33:50 +01002300 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2301 return( ret );
2302
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002303 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2305 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002306 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002309 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002310 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002311
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
2314 return( 0 );
2315}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002316
2317/*
2318 * To be called when the last message of an incoming flight is received.
2319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002321{
2322 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002323 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324 ssl->handshake->flight = NULL;
2325 ssl->handshake->cur_msg = NULL;
2326
2327 /* The next incoming flight will start with this msg_seq */
2328 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2329
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002330 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002331 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002332
Hanno Becker0271f962018-08-16 13:23:47 +01002333 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002334 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002335
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002336 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002337 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2340 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002343 }
2344 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002346}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002347
2348/*
2349 * To be called when the last message of an outgoing flight is send.
2350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002352{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002353 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002354 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2357 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002358 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002360 }
2361 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002363}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002365
Paul Bakker5121ce52009-01-03 21:22:43 +00002366/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002367 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002368 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369
2370/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002371 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002372 *
2373 * - fill in handshake headers
2374 * - update handshake checksum
2375 * - DTLS: save message for resending
2376 * - then pass to the record layer
2377 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002378 * DTLS: except for HelloRequest, messages are only queued, and will only be
2379 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002380 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002381 * Inputs:
2382 * - ssl->out_msglen: 4 + actual handshake message len
2383 * (4 is the size of handshake headers for TLS)
2384 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2385 * - ssl->out_msg + 4: the handshake message body
2386 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002387 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002388 * - ssl->out_msglen: the length of the record contents
2389 * (including handshake headers but excluding record headers)
2390 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002391 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002392int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002393{
Janos Follath865b3eb2019-12-16 11:46:15 +00002394 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002395 const size_t hs_len = ssl->out_msglen - 4;
2396 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002397
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2399
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002400 /*
2401 * Sanity checks
2402 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002403 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002404 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2405 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2407 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002408 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002409
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002410 /* Whenever we send anything different from a
2411 * HelloRequest we should be in a handshake - double check. */
2412 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2413 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002414 ssl->handshake == NULL )
2415 {
2416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2417 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2418 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002419
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002421 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002422 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002424 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2426 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002427 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002428#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002429
Hanno Beckerb50a2532018-08-06 11:52:54 +01002430 /* Double-check that we did not exceed the bounds
2431 * of the outgoing record buffer.
2432 * This should never fail as the various message
2433 * writing functions must obey the bounds of the
2434 * outgoing record buffer, but better be safe.
2435 *
2436 * Note: We deliberately do not check for the MTU or MFL here.
2437 */
2438 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2439 {
2440 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002441 "size %" MBEDTLS_PRINTF_SIZET
2442 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002443 ssl->out_msglen,
2444 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002445 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2446 }
2447
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002448 /*
2449 * Fill handshake headers
2450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002453 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2454 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2455 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002456
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002457 /*
2458 * DTLS has additional fields in the Handshake layer,
2459 * between the length field and the actual payload:
2460 * uint16 message_seq;
2461 * uint24 fragment_offset;
2462 * uint24 fragment_length;
2463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002465 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002466 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002467 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002468 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002469 {
2470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002471 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002472 hs_len,
2473 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002474 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2475 }
2476
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002477 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002478 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002479
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002480 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002481 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002482 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002483 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2484 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2485 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002486 }
2487 else
2488 {
2489 ssl->out_msg[4] = 0;
2490 ssl->out_msg[5] = 0;
2491 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002492
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002493 /* Handshake hashes are computed without fragmentation,
2494 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002495 memset( ssl->out_msg + 6, 0x00, 3 );
2496 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002497 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002499
Hanno Becker0207e532018-08-28 10:28:28 +01002500 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002501 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2502 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002503 }
2504
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002505 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002507 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002508 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2509 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002510 {
2511 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002514 return( ret );
2515 }
2516 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002520 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521 {
2522 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2523 return( ret );
2524 }
2525 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002526
2527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2528
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002529 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002530}
2531
2532/*
2533 * Record layer functions
2534 */
2535
2536/*
2537 * Write current record.
2538 *
2539 * Uses:
2540 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2541 * - ssl->out_msglen: length of the record content (excl headers)
2542 * - ssl->out_msg: record content
2543 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002544int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002545{
2546 int ret, done = 0;
2547 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002548 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002549
2550 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002551
Paul Bakker05ef8352012-05-08 09:17:57 +00002552 if( !done )
2553 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002554 unsigned i;
2555 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002556#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2557 size_t out_buf_len = ssl->out_buf_len;
2558#else
2559 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2560#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002561 /* Skip writing the record content type to after the encryption,
2562 * as it may change when using the CID extension. */
2563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002565 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002566
Hanno Becker19859472018-08-06 09:40:20 +01002567 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002568 ssl->out_len[0] = (unsigned char)( len >> 8 );
2569 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002570
Paul Bakker48916f92012-09-16 19:57:18 +00002571 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002572 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002573 mbedtls_record rec;
2574
2575 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002576 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002577 rec.data_len = ssl->out_msglen;
2578 rec.data_offset = ssl->out_msg - rec.buf;
2579
2580 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2581 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2582 ssl->conf->transport, rec.ver );
2583 rec.type = ssl->out_msgtype;
2584
Hanno Beckera0e20d02019-05-15 14:03:01 +01002585#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002586 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002587 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002588#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002589
Hanno Beckera18d1322018-01-03 14:27:32 +00002590 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002591 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002594 return( ret );
2595 }
2596
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002597 if( rec.data_offset != 0 )
2598 {
2599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2601 }
2602
Hanno Becker6430faf2019-05-08 11:57:13 +01002603 /* Update the record content type and CID. */
2604 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002605#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002606 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002607#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002608 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002609 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2610 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002611 }
2612
Hanno Becker5903de42019-05-03 14:46:38 +01002613 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002614
2615#if defined(MBEDTLS_SSL_PROTO_DTLS)
2616 /* In case of DTLS, double-check that we don't exceed
2617 * the remaining space in the datagram. */
2618 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2619 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002620 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002621 if( ret < 0 )
2622 return( ret );
2623
2624 if( protected_record_size > (size_t) ret )
2625 {
2626 /* Should never happen */
2627 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2628 }
2629 }
2630#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002631
Hanno Becker6430faf2019-05-08 11:57:13 +01002632 /* Now write the potentially updated record content type. */
2633 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2634
Paul Elliott9f352112020-12-09 14:55:45 +00002635 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002636 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002637 ssl->out_hdr[0], ssl->out_hdr[1],
2638 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002641 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002642
2643 ssl->out_left += protected_record_size;
2644 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002645 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002646
Hanno Beckerdd772292020-02-05 10:38:31 +00002647 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002648 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2649 break;
2650
2651 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002652 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002653 {
2654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2655 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2656 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002657 }
2658
Hanno Becker67bc7c32018-08-06 11:33:50 +01002659#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002660 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2661 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002662 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002663 size_t remaining;
2664 ret = ssl_get_remaining_payload_in_datagram( ssl );
2665 if( ret < 0 )
2666 {
2667 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2668 ret );
2669 return( ret );
2670 }
2671
2672 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002673 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002674 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002675 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002676 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002677 else
2678 {
Hanno Becker513815a2018-08-20 11:56:09 +01002679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002680 }
2681 }
2682#endif /* MBEDTLS_SSL_PROTO_DTLS */
2683
2684 if( ( flush == SSL_FORCE_FLUSH ) &&
2685 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002688 return( ret );
2689 }
2690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002692
2693 return( 0 );
2694}
2695
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002697
2698static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2699{
2700 if( ssl->in_msglen < ssl->in_hslen ||
2701 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2702 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2703 {
2704 return( 1 );
2705 }
2706 return( 0 );
2707}
Hanno Becker44650b72018-08-16 12:51:11 +01002708
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002709static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002710{
2711 return( ( ssl->in_msg[9] << 16 ) |
2712 ( ssl->in_msg[10] << 8 ) |
2713 ssl->in_msg[11] );
2714}
2715
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002716static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002717{
2718 return( ( ssl->in_msg[6] << 16 ) |
2719 ( ssl->in_msg[7] << 8 ) |
2720 ssl->in_msg[8] );
2721}
2722
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002723static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002724{
2725 uint32_t msg_len, frag_off, frag_len;
2726
2727 msg_len = ssl_get_hs_total_len( ssl );
2728 frag_off = ssl_get_hs_frag_off( ssl );
2729 frag_len = ssl_get_hs_frag_len( ssl );
2730
2731 if( frag_off > msg_len )
2732 return( -1 );
2733
2734 if( frag_len > msg_len - frag_off )
2735 return( -1 );
2736
2737 if( frag_len + 12 > ssl->in_msglen )
2738 return( -1 );
2739
2740 return( 0 );
2741}
2742
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002743/*
2744 * Mark bits in bitmask (used for DTLS HS reassembly)
2745 */
2746static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2747{
2748 unsigned int start_bits, end_bits;
2749
2750 start_bits = 8 - ( offset % 8 );
2751 if( start_bits != 8 )
2752 {
2753 size_t first_byte_idx = offset / 8;
2754
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002755 /* Special case */
2756 if( len <= start_bits )
2757 {
2758 for( ; len != 0; len-- )
2759 mask[first_byte_idx] |= 1 << ( start_bits - len );
2760
2761 /* Avoid potential issues with offset or len becoming invalid */
2762 return;
2763 }
2764
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002765 offset += start_bits; /* Now offset % 8 == 0 */
2766 len -= start_bits;
2767
2768 for( ; start_bits != 0; start_bits-- )
2769 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2770 }
2771
2772 end_bits = len % 8;
2773 if( end_bits != 0 )
2774 {
2775 size_t last_byte_idx = ( offset + len ) / 8;
2776
2777 len -= end_bits; /* Now len % 8 == 0 */
2778
2779 for( ; end_bits != 0; end_bits-- )
2780 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2781 }
2782
2783 memset( mask + offset / 8, 0xFF, len / 8 );
2784}
2785
2786/*
2787 * Check that bitmask is full
2788 */
2789static int ssl_bitmask_check( unsigned char *mask, size_t len )
2790{
2791 size_t i;
2792
2793 for( i = 0; i < len / 8; i++ )
2794 if( mask[i] != 0xFF )
2795 return( -1 );
2796
2797 for( i = 0; i < len % 8; i++ )
2798 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2799 return( -1 );
2800
2801 return( 0 );
2802}
2803
Hanno Becker56e205e2018-08-16 09:06:12 +01002804/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002805static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002806 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002807{
Hanno Becker56e205e2018-08-16 09:06:12 +01002808 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002809
Hanno Becker56e205e2018-08-16 09:06:12 +01002810 alloc_len = 12; /* Handshake header */
2811 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002812
Hanno Beckerd07df862018-08-16 09:14:58 +01002813 if( add_bitmap )
2814 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002815
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002816 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002817}
Hanno Becker56e205e2018-08-16 09:06:12 +01002818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002820
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002821static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002822{
2823 return( ( ssl->in_msg[1] << 16 ) |
2824 ( ssl->in_msg[2] << 8 ) |
2825 ssl->in_msg[3] );
2826}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002827
Simon Butcher99000142016-10-13 17:21:01 +01002828int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002829{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002831 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002832 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002833 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002835 }
2836
Hanno Becker12555c62018-08-16 12:47:53 +01002837 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002840 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002841 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002844 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002845 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002847 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002848
Hanno Becker44650b72018-08-16 12:51:11 +01002849 if( ssl_check_hs_header( ssl ) != 0 )
2850 {
2851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2852 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2853 }
2854
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002855 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002856 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2857 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2858 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2859 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002860 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002861 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2862 {
2863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2864 recv_msg_seq,
2865 ssl->handshake->in_msg_seq ) );
2866 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2867 }
2868
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002869 /* Retransmit only on last message from previous flight, to avoid
2870 * too many retransmissions.
2871 * Besides, No sane server ever retransmits HelloVerifyRequest */
2872 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002876 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002877 recv_msg_seq,
2878 ssl->handshake->in_flight_start_seq ) );
2879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002883 return( ret );
2884 }
2885 }
2886 else
2887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002889 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002890 recv_msg_seq,
2891 ssl->handshake->in_msg_seq ) );
2892 }
2893
Hanno Becker90333da2017-10-10 11:27:13 +01002894 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002895 }
2896 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002897
Hanno Becker6d97ef52018-08-16 13:09:04 +01002898 /* Message reassembly is handled alongside buffering of future
2899 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002900 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002901 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002902 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002903 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002905 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002906 }
2907 }
2908 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002909#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002910 /* With TLS we don't handle fragmentation (for now) */
2911 if( ssl->in_msglen < ssl->in_hslen )
2912 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2914 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002915 }
2916
Simon Butcher99000142016-10-13 17:21:01 +01002917 return( 0 );
2918}
2919
2920void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2921{
Hanno Becker0271f962018-08-16 13:23:47 +01002922 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002923
Hanno Becker0271f962018-08-16 13:23:47 +01002924 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002925 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002926 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002927 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002928
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002929 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002931 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002932 ssl->handshake != NULL )
2933 {
Hanno Becker0271f962018-08-16 13:23:47 +01002934 unsigned offset;
2935 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002936
Hanno Becker0271f962018-08-16 13:23:47 +01002937 /* Increment handshake sequence number */
2938 hs->in_msg_seq++;
2939
2940 /*
2941 * Clear up handshake buffering and reassembly structure.
2942 */
2943
2944 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002945 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002946
2947 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002948 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2949 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002950 offset++, hs_buf++ )
2951 {
2952 *hs_buf = *(hs_buf + 1);
2953 }
2954
2955 /* Create a fresh last entry */
2956 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002957 }
2958#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002959}
2960
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002961/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002962 * DTLS anti-replay: RFC 6347 4.1.2.6
2963 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002964 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2965 * Bit n is set iff record number in_window_top - n has been seen.
2966 *
2967 * Usually, in_window_top is the last record number seen and the lsb of
2968 * in_window is set. The only exception is the initial state (record number 0
2969 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002972void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002973{
2974 ssl->in_window_top = 0;
2975 ssl->in_window = 0;
2976}
2977
2978static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2979{
2980 return( ( (uint64_t) buf[0] << 40 ) |
2981 ( (uint64_t) buf[1] << 32 ) |
2982 ( (uint64_t) buf[2] << 24 ) |
2983 ( (uint64_t) buf[3] << 16 ) |
2984 ( (uint64_t) buf[4] << 8 ) |
2985 ( (uint64_t) buf[5] ) );
2986}
2987
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002988static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2989{
Janos Follath865b3eb2019-12-16 11:46:15 +00002990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002991 unsigned char *original_in_ctr;
2992
2993 // save original in_ctr
2994 original_in_ctr = ssl->in_ctr;
2995
2996 // use counter from record
2997 ssl->in_ctr = record_in_ctr;
2998
2999 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3000
3001 // restore the counter
3002 ssl->in_ctr = original_in_ctr;
3003
3004 return ret;
3005}
3006
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003007/*
3008 * Return 0 if sequence number is acceptable, -1 otherwise
3009 */
Hanno Becker0183d692019-07-12 08:50:37 +01003010int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003011{
3012 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3013 uint64_t bit;
3014
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003015 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003016 return( 0 );
3017
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003018 if( rec_seqnum > ssl->in_window_top )
3019 return( 0 );
3020
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003021 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003022
3023 if( bit >= 64 )
3024 return( -1 );
3025
3026 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3027 return( -1 );
3028
3029 return( 0 );
3030}
3031
3032/*
3033 * Update replay window on new validated record
3034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003036{
3037 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3038
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003039 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003040 return;
3041
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003042 if( rec_seqnum > ssl->in_window_top )
3043 {
3044 /* Update window_top and the contents of the window */
3045 uint64_t shift = rec_seqnum - ssl->in_window_top;
3046
3047 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003048 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003049 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003050 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003051 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003052 ssl->in_window |= 1;
3053 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003054
3055 ssl->in_window_top = rec_seqnum;
3056 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003057 else
3058 {
3059 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003060 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003061
3062 if( bit < 64 ) /* Always true, but be extra sure */
3063 ssl->in_window |= (uint64_t) 1 << bit;
3064 }
3065}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003067
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003068#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003069/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003070 * Without any SSL context, check if a datagram looks like a ClientHello with
3071 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003072 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003073 *
3074 * - if cookie is valid, return 0
3075 * - if ClientHello looks superficially valid but cookie is not,
3076 * fill obuf and set olen, then
3077 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3078 * - otherwise return a specific error code
3079 */
3080static int ssl_check_dtls_clihlo_cookie(
3081 mbedtls_ssl_cookie_write_t *f_cookie_write,
3082 mbedtls_ssl_cookie_check_t *f_cookie_check,
3083 void *p_cookie,
3084 const unsigned char *cli_id, size_t cli_id_len,
3085 const unsigned char *in, size_t in_len,
3086 unsigned char *obuf, size_t buf_len, size_t *olen )
3087{
3088 size_t sid_len, cookie_len;
3089 unsigned char *p;
3090
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003091 /*
3092 * Structure of ClientHello with record and handshake headers,
3093 * and expected values. We don't need to check a lot, more checks will be
3094 * done when actually parsing the ClientHello - skipping those checks
3095 * avoids code duplication and does not make cookie forging any easier.
3096 *
3097 * 0-0 ContentType type; copied, must be handshake
3098 * 1-2 ProtocolVersion version; copied
3099 * 3-4 uint16 epoch; copied, must be 0
3100 * 5-10 uint48 sequence_number; copied
3101 * 11-12 uint16 length; (ignored)
3102 *
3103 * 13-13 HandshakeType msg_type; (ignored)
3104 * 14-16 uint24 length; (ignored)
3105 * 17-18 uint16 message_seq; copied
3106 * 19-21 uint24 fragment_offset; copied, must be 0
3107 * 22-24 uint24 fragment_length; (ignored)
3108 *
3109 * 25-26 ProtocolVersion client_version; (ignored)
3110 * 27-58 Random random; (ignored)
3111 * 59-xx SessionID session_id; 1 byte len + sid_len content
3112 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3113 * ...
3114 *
3115 * Minimum length is 61 bytes.
3116 */
3117 if( in_len < 61 ||
3118 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3119 in[3] != 0 || in[4] != 0 ||
3120 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3121 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003122 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003123 }
3124
3125 sid_len = in[59];
3126 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003127 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003128
3129 cookie_len = in[60 + sid_len];
3130 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003131 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003132
3133 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3134 cli_id, cli_id_len ) == 0 )
3135 {
3136 /* Valid cookie */
3137 return( 0 );
3138 }
3139
3140 /*
3141 * If we get here, we've got an invalid cookie, let's prepare HVR.
3142 *
3143 * 0-0 ContentType type; copied
3144 * 1-2 ProtocolVersion version; copied
3145 * 3-4 uint16 epoch; copied
3146 * 5-10 uint48 sequence_number; copied
3147 * 11-12 uint16 length; olen - 13
3148 *
3149 * 13-13 HandshakeType msg_type; hello_verify_request
3150 * 14-16 uint24 length; olen - 25
3151 * 17-18 uint16 message_seq; copied
3152 * 19-21 uint24 fragment_offset; copied
3153 * 22-24 uint24 fragment_length; olen - 25
3154 *
3155 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3156 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3157 *
3158 * Minimum length is 28.
3159 */
3160 if( buf_len < 28 )
3161 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3162
3163 /* Copy most fields and adapt others */
3164 memcpy( obuf, in, 25 );
3165 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3166 obuf[25] = 0xfe;
3167 obuf[26] = 0xff;
3168
3169 /* Generate and write actual cookie */
3170 p = obuf + 28;
3171 if( f_cookie_write( p_cookie,
3172 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3173 {
3174 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3175 }
3176
3177 *olen = p - obuf;
3178
3179 /* Go back and fill length fields */
3180 obuf[27] = (unsigned char)( *olen - 28 );
3181
3182 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3183 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3184 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3185
3186 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3187 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3188
3189 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3190}
3191
3192/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003193 * Handle possible client reconnect with the same UDP quadruplet
3194 * (RFC 6347 Section 4.2.8).
3195 *
3196 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3197 * that looks like a ClientHello.
3198 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003199 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003200 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003201 * - if the input looks like a ClientHello with a valid cookie,
3202 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003203 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003204 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003205 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003206 * This function is called (through ssl_check_client_reconnect()) when an
3207 * unexpected record is found in ssl_get_next_record(), which will discard the
3208 * record if we return 0, and bubble up the return value otherwise (this
3209 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3210 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003211 */
3212static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3213{
Janos Follath865b3eb2019-12-16 11:46:15 +00003214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003215 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003216
Hanno Becker2fddd372019-07-10 14:37:41 +01003217 if( ssl->conf->f_cookie_write == NULL ||
3218 ssl->conf->f_cookie_check == NULL )
3219 {
3220 /* If we can't use cookies to verify reachability of the peer,
3221 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003222 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3223 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003224 return( 0 );
3225 }
3226
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003227 ret = ssl_check_dtls_clihlo_cookie(
3228 ssl->conf->f_cookie_write,
3229 ssl->conf->f_cookie_check,
3230 ssl->conf->p_cookie,
3231 ssl->cli_id, ssl->cli_id_len,
3232 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003233 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003234
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003235 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3236
3237 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003238 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003239 int send_ret;
3240 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3241 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3242 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003243 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003244 * If the error is permanent we'll catch it later,
3245 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003246 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3247 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3248 (void) send_ret;
3249
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003250 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003251 }
3252
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003253 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003254 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003256 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003257 {
3258 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3259 return( ret );
3260 }
3261
3262 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003263 }
3264
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003265 return( ret );
3266}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003267#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003268
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003269static int ssl_check_record_type( uint8_t record_type )
3270{
3271 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3272 record_type != MBEDTLS_SSL_MSG_ALERT &&
3273 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3274 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3275 {
3276 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3277 }
3278
3279 return( 0 );
3280}
3281
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003282/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003283 * ContentType type;
3284 * ProtocolVersion version;
3285 * uint16 epoch; // DTLS only
3286 * uint48 sequence_number; // DTLS only
3287 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003288 *
3289 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003290 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003291 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3292 *
3293 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003294 * 1. proceed with the record if this function returns 0
3295 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3296 * 3. return CLIENT_RECONNECT if this function return that value
3297 * 4. drop the whole datagram if this function returns anything else.
3298 * Point 2 is needed when the peer is resending, and we have already received
3299 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003300 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003301static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003302 unsigned char *buf,
3303 size_t len,
3304 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003305{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003306 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003307
Hanno Beckere5e7e782019-07-11 12:29:35 +01003308 size_t const rec_hdr_type_offset = 0;
3309 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003310
Hanno Beckere5e7e782019-07-11 12:29:35 +01003311 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3312 rec_hdr_type_len;
3313 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003314
Hanno Beckere5e7e782019-07-11 12:29:35 +01003315 size_t const rec_hdr_ctr_len = 8;
3316#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003317 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003318 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3319 rec_hdr_version_len;
3320
Hanno Beckera0e20d02019-05-15 14:03:01 +01003321#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003322 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3323 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003324 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003325#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3326#endif /* MBEDTLS_SSL_PROTO_DTLS */
3327
3328 size_t rec_hdr_len_offset; /* To be determined */
3329 size_t const rec_hdr_len_len = 2;
3330
3331 /*
3332 * Check minimum lengths for record header.
3333 */
3334
3335#if defined(MBEDTLS_SSL_PROTO_DTLS)
3336 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3337 {
3338 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3339 }
3340 else
3341#endif /* MBEDTLS_SSL_PROTO_DTLS */
3342 {
3343 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3344 }
3345
3346 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3347 {
3348 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3349 (unsigned) len,
3350 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3351 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3352 }
3353
3354 /*
3355 * Parse and validate record content type
3356 */
3357
3358 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003359
3360 /* Check record content type */
3361#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3362 rec->cid_len = 0;
3363
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003364 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003365 ssl->conf->cid_len != 0 &&
3366 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003367 {
3368 /* Shift pointers to account for record header including CID
3369 * struct {
3370 * ContentType special_type = tls12_cid;
3371 * ProtocolVersion version;
3372 * uint16 epoch;
3373 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003374 * opaque cid[cid_length]; // Additional field compared to
3375 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003376 * uint16 length;
3377 * opaque enc_content[DTLSCiphertext.length];
3378 * } DTLSCiphertext;
3379 */
3380
3381 /* So far, we only support static CID lengths
3382 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383 rec_hdr_cid_len = ssl->conf->cid_len;
3384 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003385
Hanno Beckere5e7e782019-07-11 12:29:35 +01003386 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003387 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3389 (unsigned) len,
3390 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003391 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003392 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003393
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003394 /* configured CID len is guaranteed at most 255, see
3395 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3396 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003397 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003398 }
3399 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003400#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003401 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003402 if( ssl_check_record_type( rec->type ) )
3403 {
Hanno Becker54229812019-07-12 14:40:00 +01003404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3405 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003406 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3407 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003408 }
3409
Hanno Beckere5e7e782019-07-11 12:29:35 +01003410 /*
3411 * Parse and validate record version
3412 */
3413
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003414 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3415 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003416 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3417 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003418 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003419
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003420 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3423 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 }
3425
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003426 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003427 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3429 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003430 }
3431
Hanno Beckere5e7e782019-07-11 12:29:35 +01003432 /*
3433 * Parse/Copy record sequence number.
3434 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003435
Hanno Beckere5e7e782019-07-11 12:29:35 +01003436#if defined(MBEDTLS_SSL_PROTO_DTLS)
3437 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003438 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003439 /* Copy explicit record sequence number from input buffer. */
3440 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3441 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003442 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003443 else
3444#endif /* MBEDTLS_SSL_PROTO_DTLS */
3445 {
3446 /* Copy implicit record sequence number from SSL context structure. */
3447 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3448 }
Paul Bakker40e46942009-01-03 21:51:57 +00003449
Hanno Beckere5e7e782019-07-11 12:29:35 +01003450 /*
3451 * Parse record length.
3452 */
3453
Hanno Beckere5e7e782019-07-11 12:29:35 +01003454 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003455 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3456 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003457 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003458
Paul Elliott9f352112020-12-09 14:55:45 +00003459 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003460 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003461 rec->type,
3462 major_ver, minor_ver, rec->data_len ) );
3463
3464 rec->buf = buf;
3465 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003466
Hanno Beckerd417cc92019-07-26 08:20:27 +01003467 if( rec->data_len == 0 )
3468 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003469
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003470 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003471 * DTLS-related tests.
3472 * Check epoch before checking length constraint because
3473 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3474 * message gets duplicated before the corresponding Finished message,
3475 * the second ChangeCipherSpec should be discarded because it belongs
3476 * to an old epoch, but not because its length is shorter than
3477 * the minimum record length for packets using the new record transform.
3478 * Note that these two kinds of failures are handled differently,
3479 * as an unexpected record is silently skipped but an invalid
3480 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003481 */
3482#if defined(MBEDTLS_SSL_PROTO_DTLS)
3483 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3484 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003485 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003486
Hanno Becker955a5c92019-07-10 17:12:07 +01003487 /* Check that the datagram is large enough to contain a record
3488 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003489 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003490 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3492 (unsigned) len,
3493 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003494 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3495 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003496
Hanno Becker37cfe732019-07-10 17:20:01 +01003497 /* Records from other, non-matching epochs are silently discarded.
3498 * (The case of same-port Client reconnects must be considered in
3499 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003500 if( rec_epoch != ssl->in_epoch )
3501 {
3502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003503 "expected %u, received %lu",
3504 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003505
Hanno Becker552f7472019-07-19 10:59:12 +01003506 /* Records from the next epoch are considered for buffering
3507 * (concretely: early Finished messages). */
3508 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003509 {
Hanno Becker552f7472019-07-19 10:59:12 +01003510 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3511 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003512 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003513
Hanno Becker2fddd372019-07-10 14:37:41 +01003514 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003515 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003516#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003517 /* For records from the correct epoch, check whether their
3518 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003519 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3520 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003521 {
3522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3523 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3524 }
3525#endif
3526 }
3527#endif /* MBEDTLS_SSL_PROTO_DTLS */
3528
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003529 return( 0 );
3530}
Paul Bakker5121ce52009-01-03 21:22:43 +00003531
Paul Bakker5121ce52009-01-03 21:22:43 +00003532
Hanno Becker2fddd372019-07-10 14:37:41 +01003533#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3534static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3535{
3536 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3537
3538 /*
3539 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3540 * access the first byte of record content (handshake type), as we
3541 * have an active transform (possibly iv_len != 0), so use the
3542 * fact that the record header len is 13 instead.
3543 */
3544 if( rec_epoch == 0 &&
3545 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3546 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3547 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3548 ssl->in_left > 13 &&
3549 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3550 {
3551 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3552 "from the same port" ) );
3553 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003554 }
3555
3556 return( 0 );
3557}
Hanno Becker2fddd372019-07-10 14:37:41 +01003558#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003559
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003560/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003561 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003562 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003563static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3564 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003565{
3566 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003569 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003570
Paul Bakker48916f92012-09-16 19:57:18 +00003571 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003572 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003573 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003574
Hanno Beckera18d1322018-01-03 14:27:32 +00003575 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003576 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003579
Hanno Beckera0e20d02019-05-15 14:03:01 +01003580#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003581 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3582 ssl->conf->ignore_unexpected_cid
3583 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3584 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003585 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003586 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003587 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003588#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003589
Paul Bakker5121ce52009-01-03 21:22:43 +00003590 return( ret );
3591 }
3592
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003593 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003594 {
3595 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003596 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003597 }
3598
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003599 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003600 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003601
Hanno Beckera0e20d02019-05-15 14:03:01 +01003602#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003603 /* We have already checked the record content type
3604 * in ssl_parse_record_header(), failing or silently
3605 * dropping the record in the case of an unknown type.
3606 *
3607 * Since with the use of CIDs, the record content type
3608 * might change during decryption, re-check the record
3609 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003610 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003611 {
3612 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3613 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3614 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003615#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003616
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003617 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003618 {
3619#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3620 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003621 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003622 {
3623 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3625 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3626 }
3627#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3628
3629 ssl->nb_zero++;
3630
3631 /*
3632 * Three or more empty messages may be a DoS attack
3633 * (excessive CPU consumption).
3634 */
3635 if( ssl->nb_zero > 3 )
3636 {
3637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003638 "messages, possible DoS attack" ) );
3639 /* Treat the records as if they were not properly authenticated,
3640 * thereby failing the connection if we see more than allowed
3641 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003642 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3643 }
3644 }
3645 else
3646 ssl->nb_zero = 0;
3647
3648#if defined(MBEDTLS_SSL_PROTO_DTLS)
3649 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3650 {
3651 ; /* in_ctr read from peer, not maintained internally */
3652 }
3653 else
3654#endif
3655 {
3656 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003657 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003658 if( ++ssl->in_ctr[i - 1] != 0 )
3659 break;
3660
3661 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003662 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003663 {
3664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3665 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3666 }
3667 }
3668
Paul Bakker5121ce52009-01-03 21:22:43 +00003669 }
3670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003672 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003673 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003675 }
3676#endif
3677
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003678 /* Check actual (decrypted) record content length against
3679 * configured maximum. */
3680 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3681 {
3682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3683 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3684 }
3685
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003686 return( 0 );
3687}
3688
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003689/*
3690 * Read a record.
3691 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003692 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3693 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3694 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003695 */
Hanno Becker1097b342018-08-15 14:09:41 +01003696
3697/* Helper functions for mbedtls_ssl_read_record(). */
3698static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003699static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3700static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003701
Hanno Becker327c93b2018-08-15 13:56:18 +01003702int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003703 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003704{
Janos Follath865b3eb2019-12-16 11:46:15 +00003705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003708
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003709 if( ssl->keep_current_message == 0 )
3710 {
3711 do {
Simon Butcher99000142016-10-13 17:21:01 +01003712
Hanno Becker26994592018-08-15 14:14:59 +01003713 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003714 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003715 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003716
Hanno Beckere74d5562018-08-15 14:26:08 +01003717 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003718 {
Hanno Becker40f50842018-08-15 14:48:01 +01003719#if defined(MBEDTLS_SSL_PROTO_DTLS)
3720 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003721
Hanno Becker40f50842018-08-15 14:48:01 +01003722 /* We only check for buffered messages if the
3723 * current datagram is fully consumed. */
3724 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003725 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003726 {
Hanno Becker40f50842018-08-15 14:48:01 +01003727 if( ssl_load_buffered_message( ssl ) == 0 )
3728 have_buffered = 1;
3729 }
3730
3731 if( have_buffered == 0 )
3732#endif /* MBEDTLS_SSL_PROTO_DTLS */
3733 {
3734 ret = ssl_get_next_record( ssl );
3735 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3736 continue;
3737
3738 if( ret != 0 )
3739 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003740 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003741 return( ret );
3742 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003743 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003744 }
3745
3746 ret = mbedtls_ssl_handle_message_type( ssl );
3747
Hanno Becker40f50842018-08-15 14:48:01 +01003748#if defined(MBEDTLS_SSL_PROTO_DTLS)
3749 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3750 {
3751 /* Buffer future message */
3752 ret = ssl_buffer_message( ssl );
3753 if( ret != 0 )
3754 return( ret );
3755
3756 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3757 }
3758#endif /* MBEDTLS_SSL_PROTO_DTLS */
3759
Hanno Becker90333da2017-10-10 11:27:13 +01003760 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3761 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003762
3763 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003764 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003765 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003766 return( ret );
3767 }
3768
Hanno Becker327c93b2018-08-15 13:56:18 +01003769 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003770 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003771 {
3772 mbedtls_ssl_update_handshake_status( ssl );
3773 }
Simon Butcher99000142016-10-13 17:21:01 +01003774 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003775 else
Simon Butcher99000142016-10-13 17:21:01 +01003776 {
Hanno Becker02f59072018-08-15 14:00:24 +01003777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003778 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003779 }
3780
3781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3782
3783 return( 0 );
3784}
3785
Hanno Becker40f50842018-08-15 14:48:01 +01003786#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003787static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003788{
Hanno Becker40f50842018-08-15 14:48:01 +01003789 if( ssl->in_left > ssl->next_record_offset )
3790 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003791
Hanno Becker40f50842018-08-15 14:48:01 +01003792 return( 0 );
3793}
3794
3795static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3796{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003797 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003798 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003799 int ret = 0;
3800
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003801 if( hs == NULL )
3802 return( -1 );
3803
Hanno Beckere00ae372018-08-20 09:39:42 +01003804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3805
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003806 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3807 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3808 {
3809 /* Check if we have seen a ChangeCipherSpec before.
3810 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003811 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003812 {
3813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3814 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003815 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003816 }
3817
Hanno Becker39b8bc92018-08-28 17:17:13 +01003818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003819 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3820 ssl->in_msglen = 1;
3821 ssl->in_msg[0] = 1;
3822
3823 /* As long as they are equal, the exact value doesn't matter. */
3824 ssl->in_left = 0;
3825 ssl->next_record_offset = 0;
3826
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003827 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003828 goto exit;
3829 }
Hanno Becker37f95322018-08-16 13:55:32 +01003830
Hanno Beckerb8f50142018-08-28 10:01:34 +01003831#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003832 /* Debug only */
3833 {
3834 unsigned offset;
3835 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3836 {
3837 hs_buf = &hs->buffering.hs[offset];
3838 if( hs_buf->is_valid == 1 )
3839 {
3840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3841 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003842 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003843 }
3844 }
3845 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003846#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003847
3848 /* Check if we have buffered and/or fully reassembled the
3849 * next handshake message. */
3850 hs_buf = &hs->buffering.hs[0];
3851 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3852 {
3853 /* Synthesize a record containing the buffered HS message. */
3854 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3855 ( hs_buf->data[2] << 8 ) |
3856 hs_buf->data[3];
3857
3858 /* Double-check that we haven't accidentally buffered
3859 * a message that doesn't fit into the input buffer. */
3860 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3861 {
3862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3863 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3864 }
3865
3866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3867 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3868 hs_buf->data, msg_len + 12 );
3869
3870 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3871 ssl->in_hslen = msg_len + 12;
3872 ssl->in_msglen = msg_len + 12;
3873 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3874
3875 ret = 0;
3876 goto exit;
3877 }
3878 else
3879 {
3880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3881 hs->in_msg_seq ) );
3882 }
3883
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003884 ret = -1;
3885
3886exit:
3887
3888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3889 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003890}
3891
Hanno Beckera02b0b42018-08-21 17:20:27 +01003892static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3893 size_t desired )
3894{
3895 int offset;
3896 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3898 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003899
Hanno Becker01315ea2018-08-21 17:22:17 +01003900 /* Get rid of future records epoch first, if such exist. */
3901 ssl_free_buffered_record( ssl );
3902
3903 /* Check if we have enough space available now. */
3904 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3905 hs->buffering.total_bytes_buffered ) )
3906 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003908 return( 0 );
3909 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003910
Hanno Becker4f432ad2018-08-28 10:02:32 +01003911 /* We don't have enough space to buffer the next expected handshake
3912 * message. Remove buffers used for future messages to gain space,
3913 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003914 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3915 offset >= 0; offset-- )
3916 {
3917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3918 offset ) );
3919
Hanno Beckerb309b922018-08-23 13:18:05 +01003920 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003921
3922 /* Check if we have enough space available now. */
3923 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3924 hs->buffering.total_bytes_buffered ) )
3925 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003927 return( 0 );
3928 }
3929 }
3930
3931 return( -1 );
3932}
3933
Hanno Becker40f50842018-08-15 14:48:01 +01003934static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3935{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003936 int ret = 0;
3937 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3938
3939 if( hs == NULL )
3940 return( 0 );
3941
3942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3943
3944 switch( ssl->in_msgtype )
3945 {
3946 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003948
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003949 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003950 break;
3951
3952 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003953 {
3954 unsigned recv_msg_seq_offset;
3955 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3956 mbedtls_ssl_hs_buffer *hs_buf;
3957 size_t msg_len = ssl->in_hslen - 12;
3958
3959 /* We should never receive an old handshake
3960 * message - double-check nonetheless. */
3961 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3962 {
3963 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3964 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3965 }
3966
3967 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3968 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3969 {
3970 /* Silently ignore -- message too far in the future */
3971 MBEDTLS_SSL_DEBUG_MSG( 2,
3972 ( "Ignore future HS message with sequence number %u, "
3973 "buffering window %u - %u",
3974 recv_msg_seq, ssl->handshake->in_msg_seq,
3975 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3976
3977 goto exit;
3978 }
3979
3980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3981 recv_msg_seq, recv_msg_seq_offset ) );
3982
3983 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3984
3985 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003986 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003987 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003988 size_t reassembly_buf_sz;
3989
Hanno Becker37f95322018-08-16 13:55:32 +01003990 hs_buf->is_fragmented =
3991 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3992
3993 /* We copy the message back into the input buffer
3994 * after reassembly, so check that it's not too large.
3995 * This is an implementation-specific limitation
3996 * and not one from the standard, hence it is not
3997 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003998 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003999 {
4000 /* Ignore message */
4001 goto exit;
4002 }
4003
Hanno Beckere0b150f2018-08-21 15:51:03 +01004004 /* Check if we have enough space to buffer the message. */
4005 if( hs->buffering.total_bytes_buffered >
4006 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4007 {
4008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4009 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4010 }
4011
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004012 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4013 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004014
4015 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4016 hs->buffering.total_bytes_buffered ) )
4017 {
4018 if( recv_msg_seq_offset > 0 )
4019 {
4020 /* If we can't buffer a future message because
4021 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4023 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4024 " (already %" MBEDTLS_PRINTF_SIZET
4025 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004026 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004027 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004028 goto exit;
4029 }
Hanno Beckere1801392018-08-21 16:51:05 +01004030 else
4031 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4033 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4034 " (already %" MBEDTLS_PRINTF_SIZET
4035 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004036 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004037 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004038 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004039
Hanno Beckera02b0b42018-08-21 17:20:27 +01004040 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004041 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4043 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4044 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4045 " (already %" MBEDTLS_PRINTF_SIZET
4046 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004047 msg_len,
4048 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004049 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004050 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004051 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4052 goto exit;
4053 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004054 }
4055
Paul Elliottd48d5c62021-01-07 14:47:05 +00004056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004057 msg_len ) );
4058
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004059 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4060 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004061 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004062 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004063 goto exit;
4064 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004065 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004066
4067 /* Prepare final header: copy msg_type, length and message_seq,
4068 * then add standardised fragment_offset and fragment_length */
4069 memcpy( hs_buf->data, ssl->in_msg, 6 );
4070 memset( hs_buf->data + 6, 0, 3 );
4071 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4072
4073 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004074
4075 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004076 }
4077 else
4078 {
4079 /* Make sure msg_type and length are consistent */
4080 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4081 {
4082 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4083 /* Ignore */
4084 goto exit;
4085 }
4086 }
4087
Hanno Becker4422bbb2018-08-20 09:40:19 +01004088 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004089 {
4090 size_t frag_len, frag_off;
4091 unsigned char * const msg = hs_buf->data + 12;
4092
4093 /*
4094 * Check and copy current fragment
4095 */
4096
4097 /* Validation of header fields already done in
4098 * mbedtls_ssl_prepare_handshake_record(). */
4099 frag_off = ssl_get_hs_frag_off( ssl );
4100 frag_len = ssl_get_hs_frag_len( ssl );
4101
Paul Elliottd48d5c62021-01-07 14:47:05 +00004102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4103 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004104 frag_off, frag_len ) );
4105 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4106
4107 if( hs_buf->is_fragmented )
4108 {
4109 unsigned char * const bitmask = msg + msg_len;
4110 ssl_bitmask_set( bitmask, frag_off, frag_len );
4111 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4112 msg_len ) == 0 );
4113 }
4114 else
4115 {
4116 hs_buf->is_complete = 1;
4117 }
4118
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4120 hs_buf->is_complete ? "" : "not yet " ) );
4121 }
4122
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004124 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125
4126 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004127 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004128 break;
4129 }
4130
4131exit:
4132
4133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4134 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004135}
4136#endif /* MBEDTLS_SSL_PROTO_DTLS */
4137
Hanno Becker1097b342018-08-15 14:09:41 +01004138static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004139{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004140 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004141 * Consume last content-layer message and potentially
4142 * update in_msglen which keeps track of the contents'
4143 * consumption state.
4144 *
4145 * (1) Handshake messages:
4146 * Remove last handshake message, move content
4147 * and adapt in_msglen.
4148 *
4149 * (2) Alert messages:
4150 * Consume whole record content, in_msglen = 0.
4151 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004152 * (3) Change cipher spec:
4153 * Consume whole record content, in_msglen = 0.
4154 *
4155 * (4) Application data:
4156 * Don't do anything - the record layer provides
4157 * the application data as a stream transport
4158 * and consumes through mbedtls_ssl_read only.
4159 *
4160 */
4161
4162 /* Case (1): Handshake messages */
4163 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004164 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004165 /* Hard assertion to be sure that no application data
4166 * is in flight, as corrupting ssl->in_msglen during
4167 * ssl->in_offt != NULL is fatal. */
4168 if( ssl->in_offt != NULL )
4169 {
4170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4172 }
4173
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004174 /*
4175 * Get next Handshake message in the current record
4176 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004177
Hanno Becker4a810fb2017-05-24 16:27:30 +01004178 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004179 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004180 * current handshake content: If DTLS handshake
4181 * fragmentation is used, that's the fragment
4182 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004183 * size here is faulty and should be changed at
4184 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004185 * (2) While it doesn't seem to cause problems, one
4186 * has to be very careful not to assume that in_hslen
4187 * is always <= in_msglen in a sensible communication.
4188 * Again, it's wrong for DTLS handshake fragmentation.
4189 * The following check is therefore mandatory, and
4190 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004191 * Additionally, ssl->in_hslen might be arbitrarily out of
4192 * bounds after handling a DTLS message with an unexpected
4193 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004194 */
4195 if( ssl->in_hslen < ssl->in_msglen )
4196 {
4197 ssl->in_msglen -= ssl->in_hslen;
4198 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4199 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004200
Hanno Becker4a810fb2017-05-24 16:27:30 +01004201 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4202 ssl->in_msg, ssl->in_msglen );
4203 }
4204 else
4205 {
4206 ssl->in_msglen = 0;
4207 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004208
Hanno Becker4a810fb2017-05-24 16:27:30 +01004209 ssl->in_hslen = 0;
4210 }
4211 /* Case (4): Application data */
4212 else if( ssl->in_offt != NULL )
4213 {
4214 return( 0 );
4215 }
4216 /* Everything else (CCS & Alerts) */
4217 else
4218 {
4219 ssl->in_msglen = 0;
4220 }
4221
Hanno Becker1097b342018-08-15 14:09:41 +01004222 return( 0 );
4223}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004224
Hanno Beckere74d5562018-08-15 14:26:08 +01004225static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4226{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004227 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004228 return( 1 );
4229
4230 return( 0 );
4231}
4232
Hanno Becker5f066e72018-08-16 14:56:31 +01004233#if defined(MBEDTLS_SSL_PROTO_DTLS)
4234
4235static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4236{
4237 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4238 if( hs == NULL )
4239 return;
4240
Hanno Becker01315ea2018-08-21 17:22:17 +01004241 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004242 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004243 hs->buffering.total_bytes_buffered -=
4244 hs->buffering.future_record.len;
4245
4246 mbedtls_free( hs->buffering.future_record.data );
4247 hs->buffering.future_record.data = NULL;
4248 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004249}
4250
4251static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4252{
4253 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4254 unsigned char * rec;
4255 size_t rec_len;
4256 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4258 size_t in_buf_len = ssl->in_buf_len;
4259#else
4260 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4261#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004262 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4263 return( 0 );
4264
4265 if( hs == NULL )
4266 return( 0 );
4267
Hanno Becker5f066e72018-08-16 14:56:31 +01004268 rec = hs->buffering.future_record.data;
4269 rec_len = hs->buffering.future_record.len;
4270 rec_epoch = hs->buffering.future_record.epoch;
4271
4272 if( rec == NULL )
4273 return( 0 );
4274
Hanno Becker4cb782d2018-08-20 11:19:05 +01004275 /* Only consider loading future records if the
4276 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004277 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004278 return( 0 );
4279
Hanno Becker5f066e72018-08-16 14:56:31 +01004280 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4281
4282 if( rec_epoch != ssl->in_epoch )
4283 {
4284 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4285 goto exit;
4286 }
4287
4288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4289
4290 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004291 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004292 {
4293 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4294 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4295 }
4296
4297 memcpy( ssl->in_hdr, rec, rec_len );
4298 ssl->in_left = rec_len;
4299 ssl->next_record_offset = 0;
4300
4301 ssl_free_buffered_record( ssl );
4302
4303exit:
4304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4305 return( 0 );
4306}
4307
Hanno Becker519f15d2019-07-11 12:43:20 +01004308static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4309 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004310{
4311 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004312
4313 /* Don't buffer future records outside handshakes. */
4314 if( hs == NULL )
4315 return( 0 );
4316
4317 /* Only buffer handshake records (we are only interested
4318 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004319 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004320 return( 0 );
4321
4322 /* Don't buffer more than one future epoch record. */
4323 if( hs->buffering.future_record.data != NULL )
4324 return( 0 );
4325
Hanno Becker01315ea2018-08-21 17:22:17 +01004326 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004327 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004328 hs->buffering.total_bytes_buffered ) )
4329 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4331 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4332 " (already %" MBEDTLS_PRINTF_SIZET
4333 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004334 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004335 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004336 return( 0 );
4337 }
4338
Hanno Becker5f066e72018-08-16 14:56:31 +01004339 /* Buffer record */
4340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004341 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004342 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004343
4344 /* ssl_parse_record_header() only considers records
4345 * of the next epoch as candidates for buffering. */
4346 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004347 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004348
4349 hs->buffering.future_record.data =
4350 mbedtls_calloc( 1, hs->buffering.future_record.len );
4351 if( hs->buffering.future_record.data == NULL )
4352 {
4353 /* If we run out of RAM trying to buffer a
4354 * record from the next epoch, just ignore. */
4355 return( 0 );
4356 }
4357
Hanno Becker519f15d2019-07-11 12:43:20 +01004358 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004359
Hanno Becker519f15d2019-07-11 12:43:20 +01004360 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004361 return( 0 );
4362}
4363
4364#endif /* MBEDTLS_SSL_PROTO_DTLS */
4365
Hanno Beckere74d5562018-08-15 14:26:08 +01004366static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004367{
Janos Follath865b3eb2019-12-16 11:46:15 +00004368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004369 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004370
Hanno Becker5f066e72018-08-16 14:56:31 +01004371#if defined(MBEDTLS_SSL_PROTO_DTLS)
4372 /* We might have buffered a future record; if so,
4373 * and if the epoch matches now, load it.
4374 * On success, this call will set ssl->in_left to
4375 * the length of the buffered record, so that
4376 * the calls to ssl_fetch_input() below will
4377 * essentially be no-ops. */
4378 ret = ssl_load_buffered_record( ssl );
4379 if( ret != 0 )
4380 return( ret );
4381#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004383 /* Ensure that we have enough space available for the default form
4384 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4385 * with no space for CIDs counted in). */
4386 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4387 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004388 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004389 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004390 return( ret );
4391 }
4392
Hanno Beckere5e7e782019-07-11 12:29:35 +01004393 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4394 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004395 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004397 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004398 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004399 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4400 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004401 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004402 if( ret != 0 )
4403 return( ret );
4404
4405 /* Fall through to handling of unexpected records */
4406 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4407 }
4408
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004409 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4410 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004411#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004412 /* Reset in pointers to default state for TLS/DTLS records,
4413 * assuming no CID and no offset between record content and
4414 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004415 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004416
Hanno Becker7ae20e02019-07-12 08:33:49 +01004417 /* Setup internal message pointers from record structure. */
4418 ssl->in_msgtype = rec.type;
4419#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4420 ssl->in_len = ssl->in_cid + rec.cid_len;
4421#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4422 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4423 ssl->in_msglen = rec.data_len;
4424
Hanno Becker2fddd372019-07-10 14:37:41 +01004425 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004426 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004427 if( ret != 0 )
4428 return( ret );
4429#endif
4430
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004431 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004432 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004433
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4435 "(header)" ) );
4436 }
4437 else
4438 {
4439 /* Skip invalid record and the rest of the datagram */
4440 ssl->next_record_offset = 0;
4441 ssl->in_left = 0;
4442
4443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4444 "(header)" ) );
4445 }
4446
4447 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004448 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004450 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004451#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004452 {
4453 return( ret );
4454 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004455 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004458 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004459 {
Hanno Beckera8814792019-07-10 15:01:45 +01004460 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004461 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004462 if( ssl->next_record_offset < ssl->in_left )
4463 {
4464 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4465 }
4466 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004467 else
4468#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004469 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004470 /*
4471 * Fetch record contents from underlying transport.
4472 */
Hanno Beckera3175662019-07-11 12:50:29 +01004473 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004474 if( ret != 0 )
4475 {
4476 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4477 return( ret );
4478 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004479
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004480 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004481 }
4482
4483 /*
4484 * Decrypt record contents.
4485 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004486
Hanno Beckerfdf66042019-07-11 13:07:45 +01004487 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004489#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004490 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004491 {
4492 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004493 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004494 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004495 /* Except when waiting for Finished as a bad mac here
4496 * probably means something went wrong in the handshake
4497 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4498 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4499 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4500 {
4501#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4502 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4503 {
4504 mbedtls_ssl_send_alert_message( ssl,
4505 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4506 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4507 }
4508#endif
4509 return( ret );
4510 }
4511
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004512 if( ssl->conf->badmac_limit != 0 &&
4513 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4516 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004517 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004518
Hanno Becker4a810fb2017-05-24 16:27:30 +01004519 /* As above, invalid records cause
4520 * dismissal of the whole datagram. */
4521
4522 ssl->next_record_offset = 0;
4523 ssl->in_left = 0;
4524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004525 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004526 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004527 }
4528
4529 return( ret );
4530 }
4531 else
4532#endif
4533 {
4534 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004535#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4536 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538 mbedtls_ssl_send_alert_message( ssl,
4539 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4540 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004541 }
4542#endif
4543 return( ret );
4544 }
4545 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004546
Hanno Becker44d89b22019-07-12 09:40:44 +01004547
4548 /* Reset in pointers to default state for TLS/DTLS records,
4549 * assuming no CID and no offset between record content and
4550 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004551 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004552#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4553 ssl->in_len = ssl->in_cid + rec.cid_len;
4554#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004555 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004556
Hanno Becker8685c822019-07-12 09:37:30 +01004557 /* The record content type may change during decryption,
4558 * so re-read it. */
4559 ssl->in_msgtype = rec.type;
4560 /* Also update the input buffer, because unfortunately
4561 * the server-side ssl_parse_client_hello() reparses the
4562 * record header when receiving a ClientHello initiating
4563 * a renegotiation. */
4564 ssl->in_hdr[0] = rec.type;
4565 ssl->in_msg = rec.buf + rec.data_offset;
4566 ssl->in_msglen = rec.data_len;
4567 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4568 ssl->in_len[1] = (unsigned char)( rec.data_len );
4569
Simon Butcher99000142016-10-13 17:21:01 +01004570 return( 0 );
4571}
4572
4573int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4574{
Janos Follath865b3eb2019-12-16 11:46:15 +00004575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004576
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004577 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004578 * Handle particular types of records
4579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004580 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004581 {
Simon Butcher99000142016-10-13 17:21:01 +01004582 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4583 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004584 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004585 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004586 }
4587
Hanno Beckere678eaa2018-08-21 14:57:46 +01004588 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004589 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004590 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004591 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004592 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004593 ssl->in_msglen ) );
4594 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004595 }
4596
Hanno Beckere678eaa2018-08-21 14:57:46 +01004597 if( ssl->in_msg[0] != 1 )
4598 {
4599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4600 ssl->in_msg[0] ) );
4601 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4602 }
4603
4604#if defined(MBEDTLS_SSL_PROTO_DTLS)
4605 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4606 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4607 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4608 {
4609 if( ssl->handshake == NULL )
4610 {
4611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4612 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4613 }
4614
4615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4616 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4617 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004618#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004619 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004622 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004623 if( ssl->in_msglen != 2 )
4624 {
4625 /* Note: Standard allows for more than one 2 byte alert
4626 to be packed in a single message, but Mbed TLS doesn't
4627 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004628 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004629 ssl->in_msglen ) );
4630 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4631 }
4632
Paul Elliott9f352112020-12-09 14:55:45 +00004633 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004634 ssl->in_msg[0], ssl->in_msg[1] ) );
4635
4636 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004637 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004638 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004639 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004642 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004643 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004644 }
4645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004646 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4647 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004648 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4650 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004651 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004652
4653#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4654 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4655 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4656 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004658 /* Will be handled when trying to parse ServerHello */
4659 return( 0 );
4660 }
4661#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004662 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004663 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004664 }
4665
Hanno Beckerc76c6192017-06-06 10:03:17 +01004666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004667 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004668 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004669 /* Drop unexpected ApplicationData records,
4670 * except at the beginning of renegotiations */
4671 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4672 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4673#if defined(MBEDTLS_SSL_RENEGOTIATION)
4674 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4675 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004676#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004677 )
4678 {
4679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4680 return( MBEDTLS_ERR_SSL_NON_FATAL );
4681 }
4682
4683 if( ssl->handshake != NULL &&
4684 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4685 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004686 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004687 }
4688 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004689#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004690
Paul Bakker5121ce52009-01-03 21:22:43 +00004691 return( 0 );
4692}
4693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004694int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004695{
irwir6c0da642019-09-26 21:07:41 +03004696 return( mbedtls_ssl_send_alert_message( ssl,
4697 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4698 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004699}
4700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004701int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004702 unsigned char level,
4703 unsigned char message )
4704{
Janos Follath865b3eb2019-12-16 11:46:15 +00004705 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004706
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004707 if( ssl == NULL || ssl->conf == NULL )
4708 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004711 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004714 ssl->out_msglen = 2;
4715 ssl->out_msg[0] = level;
4716 ssl->out_msg[1] = message;
4717
Hanno Becker67bc7c32018-08-06 11:33:50 +01004718 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004720 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004721 return( ret );
4722 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004724
4725 return( 0 );
4726}
4727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004729{
Janos Follath865b3eb2019-12-16 11:46:15 +00004730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004731
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004735 ssl->out_msglen = 1;
4736 ssl->out_msg[0] = 1;
4737
Paul Bakker5121ce52009-01-03 21:22:43 +00004738 ssl->state++;
4739
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004740 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004741 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004742 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004743 return( ret );
4744 }
4745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004747
4748 return( 0 );
4749}
4750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004752{
Janos Follath865b3eb2019-12-16 11:46:15 +00004753 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004754
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004756
Hanno Becker327c93b2018-08-15 13:56:18 +01004757 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004760 return( ret );
4761 }
4762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004766 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4767 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004769 }
4770
Hanno Beckere678eaa2018-08-21 14:57:46 +01004771 /* CCS records are only accepted if they have length 1 and content '1',
4772 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004773
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004774 /*
4775 * Switch to our negotiated transform and session parameters for inbound
4776 * data.
4777 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004779 ssl->transform_in = ssl->transform_negotiate;
4780 ssl->session_in = ssl->session_negotiate;
4781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004783 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004784 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004786 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004787#endif
4788
4789 /* Increment epoch */
4790 if( ++ssl->in_epoch == 0 )
4791 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004793 /* This is highly unlikely to happen for legitimate reasons, so
4794 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004796 }
4797 }
4798 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004800 memset( ssl->in_ctr, 0, 8 );
4801
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004802 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004803
Paul Bakker5121ce52009-01-03 21:22:43 +00004804 ssl->state++;
4805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004807
4808 return( 0 );
4809}
4810
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004811/* Once ssl->out_hdr as the address of the beginning of the
4812 * next outgoing record is set, deduce the other pointers.
4813 *
4814 * Note: For TLS, we save the implicit record sequence number
4815 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4816 * and the caller has to make sure there's space for this.
4817 */
4818
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004819static size_t ssl_transform_get_explicit_iv_len(
4820 mbedtls_ssl_transform const *transform )
4821{
TRodziewiczef73f012021-05-13 14:53:36 +02004822 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004823 return( 0 );
4824
4825 return( transform->ivlen - transform->fixed_ivlen );
4826}
4827
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004828void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4829 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004830{
4831#if defined(MBEDTLS_SSL_PROTO_DTLS)
4832 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4833 {
4834 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004835#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004836 ssl->out_cid = ssl->out_ctr + 8;
4837 ssl->out_len = ssl->out_cid;
4838 if( transform != NULL )
4839 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004840#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004841 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004842#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004843 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004844 }
4845 else
4846#endif
4847 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004848 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004849#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004850 ssl->out_cid = ssl->out_len;
4851#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004852 ssl->out_iv = ssl->out_hdr + 5;
4853 }
4854
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004855 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004856 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004857 if( transform != NULL )
4858 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004859}
4860
4861/* Once ssl->in_hdr as the address of the beginning of the
4862 * next incoming record is set, deduce the other pointers.
4863 *
4864 * Note: For TLS, we save the implicit record sequence number
4865 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4866 * and the caller has to make sure there's space for this.
4867 */
4868
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004869void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004870{
Hanno Becker79594fd2019-05-08 09:38:41 +01004871 /* This function sets the pointers to match the case
4872 * of unprotected TLS/DTLS records, with both ssl->in_iv
4873 * and ssl->in_msg pointing to the beginning of the record
4874 * content.
4875 *
4876 * When decrypting a protected record, ssl->in_msg
4877 * will be shifted to point to the beginning of the
4878 * record plaintext.
4879 */
4880
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004881#if defined(MBEDTLS_SSL_PROTO_DTLS)
4882 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4883 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004884 /* This sets the header pointers to match records
4885 * without CID. When we receive a record containing
4886 * a CID, the fields are shifted accordingly in
4887 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004888 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004889#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004890 ssl->in_cid = ssl->in_ctr + 8;
4891 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004892#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004893 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004894#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004895 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004896 }
4897 else
4898#endif
4899 {
4900 ssl->in_ctr = ssl->in_hdr - 8;
4901 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004902#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004903 ssl->in_cid = ssl->in_len;
4904#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004905 ssl->in_iv = ssl->in_hdr + 5;
4906 }
4907
Hanno Becker79594fd2019-05-08 09:38:41 +01004908 /* This will be adjusted at record decryption time. */
4909 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004910}
4911
Paul Bakker5121ce52009-01-03 21:22:43 +00004912/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004913 * Setup an SSL context
4914 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004915
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004916void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004917{
4918 /* Set the incoming and outgoing record pointers. */
4919#if defined(MBEDTLS_SSL_PROTO_DTLS)
4920 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4921 {
4922 ssl->out_hdr = ssl->out_buf;
4923 ssl->in_hdr = ssl->in_buf;
4924 }
4925 else
4926#endif /* MBEDTLS_SSL_PROTO_DTLS */
4927 {
Hanno Becker12078f42021-03-02 15:28:41 +00004928 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004929 ssl->out_hdr = ssl->out_buf + 8;
4930 ssl->in_hdr = ssl->in_buf + 8;
4931 }
4932
4933 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004934 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4935 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004936}
4937
Paul Bakker5121ce52009-01-03 21:22:43 +00004938/*
4939 * SSL get accessors
4940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004941size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004942{
4943 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4944}
4945
Hanno Becker8b170a02017-10-10 11:51:19 +01004946int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4947{
4948 /*
4949 * Case A: We're currently holding back
4950 * a message for further processing.
4951 */
4952
4953 if( ssl->keep_current_message == 1 )
4954 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004955 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004956 return( 1 );
4957 }
4958
4959 /*
4960 * Case B: Further records are pending in the current datagram.
4961 */
4962
4963#if defined(MBEDTLS_SSL_PROTO_DTLS)
4964 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4965 ssl->in_left > ssl->next_record_offset )
4966 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004967 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004968 return( 1 );
4969 }
4970#endif /* MBEDTLS_SSL_PROTO_DTLS */
4971
4972 /*
4973 * Case C: A handshake message is being processed.
4974 */
4975
Hanno Becker8b170a02017-10-10 11:51:19 +01004976 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4977 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004978 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004979 return( 1 );
4980 }
4981
4982 /*
4983 * Case D: An application data message is being processed
4984 */
4985 if( ssl->in_offt != NULL )
4986 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004987 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004988 return( 1 );
4989 }
4990
4991 /*
4992 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004993 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004994 * we implement support for multiple alerts in single records.
4995 */
4996
4997 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4998 return( 0 );
4999}
5000
Paul Bakker43ca69c2011-01-15 17:35:19 +00005001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005002int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005003{
Hanno Becker3136ede2018-08-17 15:28:19 +01005004 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005006 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005007
Hanno Becker5903de42019-05-03 14:46:38 +01005008 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5009
Hanno Becker78640902018-08-13 16:35:15 +01005010 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005011 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005013 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 case MBEDTLS_MODE_GCM:
5016 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005017 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005019 transform_expansion = transform->minlen;
5020 break;
5021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005023
5024 block_size = mbedtls_cipher_get_block_size(
5025 &transform->cipher_ctx_enc );
5026
Hanno Becker3136ede2018-08-17 15:28:19 +01005027 /* Expansion due to the addition of the MAC. */
5028 transform_expansion += transform->maclen;
5029
5030 /* Expansion due to the addition of CBC padding;
5031 * Theoretically up to 256 bytes, but we never use
5032 * more than the block size of the underlying cipher. */
5033 transform_expansion += block_size;
5034
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005035 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005036 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005037#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005038 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005039#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005040
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005041 break;
5042
5043 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005045 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005046 }
5047
Hanno Beckera0e20d02019-05-15 14:03:01 +01005048#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005049 if( transform->out_cid_len != 0 )
5050 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005051#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005052
Hanno Becker5903de42019-05-03 14:46:38 +01005053 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005054}
5055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005056#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005057/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005058 * Check record counters and renegotiate if they're above the limit.
5059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005061{
Hanno Beckerdd772292020-02-05 10:38:31 +00005062 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005063 int in_ctr_cmp;
5064 int out_ctr_cmp;
5065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005066 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5067 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005068 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005069 {
5070 return( 0 );
5071 }
5072
Andres AG2196c7f2016-12-15 17:01:16 +00005073 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5074 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005075 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005076 ssl->conf->renego_period + ep_len, 8 - ep_len );
5077
5078 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005079 {
5080 return( 0 );
5081 }
5082
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005084 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005085}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005087
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005088/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005089 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005090 * may only be sent for the purpose of initiating renegotiations.
5091 *
5092 * This function is introduced as a separate helper since the handling
5093 * of post-handshake handshake messages changes significantly in TLS 1.3,
5094 * and having a helper function allows to distinguish between TLS <= 1.2 and
5095 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5096 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005097static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005098{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005099 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005100
5101 /*
5102 * - For client-side, expect SERVER_HELLO_REQUEST.
5103 * - For server-side, expect CLIENT_HELLO.
5104 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5105 */
5106
5107#if defined(MBEDTLS_SSL_CLI_C)
5108 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5109 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5110 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5111 {
5112 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5113
5114 /* With DTLS, drop the packet (probably from last handshake) */
5115#if defined(MBEDTLS_SSL_PROTO_DTLS)
5116 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5117 {
5118 return( 0 );
5119 }
5120#endif
5121 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5122 }
5123#endif /* MBEDTLS_SSL_CLI_C */
5124
5125#if defined(MBEDTLS_SSL_SRV_C)
5126 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5127 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5128 {
5129 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5130
5131 /* With DTLS, drop the packet (probably from last handshake) */
5132#if defined(MBEDTLS_SSL_PROTO_DTLS)
5133 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5134 {
5135 return( 0 );
5136 }
5137#endif
5138 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5139 }
5140#endif /* MBEDTLS_SSL_SRV_C */
5141
5142#if defined(MBEDTLS_SSL_RENEGOTIATION)
5143 /* Determine whether renegotiation attempt should be accepted */
5144 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5145 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5146 ssl->conf->allow_legacy_renegotiation ==
5147 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5148 {
5149 /*
5150 * Accept renegotiation request
5151 */
5152
5153 /* DTLS clients need to know renego is server-initiated */
5154#if defined(MBEDTLS_SSL_PROTO_DTLS)
5155 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5156 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5157 {
5158 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5159 }
5160#endif
5161 ret = mbedtls_ssl_start_renegotiation( ssl );
5162 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5163 ret != 0 )
5164 {
5165 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5166 ret );
5167 return( ret );
5168 }
5169 }
5170 else
5171#endif /* MBEDTLS_SSL_RENEGOTIATION */
5172 {
5173 /*
5174 * Refuse renegotiation
5175 */
5176
5177 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5178
TRodziewicz0f82ec62021-05-12 17:49:18 +02005179#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005180 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5181 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5182 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005183 {
TRodziewicz345165c2021-07-06 13:42:11 +02005184 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005185 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005186#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005187 }
5188
5189 return( 0 );
5190}
5191
Paul Bakker48916f92012-09-16 19:57:18 +00005192/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005193 * Receive application data decrypted from the SSL layer
5194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005195int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005196{
Janos Follath865b3eb2019-12-16 11:46:15 +00005197 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005198 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005199
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005200 if( ssl == NULL || ssl->conf == NULL )
5201 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005206 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005207 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005208 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005209 return( ret );
5210
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005211 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005213 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005214 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005215 return( ret );
5216 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005217 }
5218#endif
5219
Hanno Becker4a810fb2017-05-24 16:27:30 +01005220 /*
5221 * Check if renegotiation is necessary and/or handshake is
5222 * in process. If yes, perform/continue, and fall through
5223 * if an unexpected packet is received while the client
5224 * is waiting for the ServerHello.
5225 *
5226 * (There is no equivalent to the last condition on
5227 * the server-side as it is not treated as within
5228 * a handshake while waiting for the ClientHello
5229 * after a renegotiation request.)
5230 */
5231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005232#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005233 ret = ssl_check_ctr_renegotiate( ssl );
5234 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5235 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005236 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005237 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005238 return( ret );
5239 }
5240#endif
5241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005243 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005244 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005245 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5246 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005247 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005248 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005249 return( ret );
5250 }
5251 }
5252
Hanno Beckere41158b2017-10-23 13:30:32 +01005253 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005254 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005255 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005256 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005257 if( ssl->f_get_timer != NULL &&
5258 ssl->f_get_timer( ssl->p_timer ) == -1 )
5259 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005260 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005261 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005262
Hanno Becker327c93b2018-08-15 13:56:18 +01005263 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005264 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005265 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5266 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005267
Hanno Becker4a810fb2017-05-24 16:27:30 +01005268 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5269 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005270 }
5271
5272 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005273 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005274 {
5275 /*
5276 * OpenSSL sends empty messages to randomize the IV
5277 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005278 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005279 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005280 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005281 return( 0 );
5282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005283 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005284 return( ret );
5285 }
5286 }
5287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005289 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005290 ret = ssl_handle_hs_message_post_handshake( ssl );
5291 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005292 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005293 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5294 ret );
5295 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005296 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005297
Hanno Beckerf26cc722021-04-21 07:30:13 +01005298 /* At this point, we don't know whether the renegotiation triggered
5299 * by the post-handshake message has been completed or not. The cases
5300 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005301 * 1) The renegotiation is complete. In this case, no new record
5302 * has been read yet.
5303 * 2) The renegotiation is incomplete because the client received
5304 * an application data record while awaiting the ServerHello.
5305 * 3) The renegotiation is incomplete because the client received
5306 * a non-handshake, non-application data message while awaiting
5307 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005308 *
5309 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005310 * - For 1), the next iteration will read a new record and check
5311 * if it's application data.
5312 * - For 2), the loop condition isn't satisfied as application data
5313 * is present, hence continue is the same as break
5314 * - For 3), the loop condition is satisfied and read_record
5315 * will re-deliver the message that was held back by the client
5316 * when expecting the ServerHello.
5317 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005318
Hanno Becker90333da2017-10-10 11:27:13 +01005319 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005320 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005321#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005322 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005323 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005324 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005325 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005326 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005329 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005331 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005332 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005333 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5337 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005340 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005341 }
5342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5346 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005347 }
5348
5349 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005350
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005351 /* We're going to return something now, cancel timer,
5352 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005354 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005355
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005356#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005357 /* If we requested renego but received AppData, resend HelloRequest.
5358 * Do it now, after setting in_offt, to avoid taking this branch
5359 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005361 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005363 {
Hanno Becker786300f2020-02-05 10:46:40 +00005364 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005365 {
Hanno Becker786300f2020-02-05 10:46:40 +00005366 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5367 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005368 return( ret );
5369 }
5370 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005372#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005373 }
5374
5375 n = ( len < ssl->in_msglen )
5376 ? len : ssl->in_msglen;
5377
5378 memcpy( buf, ssl->in_offt, n );
5379 ssl->in_msglen -= n;
5380
gabor-mezei-arma3214132020-07-15 10:55:00 +02005381 /* Zeroising the plaintext buffer to erase unused application data
5382 from the memory. */
5383 mbedtls_platform_zeroize( ssl->in_offt, n );
5384
Paul Bakker5121ce52009-01-03 21:22:43 +00005385 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005386 {
5387 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005388 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005389 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005390 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005391 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005392 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005393 /* more data available */
5394 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005395 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005396
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005397 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005398
Paul Bakker23986e52011-04-24 08:57:21 +00005399 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005400}
5401
5402/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005403 * Send application data to be encrypted by the SSL layer, taking care of max
5404 * fragment length and buffer size.
5405 *
5406 * According to RFC 5246 Section 6.2.1:
5407 *
5408 * Zero-length fragments of Application data MAY be sent as they are
5409 * potentially useful as a traffic analysis countermeasure.
5410 *
5411 * Therefore, it is possible that the input message length is 0 and the
5412 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005413 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005414static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005415 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005416{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005417 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5418 const size_t max_len = (size_t) ret;
5419
5420 if( ret < 0 )
5421 {
5422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5423 return( ret );
5424 }
5425
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005426 if( len > max_len )
5427 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005429 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005430 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005432 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5433 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005434 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005436 }
5437 else
5438#endif
5439 len = max_len;
5440 }
Paul Bakker887bd502011-06-08 13:10:54 +00005441
Paul Bakker5121ce52009-01-03 21:22:43 +00005442 if( ssl->out_left != 0 )
5443 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005444 /*
5445 * The user has previously tried to send the data and
5446 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5447 * written. In this case, we expect the high-level write function
5448 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005451 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005453 return( ret );
5454 }
5455 }
Paul Bakker887bd502011-06-08 13:10:54 +00005456 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005457 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005458 /*
5459 * The user is trying to send a message the first time, so we need to
5460 * copy the data into the internal buffers and setup the data structure
5461 * to keep track of partial writes
5462 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005463 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005465 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005466
Hanno Becker67bc7c32018-08-06 11:33:50 +01005467 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005468 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005469 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005470 return( ret );
5471 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005472 }
5473
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005474 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005475}
5476
5477/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005478 * Write application data (public-facing wrapper)
5479 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005480int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005481{
Janos Follath865b3eb2019-12-16 11:46:15 +00005482 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005483
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005485
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005486 if( ssl == NULL || ssl->conf == NULL )
5487 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5488
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005489#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005490 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5491 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005492 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005493 return( ret );
5494 }
5495#endif
5496
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005497 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005498 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005499 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005500 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005501 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005502 return( ret );
5503 }
5504 }
5505
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005506 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005507
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005509
5510 return( ret );
5511}
5512
5513/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005514 * Notify the peer that the connection is being closed
5515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005517{
Janos Follath865b3eb2019-12-16 11:46:15 +00005518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005519
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005520 if( ssl == NULL || ssl->conf == NULL )
5521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005524
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005525 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005529 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5531 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5532 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005533 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005534 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005535 return( ret );
5536 }
5537 }
5538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005540
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005541 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005542}
5543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005544void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005545{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005546 if( transform == NULL )
5547 return;
5548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5550 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005551
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005552#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005553 mbedtls_md_free( &transform->md_ctx_enc );
5554 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005555#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005556
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005557 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005558}
5559
Hanno Becker0271f962018-08-16 13:23:47 +01005560#if defined(MBEDTLS_SSL_PROTO_DTLS)
5561
Hanno Becker533ab5f2020-02-05 10:49:13 +00005562void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005563{
5564 unsigned offset;
5565 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5566
5567 if( hs == NULL )
5568 return;
5569
Hanno Becker283f5ef2018-08-24 09:34:47 +01005570 ssl_free_buffered_record( ssl );
5571
Hanno Becker0271f962018-08-16 13:23:47 +01005572 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005573 ssl_buffering_free_slot( ssl, offset );
5574}
5575
5576static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5577 uint8_t slot )
5578{
5579 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5580 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005581
5582 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5583 return;
5584
Hanno Beckere605b192018-08-21 15:59:07 +01005585 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005586 {
Hanno Beckere605b192018-08-21 15:59:07 +01005587 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005588 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005589 mbedtls_free( hs_buf->data );
5590 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005591 }
5592}
5593
5594#endif /* MBEDTLS_SSL_PROTO_DTLS */
5595
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005596/*
5597 * Convert version numbers to/from wire format
5598 * and, for DTLS, to/from TLS equivalent.
5599 *
5600 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005601 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005602 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005604void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005605 unsigned char ver[2] )
5606{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607#if defined(MBEDTLS_SSL_PROTO_DTLS)
5608 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005609 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005610 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005611 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5612
5613 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5614 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5615 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005616 else
5617#else
5618 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005619#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005620 {
5621 ver[0] = (unsigned char) major;
5622 ver[1] = (unsigned char) minor;
5623 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005624}
5625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005626void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005627 const unsigned char ver[2] )
5628{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005629#if defined(MBEDTLS_SSL_PROTO_DTLS)
5630 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005631 {
5632 *major = 255 - ver[0] + 2;
5633 *minor = 255 - ver[1] + 1;
5634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005636 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5637 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005638 else
5639#else
5640 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005641#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005642 {
5643 *major = ver[0];
5644 *minor = ver[1];
5645 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005646}
5647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005648#endif /* MBEDTLS_SSL_TLS_C */