blob: 8c9caa9ef5f2d7f2048a5ae8b485fc69483538fb [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
Hanno Becker54229812019-07-12 14:40:00 +010089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
Hanno Beckercfe45792019-07-03 16:13:00 +010094int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
Hanno Becker54229812019-07-12 14:40:00 +010098 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +010099 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
103 * (a) there doesn't seem to be a usecase for it, and
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100104 * (b) In TLS 1.0, CBC record decryption has state
Hanno Becker54229812019-07-12 14:40:00 +0100105 * and we'd need to backup the transform here.
106 */
107 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
108 {
109 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
110 goto exit;
111 }
112#if defined(MBEDTLS_SSL_PROTO_DTLS)
113 else
114 {
irwir734f0cf2019-09-26 21:03:24 +0300115 mbedtls_record rec;
116
Hanno Becker54229812019-07-12 14:40:00 +0100117 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
118 if( ret != 0 )
119 {
120 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
121 goto exit;
122 }
123
124 if( ssl->transform_in != NULL )
125 {
126 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
127 if( ret != 0 )
128 {
129 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
130 goto exit;
131 }
132 }
133 }
134#endif /* MBEDTLS_SSL_PROTO_DTLS */
135
136exit:
137 /* On success, we have decrypted the buffer in-place, so make
138 * sure we don't leak any plaintext data. */
139 mbedtls_platform_zeroize( buf, buflen );
140
141 /* For the purpose of this API, treat messages with unexpected CID
142 * as well as such from future epochs as unexpected. */
143 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
144 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
145 {
146 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
147 }
148
149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
150 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100151}
Hanno Beckercfe45792019-07-03 16:13:00 +0100152
Hanno Becker67bc7c32018-08-06 11:33:50 +0100153#define SSL_DONT_FORCE_FLUSH 0
154#define SSL_FORCE_FLUSH 1
155
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200156#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100157
Hanno Beckerd5847772018-08-28 10:09:23 +0100158/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100159static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
160 uint8_t slot );
161static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
163static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
164static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100165static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
166 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100167static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100168
Hanno Becker11682cc2018-08-22 14:41:02 +0100169static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100170{
Hanno Becker89490712020-02-05 10:50:12 +0000171 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000172#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
173 size_t out_buf_len = ssl->out_buf_len;
174#else
175 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
176#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100177
Darryl Greenb33cc762019-11-28 14:29:44 +0000178 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100179 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180
Darryl Greenb33cc762019-11-28 14:29:44 +0000181 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100182}
183
Hanno Becker67bc7c32018-08-06 11:33:50 +0100184static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
185{
Hanno Becker11682cc2018-08-22 14:41:02 +0100186 size_t const bytes_written = ssl->out_left;
187 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100188
189 /* Double-check that the write-index hasn't gone
190 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100191 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100192 {
193 /* Should never happen... */
194 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
195 }
196
197 return( (int) ( mtu - bytes_written ) );
198}
199
200static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
201{
Janos Follath865b3eb2019-12-16 11:46:15 +0000202 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400204 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100205
206#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400207 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100208
209 if( max_len > mfl )
210 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100211
212 /* By the standard (RFC 6066 Sect. 4), the MFL extension
213 * only limits the maximum record payload size, so in theory
214 * we would be allowed to pack multiple records of payload size
215 * MFL into a single datagram. However, this would mean that there's
216 * no way to explicitly communicate MTU restrictions to the peer.
217 *
218 * The following reduction of max_len makes sure that we never
219 * write datagrams larger than MFL + Record Expansion Overhead.
220 */
221 if( max_len <= ssl->out_left )
222 return( 0 );
223
224 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100225#endif
226
227 ret = ssl_get_remaining_space_in_datagram( ssl );
228 if( ret < 0 )
229 return( ret );
230 remaining = (size_t) ret;
231
232 ret = mbedtls_ssl_get_record_expansion( ssl );
233 if( ret < 0 )
234 return( ret );
235 expansion = (size_t) ret;
236
237 if( remaining <= expansion )
238 return( 0 );
239
240 remaining -= expansion;
241 if( remaining >= max_len )
242 remaining = max_len;
243
244 return( (int) remaining );
245}
246
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200247/*
248 * Double the retransmit timeout value, within the allowed range,
249 * returning -1 if the maximum value has already been reached.
250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200252{
253 uint32_t new_timeout;
254
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200255 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200256 return( -1 );
257
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200258 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
259 * in the following way: after the initial transmission and a first
260 * retransmission, back off to a temporary estimated MTU of 508 bytes.
261 * This value is guaranteed to be deliverable (if not guaranteed to be
262 * delivered) of any compliant IPv4 (and IPv6) network, and should work
263 * on most non-IP stacks too. */
264 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200266 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400267 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
268 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200269
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200270 new_timeout = 2 * ssl->handshake->retransmit_timeout;
271
272 /* Avoid arithmetic overflow and range overflow */
273 if( new_timeout < ssl->handshake->retransmit_timeout ||
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 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200276 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200277 }
278
279 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000280 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
281 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200282
283 return( 0 );
284}
285
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200287{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200288 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000289 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
290 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200293
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100294/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000295 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200296 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000297
Hanno Beckerccc13d02020-05-04 12:30:04 +0100298#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
299 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100300
301static size_t ssl_compute_padding_length( size_t len,
302 size_t granularity )
303{
304 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
305}
306
Hanno Becker581bc1b2020-05-04 12:20:03 +0100307/* This functions transforms a (D)TLS plaintext fragment and a record content
308 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
309 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
310 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100311 *
312 * struct {
313 * opaque content[DTLSPlaintext.length];
314 * ContentType real_type;
315 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100316 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100317 *
318 * Input:
319 * - `content`: The beginning of the buffer holding the
320 * plaintext to be wrapped.
321 * - `*content_size`: The length of the plaintext in Bytes.
322 * - `max_len`: The number of Bytes available starting from
323 * `content`. This must be `>= *content_size`.
324 * - `rec_type`: The desired record content type.
325 *
326 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100327 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
328 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100329 *
330 * Returns:
331 * - `0` on success.
332 * - A negative error code if `max_len` didn't offer enough space
333 * for the expansion.
334 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100335static int ssl_build_inner_plaintext( unsigned char *content,
336 size_t *content_size,
337 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100338 uint8_t rec_type,
339 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100340{
341 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100342
343 /* Write real content type */
344 if( remaining == 0 )
345 return( -1 );
346 content[ len ] = rec_type;
347 len++;
348 remaining--;
349
350 if( remaining < pad )
351 return( -1 );
352 memset( content + len, 0, pad );
353 len += pad;
354 remaining -= pad;
355
356 *content_size = len;
357 return( 0 );
358}
359
Hanno Becker581bc1b2020-05-04 12:20:03 +0100360/* This function parses a (D)TLSInnerPlaintext structure.
361 * See ssl_build_inner_plaintext() for details. */
362static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363 size_t *content_size,
364 uint8_t *rec_type )
365{
366 size_t remaining = *content_size;
367
368 /* Determine length of padding by skipping zeroes from the back. */
369 do
370 {
371 if( remaining == 0 )
372 return( -1 );
373 remaining--;
374 } while( content[ remaining ] == 0 );
375
376 *content_size = remaining;
377 *rec_type = content[ remaining ];
378
379 return( 0 );
380}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100381#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
382 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100383
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100384/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100385 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000386static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100387 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100388 mbedtls_record *rec,
389 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000390{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100391 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100392 *
393 * additional_data = seq_num + TLSCompressed.type +
394 * TLSCompressed.version + TLSCompressed.length;
395 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100396 * For the CID extension, this is extended as follows
397 * (quoting draft-ietf-tls-dtls-connection-id-05,
398 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100399 *
400 * additional_data = seq_num + DTLSPlaintext.type +
401 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100402 * cid +
403 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100404 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100405 *
406 * For TLS 1.3, the record sequence number is dropped from the AAD
407 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 */
409
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100410 unsigned char *cur = add_data;
411
412#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
413 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
414#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
415 {
416 ((void) minor_ver);
417 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
418 cur += sizeof( rec->ctr );
419 }
420
421 *cur = rec->type;
422 cur++;
423
424 memcpy( cur, rec->ver, sizeof( rec->ver ) );
425 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100426
Hanno Beckera0e20d02019-05-15 14:03:01 +0100427#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100428 if( rec->cid_len != 0 )
429 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100430 memcpy( cur, rec->cid, rec->cid_len );
431 cur += rec->cid_len;
432
433 *cur = rec->cid_len;
434 cur++;
435
436 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
437 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
438 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100439 }
440 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100441#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100442 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100443 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
444 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
445 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100446 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100447
448 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000449}
450
Hanno Becker67a37db2020-05-28 16:27:07 +0100451#if defined(MBEDTLS_GCM_C) || \
452 defined(MBEDTLS_CCM_C) || \
453 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100454static int ssl_transform_aead_dynamic_iv_is_explicit(
455 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100456{
Hanno Becker17263802020-05-28 07:05:48 +0100457 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100458}
459
Hanno Becker17263802020-05-28 07:05:48 +0100460/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
461 *
462 * Concretely, this occurs in two variants:
463 *
464 * a) Fixed and dynamic IV lengths add up to total IV length, giving
465 * IV = fixed_iv || dynamic_iv
466 *
Hanno Becker15952812020-06-04 13:31:46 +0100467 * This variant is used in TLS 1.2 when used with GCM or CCM.
468 *
Hanno Becker17263802020-05-28 07:05:48 +0100469 * b) Fixed IV lengths matches total IV length, giving
470 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100471 *
472 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
473 *
474 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100475 *
476 * This function has the precondition that
477 *
478 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
479 *
480 * which has to be ensured by the caller. If this precondition
481 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100482 */
483static void ssl_build_record_nonce( unsigned char *dst_iv,
484 size_t dst_iv_len,
485 unsigned char const *fixed_iv,
486 size_t fixed_iv_len,
487 unsigned char const *dynamic_iv,
488 size_t dynamic_iv_len )
489{
490 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100491
492 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100493 memset( dst_iv, 0, dst_iv_len );
494 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100495
Hanno Becker17263802020-05-28 07:05:48 +0100496 dst_iv += dst_iv_len - dynamic_iv_len;
497 for( i = 0; i < dynamic_iv_len; i++ )
498 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100499}
Hanno Becker67a37db2020-05-28 16:27:07 +0100500#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100501
Hanno Beckera18d1322018-01-03 14:27:32 +0000502int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
503 mbedtls_ssl_transform *transform,
504 mbedtls_record *rec,
505 int (*f_rng)(void *, unsigned char *, size_t),
506 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000507{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100509 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000510 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100511 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100512 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000513 size_t post_avail;
514
515 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000516#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200517 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000518 ((void) ssl);
519#endif
520
521 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200522 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200523#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200524 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000525 ((void) f_rng);
526 ((void) p_rng);
527#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000530
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000531 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100532 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
534 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
535 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100536 if( rec == NULL
537 || rec->buf == NULL
538 || rec->buf_len < rec->data_offset
539 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100540#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100541 || rec->cid_len != 0
542#endif
543 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 {
545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100547 }
548
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000549 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100550 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 data, rec->data_len );
553
554 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
555
556 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
557 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000558 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
559 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000560 rec->data_len,
561 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000562 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
563 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100564
Hanno Becker92313402020-05-20 13:58:58 +0100565 /* The following two code paths implement the (D)TLSInnerPlaintext
566 * structure present in TLS 1.3 and DTLS 1.2 + CID.
567 *
568 * See ssl_build_inner_plaintext() for more information.
569 *
570 * Note that this changes `rec->data_len`, and hence
571 * `post_avail` needs to be recalculated afterwards.
572 *
573 * Note also that the two code paths cannot occur simultaneously
574 * since they apply to different versions of the protocol. There
575 * is hence no risk of double-addition of the inner plaintext.
576 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100577#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
578 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
579 {
Hanno Becker13996922020-05-28 16:15:19 +0100580 size_t padding =
581 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100582 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100583 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100584 &rec->data_len,
585 post_avail,
586 rec->type,
587 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100588 {
589 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
590 }
591
592 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
593 }
594#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
595
Hanno Beckera0e20d02019-05-15 14:03:01 +0100596#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100597 /*
598 * Add CID information
599 */
600 rec->cid_len = transform->out_cid_len;
601 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
602 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100603
604 if( rec->cid_len != 0 )
605 {
Hanno Becker13996922020-05-28 16:15:19 +0100606 size_t padding =
607 ssl_compute_padding_length( rec->data_len,
608 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100609 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100610 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100611 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100612 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100613 * Note that this changes `rec->data_len`, and hence
614 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100615 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100616 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100617 &rec->data_len,
618 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100619 rec->type,
620 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100621 {
622 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
623 }
624
625 rec->type = MBEDTLS_SSL_MSG_CID;
626 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100627#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100628
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100629 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
630
Paul Bakker5121ce52009-01-03 21:22:43 +0000631 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100632 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000633 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000634#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 if( mode == MBEDTLS_MODE_STREAM ||
636 ( mode == MBEDTLS_MODE_CBC
637#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000638 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100639#endif
640 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000641 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000642 if( post_avail < transform->maclen )
643 {
644 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
645 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
646 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200647#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000648 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200649 {
Hanno Becker992b6872017-11-09 18:57:39 +0000650 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
651
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100652 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
653 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000654
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000655 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100656 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 mbedtls_md_hmac_update( &transform->md_ctx_enc,
658 data, rec->data_len );
659 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
660 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
661
662 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663 }
664 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200665#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200666 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
668 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200669 }
670
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000671 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
672 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200673
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000674 rec->data_len += transform->maclen;
675 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100676 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200677 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000678#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000679
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200680 /*
681 * Encrypt
682 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000683#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000685 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000686 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000687 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000688 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000689 "including %d bytes of padding",
690 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000691
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000692 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
693 transform->iv_enc, transform->ivlen,
694 data, rec->data_len,
695 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200696 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200697 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200698 return( ret );
699 }
700
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000701 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200702 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
704 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200705 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000706 }
Paul Bakker68884e32013-01-07 18:20:04 +0100707 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000708#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000709
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200710#if defined(MBEDTLS_GCM_C) || \
711 defined(MBEDTLS_CCM_C) || \
712 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200714 mode == MBEDTLS_MODE_CCM ||
715 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000716 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200718 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100719 unsigned char *dynamic_iv;
720 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100721 int dynamic_iv_is_explicit =
722 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000723
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100724 /* Check that there's space for the authentication tag. */
725 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 {
727 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
728 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
729 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000730
Paul Bakker68884e32013-01-07 18:20:04 +0100731 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100732 * Build nonce for AEAD encryption.
733 *
734 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
735 * part of the IV is prepended to the ciphertext and
736 * can be chosen freely - in particular, it need not
737 * agree with the record sequence number.
738 * However, since ChaChaPoly as well as all AEAD modes
739 * in TLS 1.3 use the record sequence number as the
740 * dynamic part of the nonce, we uniformly use the
741 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100742 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100743 dynamic_iv = rec->ctr;
744 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200745
Hanno Becker17263802020-05-28 07:05:48 +0100746 ssl_build_record_nonce( iv, sizeof( iv ),
747 transform->iv_enc,
748 transform->fixed_ivlen,
749 dynamic_iv,
750 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100751
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100752 /*
753 * Build additional data for AEAD encryption.
754 * This depends on the TLS version.
755 */
756 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
757 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100758
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200759 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100760 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200761 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100762 dynamic_iv,
763 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000764 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100765 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200767 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000769
Paul Bakker68884e32013-01-07 18:20:04 +0100770 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200771 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200772 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000773
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100774 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000775 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100776 add_data, add_data_len,
777 data, rec->data_len, /* src */
778 data, rec->buf_len - (data - rec->buf), /* dst */
779 &rec->data_len,
780 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200781 {
TRodziewicz18efb732021-04-29 23:12:19 +0200782 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200783 return( ret );
784 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000785 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100786 data + rec->data_len - transform->taglen,
787 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100788 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100790
791 /*
792 * Prefix record content with dynamic IV in case it is explicit.
793 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100794 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100795 {
796 if( rec->data_offset < dynamic_iv_len )
797 {
798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
799 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
800 }
801
802 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
803 rec->data_offset -= dynamic_iv_len;
804 rec->data_len += dynamic_iv_len;
805 }
806
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100807 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000808 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000809 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100810#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200811#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000813 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000815 size_t padlen, i;
816 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000817
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 /* Currently we're always using minimal padding
819 * (up to 255 bytes would be allowed). */
820 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
821 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000822 padlen = 0;
823
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 /* Check there's enough space in the buffer for the padding. */
825 if( post_avail < padlen + 1 )
826 {
827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
828 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
829 }
830
Paul Bakker5121ce52009-01-03 21:22:43 +0000831 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000833
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000834 rec->data_len += padlen + 1;
835 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000836
TRodziewicz0f82ec62021-05-12 17:49:18 +0200837#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000838 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +0200839 * Prepend per-record IV for block cipher in TLS v1.2
Paul Bakker1ef83d62012-04-11 12:09:53 +0000840 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000841 */
TRodziewicz0f82ec62021-05-12 17:49:18 +0200842 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_3 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000843 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 if( f_rng == NULL )
845 {
846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
847 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
848 }
849
850 if( rec->data_offset < transform->ivlen )
851 {
852 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
853 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
854 }
855
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000856 /*
857 * Generate IV
858 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000859 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000860 if( ret != 0 )
861 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000862
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 memcpy( data - transform->ivlen, transform->iv_enc,
864 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000865
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000866 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200867#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000868
Paul Elliottd48d5c62021-01-07 14:47:05 +0000869 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
870 "including %" MBEDTLS_PRINTF_SIZET
871 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000872 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200873 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000874
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
876 transform->iv_enc,
877 transform->ivlen,
878 data, rec->data_len,
879 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200882 return( ret );
883 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200884
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000885 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200886 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
888 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200889 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200890
TRodziewicz0f82ec62021-05-12 17:49:18 +0200891 data -= transform->ivlen;
892 rec->data_offset -= transform->ivlen;
893 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100896 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100897 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000898 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
899
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100900 /*
901 * MAC(MAC_write_key, seq_num +
902 * TLSCipherText.type +
903 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100904 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100905 * IV + // except for TLS 1.0
906 * ENC(content + padding + padding_length));
907 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000908
909 if( post_avail < transform->maclen)
910 {
911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
912 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
913 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100914
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100915 ssl_extract_add_data_from_record( add_data, &add_data_len,
916 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100920 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100921
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100923 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000924 mbedtls_md_hmac_update( &transform->md_ctx_enc,
925 data, rec->data_len );
926 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
927 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100928
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000929 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100930
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000931 rec->data_len += transform->maclen;
932 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100933 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100934 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000936 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200937 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200938#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200939 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
941 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200942 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000943
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100944 /* Make extra sure authentication was performed, exactly once */
945 if( auth_done != 1 )
946 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
948 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100949 }
950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
953 return( 0 );
954}
955
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200956#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +0200957/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200958 * Turn a bit into a mask:
959 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
960 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200961 *
962 * This function can be used to write constant-time code by replacing branches
963 * with bit operations using masks.
964 *
965 * This function is implemented without using comparison operators, as those
966 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200967 */
968static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
969{
970 /* MSVC has a warning about unary minus on unsigned integer types,
971 * but this is well-defined and precisely what we want to do here. */
972#if defined(_MSC_VER)
973#pragma warning( push )
974#pragma warning( disable : 4146 )
975#endif
976 return -bit;
977#if defined(_MSC_VER)
978#pragma warning( pop )
979#endif
980}
981
982/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200983 * Constant-flow mask generation for "less than" comparison:
984 * - if x < y, return all bits 1, that is (size_t) -1
985 * - otherwise, return all bits 0, that is 0
986 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200987 * This function can be used to write constant-time code by replacing branches
988 * with bit operations using masks.
989 *
990 * This function is implemented without using comparison operators, as those
991 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200992 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +0200993static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200994{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200995 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200996 const size_t sub = x - y;
997
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +0200998 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +0200999 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1000
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001001 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001002 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001003
1004 return( mask );
1005}
1006
1007/*
1008 * Constant-flow mask generation for "greater or equal" comparison:
1009 * - if x >= y, return all bits 1, that is (size_t) -1
1010 * - otherwise, return all bits 0, that is 0
1011 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001012 * This function can be used to write constant-time code by replacing branches
1013 * with bit operations using masks.
1014 *
1015 * This function is implemented without using comparison operators, as those
1016 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001017 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001018static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001019{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001020 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001021}
1022
1023/*
1024 * Constant-flow boolean "equal" comparison:
1025 * return x == y
1026 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001027 * This function can be used to write constant-time code by replacing branches
1028 * with bit operations - it can be used in conjunction with
1029 * mbedtls_ssl_cf_mask_from_bit().
1030 *
1031 * This function is implemented without using comparison operators, as those
1032 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001033 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001034static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001035{
1036 /* diff = 0 if x == y, non-zero otherwise */
1037 const size_t diff = x ^ y;
1038
1039 /* MSVC has a warning about unary minus on unsigned integer types,
1040 * but this is well-defined and precisely what we want to do here. */
1041#if defined(_MSC_VER)
1042#pragma warning( push )
1043#pragma warning( disable : 4146 )
1044#endif
1045
1046 /* diff_msb's most significant bit is equal to x != y */
1047 const size_t diff_msb = ( diff | -diff );
1048
1049#if defined(_MSC_VER)
1050#pragma warning( pop )
1051#endif
1052
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001053 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001054 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1055
1056 return( 1 ^ diff1 );
1057}
1058
1059/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001060 * Constant-flow conditional memcpy:
1061 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1062 * - otherwise, a no-op,
1063 * but with execution flow independent of the values of c1 and c2.
1064 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001065 * This function is implemented without using comparison operators, as those
1066 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001067 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001068static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1069 const unsigned char *src,
1070 size_t len,
1071 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001072{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001073 /* mask = c1 == c2 ? 0xff : 0x00 */
1074 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001075 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001076
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001077 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001078 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001079 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001080}
1081
1082/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001083 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001084 *
1085 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1086 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001087 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001088MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001089 mbedtls_md_context_t *ctx,
1090 const unsigned char *add_data, size_t add_data_len,
1091 const unsigned char *data, size_t data_len_secret,
1092 size_t min_data_len, size_t max_data_len,
1093 unsigned char *output )
1094{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001095 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001096 * This function breaks the HMAC abstraction and uses the md_clone()
1097 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001098 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001099 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001100 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001101 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001102 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001103 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1104 * minlen, then cloning the context, and for each byte up to maxlen
1105 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001106 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001107 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001108 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001109 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001110 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1111 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001112 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001113 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001114 const unsigned char * const okey = ikey + block_size;
1115 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1118 mbedtls_md_context_t aux;
1119 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001121
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001123
1124#define MD_CHK( func_call ) \
1125 do { \
1126 ret = (func_call); \
1127 if( ret != 0 ) \
1128 goto cleanup; \
1129 } while( 0 )
1130
1131 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001132
1133 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1134 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001135 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1136 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001137
1138 /* For each possible length, compute the hash up to that point */
1139 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001140 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001141 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1142 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001143 /* Keep only the correct inner_hash in the output buffer */
1144 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1145 offset, data_len_secret );
1146
1147 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001148 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001149 }
1150
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001152 MD_CHK( mbedtls_md_starts( ctx ) );
1153 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1154 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1155 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001156
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001157 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001158 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001159
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001160#undef MD_CHK
1161
1162cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001163 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001164 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001165}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001166
1167/*
1168 * Constant-flow memcpy from variable position in buffer.
1169 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001170 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001171 */
1172MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1173 unsigned char *dst,
1174 const unsigned char *src_base,
1175 size_t offset_secret,
1176 size_t offset_min, size_t offset_max,
1177 size_t len )
1178{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001179 size_t offset;
1180
1181 for( offset = offset_min; offset <= offset_max; offset++ )
1182 {
1183 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1184 offset, offset_secret );
1185 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001186}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001187#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001188
Hanno Becker605949f2019-07-12 08:23:59 +01001189int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001190 mbedtls_ssl_transform *transform,
1191 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001192{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001193 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001195 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001196#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001197 size_t padlen = 0, correct = 1;
1198#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001199 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001200 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001201 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001202
Hanno Beckera18d1322018-01-03 14:27:32 +00001203#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001204 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001205 ((void) ssl);
1206#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001209 if( rec == NULL ||
1210 rec->buf == NULL ||
1211 rec->buf_len < rec->data_offset ||
1212 rec->buf_len - rec->data_offset < rec->data_len )
1213 {
1214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001216 }
1217
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001218 data = rec->buf + rec->data_offset;
1219 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001220
Hanno Beckera0e20d02019-05-15 14:03:01 +01001221#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001222 /*
1223 * Match record's CID with incoming CID.
1224 */
Hanno Becker938489a2019-05-08 13:02:22 +01001225 if( rec->cid_len != transform->in_cid_len ||
1226 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1227 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001228 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001229 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001230#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001231
Hanno Beckerd086bf02021-03-22 13:01:27 +00001232#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001234 {
1235 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001236 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1237 transform->iv_dec,
1238 transform->ivlen,
1239 data, rec->data_len,
1240 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001241 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001243 return( ret );
1244 }
1245
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001247 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1249 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001250 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001251 }
Paul Bakker68884e32013-01-07 18:20:04 +01001252 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001253#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001254#if defined(MBEDTLS_GCM_C) || \
1255 defined(MBEDTLS_CCM_C) || \
1256 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001258 mode == MBEDTLS_MODE_CCM ||
1259 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001260 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001261 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001262 unsigned char *dynamic_iv;
1263 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001264
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001265 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001266 * Extract dynamic part of nonce for AEAD decryption.
1267 *
1268 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1269 * part of the IV is prepended to the ciphertext and
1270 * can be chosen freely - in particular, it need not
1271 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001272 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001274 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001275 {
1276 if( rec->data_len < dynamic_iv_len )
1277 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1279 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001280 rec->data_len,
1281 dynamic_iv_len ) );
1282 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1283 }
1284 dynamic_iv = data;
1285
1286 data += dynamic_iv_len;
1287 rec->data_offset += dynamic_iv_len;
1288 rec->data_len -= dynamic_iv_len;
1289 }
Hanno Becker17263802020-05-28 07:05:48 +01001290 else
1291 {
1292 dynamic_iv = rec->ctr;
1293 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001294
1295 /* Check that there's space for the authentication tag. */
1296 if( rec->data_len < transform->taglen )
1297 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001298 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1299 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001300 rec->data_len,
1301 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001303 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001304 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001305
Hanno Beckerdf8be222020-05-21 15:30:57 +01001306 /*
1307 * Prepare nonce from dynamic and static parts.
1308 */
Hanno Becker17263802020-05-28 07:05:48 +01001309 ssl_build_record_nonce( iv, sizeof( iv ),
1310 transform->iv_dec,
1311 transform->fixed_ivlen,
1312 dynamic_iv,
1313 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001314
Hanno Beckerdf8be222020-05-21 15:30:57 +01001315 /*
1316 * Build additional data for AEAD encryption.
1317 * This depends on the TLS version.
1318 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001319 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1320 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001321 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001322 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001323
Hanno Beckerd96a6522019-07-10 13:55:25 +01001324 /* Because of the check above, we know that there are
1325 * explicit_iv_len Bytes preceeding data, and taglen
1326 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001327 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001328 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001329
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001330 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001331 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001332 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001333
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001334 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001335 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001336 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001337 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001339 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001340 data, rec->data_len + transform->taglen, /* src */
1341 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001342 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001343 {
TRodziewicz18efb732021-04-29 23:12:19 +02001344 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1347 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001348
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001349 return( ret );
1350 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001351 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001352
Hanno Beckerd96a6522019-07-10 13:55:25 +01001353 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1357 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001358 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001359 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001360 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001362#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001365 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001366
Paul Bakker5121ce52009-01-03 21:22:43 +00001367 /*
Paul Bakker45829992013-01-03 14:52:21 +01001368 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001369 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001370#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1371 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001372 {
1373 /* The ciphertext is prefixed with the CBC IV. */
1374 minlen += transform->ivlen;
1375 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001376#endif
Paul Bakker45829992013-01-03 14:52:21 +01001377
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001378 /* Size considerations:
1379 *
1380 * - The CBC cipher text must not be empty and hence
1381 * at least of size transform->ivlen.
1382 *
1383 * Together with the potential IV-prefix, this explains
1384 * the first of the two checks below.
1385 *
1386 * - The record must contain a MAC, either in plain or
1387 * encrypted, depending on whether Encrypt-then-MAC
1388 * is used or not.
1389 * - If it is, the message contains the IV-prefix,
1390 * the CBC ciphertext, and the MAC.
1391 * - If it is not, the padded plaintext, and hence
1392 * the CBC ciphertext, has at least length maclen + 1
1393 * because there is at least the padding length byte.
1394 *
1395 * As the CBC ciphertext is not empty, both cases give the
1396 * lower bound minlen + maclen + 1 on the record size, which
1397 * we test for in the second check below.
1398 */
1399 if( rec->data_len < minlen + transform->ivlen ||
1400 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001401 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001402 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1403 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1404 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001405 "+ 1 ) ( + expl IV )", rec->data_len,
1406 transform->ivlen,
1407 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001409 }
1410
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001411 /*
1412 * Authenticate before decrypt if enabled
1413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001415 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001416 {
Hanno Becker992b6872017-11-09 18:57:39 +00001417 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001420
Hanno Beckerd96a6522019-07-10 13:55:25 +01001421 /* Update data_len in tandem with add_data.
1422 *
1423 * The subtraction is safe because of the previous check
1424 * data_len >= minlen + maclen + 1.
1425 *
1426 * Afterwards, we know that data + data_len is followed by at
1427 * least maclen Bytes, which justifies the call to
1428 * mbedtls_ssl_safer_memcmp() below.
1429 *
1430 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001431 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001432 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1433 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001434
Hanno Beckerd96a6522019-07-10 13:55:25 +01001435 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001436 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1437 add_data_len );
1438 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1439 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1441 data, rec->data_len );
1442 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1443 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001444
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001445 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1446 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001447 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001448 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001449
Hanno Beckerd96a6522019-07-10 13:55:25 +01001450 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001451 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1452 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001453 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001456 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001457 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001458 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001460
1461 /*
1462 * Check length sanity
1463 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001464
1465 /* We know from above that data_len > minlen >= 0,
1466 * so the following check in particular implies that
1467 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001468 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001469 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1471 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001472 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001474 }
1475
TRodziewicz0f82ec62021-05-12 17:49:18 +02001476#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001477 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001478 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001479 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001480 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_3 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001481 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001482 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001483 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001484
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001485 data += transform->ivlen;
1486 rec->data_offset += transform->ivlen;
1487 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001488 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001489#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001490
Hanno Beckerd96a6522019-07-10 13:55:25 +01001491 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1492
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001493 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1494 transform->iv_dec, transform->ivlen,
1495 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001496 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001498 return( ret );
1499 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001500
Hanno Beckerd96a6522019-07-10 13:55:25 +01001501 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1505 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001506 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001507
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 /* Safe since data_len >= minlen + maclen + 1, so after having
1509 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001510 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1511 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001513
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514 if( auth_done == 1 )
1515 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001516 const size_t mask = mbedtls_ssl_cf_mask_ge(
1517 rec->data_len,
1518 padlen + 1 );
1519 correct &= mask;
1520 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 }
1522 else
Paul Bakker45829992013-01-03 14:52:21 +01001523 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001525 if( rec->data_len < transform->maclen + padlen + 1 )
1526 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001527 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1528 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1529 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001530 rec->data_len,
1531 transform->maclen,
1532 padlen + 1 ) );
1533 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001534#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001536 const size_t mask = mbedtls_ssl_cf_mask_ge(
1537 rec->data_len,
1538 transform->maclen + padlen + 1 );
1539 correct &= mask;
1540 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001541 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001542
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001543 padlen++;
1544
1545 /* Regardless of the validity of the padding,
1546 * we have data_len >= padlen here. */
1547
TRodziewicz0f82ec62021-05-12 17:49:18 +02001548#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001549 /* The padding check involves a series of up to 256
1550 * consecutive memory reads at the end of the record
1551 * plaintext buffer. In order to hide the length and
1552 * validity of the padding, always perform exactly
1553 * `min(256,plaintext_len)` reads (but take into account
1554 * only the last `padlen` bytes for the padding check). */
1555 size_t pad_count = 0;
1556 volatile unsigned char* const check = data;
1557
1558 /* Index of first padding byte; it has been ensured above
1559 * that the subtraction is safe. */
1560 size_t const padding_idx = rec->data_len - padlen;
1561 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1562 size_t const start_idx = rec->data_len - num_checks;
1563 size_t idx;
1564
1565 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001566 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001567 /* pad_count += (idx >= padding_idx) &&
1568 * (check[idx] == padlen - 1);
1569 */
1570 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1571 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1572 padlen - 1 );
1573 pad_count += mask & equal;
1574 }
1575 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001578 if( padlen > 0 && correct == 0 )
1579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001580#endif
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001581 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
1582
TRodziewicz0f82ec62021-05-12 17:49:18 +02001583#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001584
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001585 /* If the padding was found to be invalid, padlen == 0
1586 * and the subtraction is safe. If the padding was found valid,
1587 * padlen hasn't been changed and the previous assertion
1588 * data_len >= padlen still holds. */
1589 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001590 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001591 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001592#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1595 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001596 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001597
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001598#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001600 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001601#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001602
1603 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001604 * Authenticate if not done yet.
1605 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001606 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001607#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001608 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001609 {
Hanno Becker992b6872017-11-09 18:57:39 +00001610 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001611 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001612
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001613 /* If the initial value of padlen was such that
1614 * data_len < maclen + padlen + 1, then padlen
1615 * got reset to 1, and the initial check
1616 * data_len >= minlen + maclen + 1
1617 * guarantees that at this point we still
1618 * have at least data_len >= maclen.
1619 *
1620 * If the initial value of padlen was such that
1621 * data_len >= maclen + padlen + 1, then we have
1622 * subtracted either padlen + 1 (if the padding was correct)
1623 * or 0 (if the padding was incorrect) since then,
1624 * hence data_len >= maclen in any case.
1625 */
1626 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001627 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1628 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001629
TRodziewicz0f82ec62021-05-12 17:49:18 +02001630#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001631 /*
1632 * The next two sizes are the minimum and maximum values of
1633 * data_len over all padlen values.
1634 *
1635 * They're independent of padlen, since we previously did
1636 * data_len -= padlen.
1637 *
1638 * Note that max_len + maclen is never more than the buffer
1639 * length, as we previously did in_msglen -= maclen too.
1640 */
1641 const size_t max_len = rec->data_len + padlen;
1642 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1643
1644 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1645 add_data, add_data_len,
1646 data, rec->data_len, min_len, max_len,
1647 mac_expect );
1648 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001649 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001650 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1651 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001652 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001653
1654 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1655 rec->data_len,
1656 min_len, max_len,
1657 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001658#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001659
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001660#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001661 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001662 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001663#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001664
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001665 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001666 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668#if defined(MBEDTLS_SSL_DEBUG_ALL)
1669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001670#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001671 correct = 0;
1672 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001673 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001674 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001675
1676 /*
1677 * Finally check the correct flag
1678 */
1679 if( correct == 0 )
1680 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001681#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001682
1683 /* Make extra sure authentication was performed, exactly once */
1684 if( auth_done != 1 )
1685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001688 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001689
Hanno Beckerccc13d02020-05-04 12:30:04 +01001690#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1691 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1692 {
1693 /* Remove inner padding and infer true content type. */
1694 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1695 &rec->type );
1696
1697 if( ret != 0 )
1698 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1699 }
1700#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1701
Hanno Beckera0e20d02019-05-15 14:03:01 +01001702#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001703 if( rec->cid_len != 0 )
1704 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001705 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1706 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001707 if( ret != 0 )
1708 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1709 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001710#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001713
1714 return( 0 );
1715}
1716
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001717#undef MAC_NONE
1718#undef MAC_PLAINTEXT
1719#undef MAC_CIPHERTEXT
1720
Paul Bakker5121ce52009-01-03 21:22:43 +00001721/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001722 * Fill the input message buffer by appending data to it.
1723 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001724 *
1725 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1726 * available (from this read and/or a previous one). Otherwise, an error code
1727 * is returned (possibly EOF or WANT_READ).
1728 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001729 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1730 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1731 * since we always read a whole datagram at once.
1732 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001733 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001734 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001737{
Janos Follath865b3eb2019-12-16 11:46:15 +00001738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001739 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001740#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1741 size_t in_buf_len = ssl->in_buf_len;
1742#else
1743 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1744#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001747
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001748 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001751 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001753 }
1754
Darryl Greenb33cc762019-11-28 14:29:44 +00001755 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001756 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1758 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001759 }
1760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001762 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001763 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001764 uint32_t timeout;
1765
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001766 /*
1767 * The point is, we need to always read a full datagram at once, so we
1768 * sometimes read more then requested, and handle the additional data.
1769 * It could be the rest of the current record (while fetching the
1770 * header) and/or some other records in the same datagram.
1771 */
1772
1773 /*
1774 * Move to the next record in the already read datagram if applicable
1775 */
1776 if( ssl->next_record_offset != 0 )
1777 {
1778 if( ssl->in_left < ssl->next_record_offset )
1779 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1781 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001782 }
1783
1784 ssl->in_left -= ssl->next_record_offset;
1785
1786 if( ssl->in_left != 0 )
1787 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1789 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001790 ssl->next_record_offset ) );
1791 memmove( ssl->in_hdr,
1792 ssl->in_hdr + ssl->next_record_offset,
1793 ssl->in_left );
1794 }
1795
1796 ssl->next_record_offset = 0;
1797 }
1798
Paul Elliottd48d5c62021-01-07 14:47:05 +00001799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1800 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001801 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001802
1803 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001804 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001805 */
1806 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001809 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001810 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001811
1812 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001813 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001814 * are not at the beginning of a new record, the caller did something
1815 * wrong.
1816 */
1817 if( ssl->in_left != 0 )
1818 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1820 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001821 }
1822
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001823 /*
1824 * Don't even try to read if time's out already.
1825 * This avoids by-passing the timer when repeatedly receiving messages
1826 * that will end up being dropped.
1827 */
Hanno Becker7876d122020-02-05 10:39:31 +00001828 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001829 {
1830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001831 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001832 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001833 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001834 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001835 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001838 timeout = ssl->handshake->retransmit_timeout;
1839 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001840 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001841
Paul Elliott9f352112020-12-09 14:55:45 +00001842 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001843
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001844 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001845 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1846 timeout );
1847 else
1848 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001851
1852 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001854 }
1855
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001856 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001857 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001859 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001862 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001863 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1864 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001866 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001867 }
1868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001872 return( ret );
1873 }
1874
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001875 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001876 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001878 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001880 {
Hanno Becker786300f2020-02-05 10:46:40 +00001881 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001882 {
Hanno Becker786300f2020-02-05 10:46:40 +00001883 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1884 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001885 return( ret );
1886 }
1887
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001888 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001889 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001891 }
1892
Paul Bakker5121ce52009-01-03 21:22:43 +00001893 if( ret < 0 )
1894 return( ret );
1895
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001896 ssl->in_left = ret;
1897 }
1898 else
1899#endif
1900 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1902 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001903 ssl->in_left, nb_want ) );
1904
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001905 while( ssl->in_left < nb_want )
1906 {
1907 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001908
Hanno Becker7876d122020-02-05 10:39:31 +00001909 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001910 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1911 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001912 {
1913 if( ssl->f_recv_timeout != NULL )
1914 {
1915 ret = ssl->f_recv_timeout( ssl->p_bio,
1916 ssl->in_hdr + ssl->in_left, len,
1917 ssl->conf->read_timeout );
1918 }
1919 else
1920 {
1921 ret = ssl->f_recv( ssl->p_bio,
1922 ssl->in_hdr + ssl->in_left, len );
1923 }
1924 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001925
Paul Elliottd48d5c62021-01-07 14:47:05 +00001926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1927 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001928 ssl->in_left, nb_want ) );
1929 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001930
1931 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
1934 if( ret < 0 )
1935 return( ret );
1936
makise-homuraaf9513b2020-08-24 18:26:27 +03001937 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001938 {
Darryl Green11999bb2018-03-13 15:22:58 +00001939 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001940 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001941 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001942 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1943 }
1944
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001945 ssl->in_left += ret;
1946 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001947 }
1948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001950
1951 return( 0 );
1952}
1953
1954/*
1955 * Flush any data not yet written
1956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001958{
Janos Follath865b3eb2019-12-16 11:46:15 +00001959 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001960 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001963
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001964 if( ssl->f_send == NULL )
1965 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001967 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001969 }
1970
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001971 /* Avoid incrementing counter if data is flushed */
1972 if( ssl->out_left == 0 )
1973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001975 return( 0 );
1976 }
1977
Paul Bakker5121ce52009-01-03 21:22:43 +00001978 while( ssl->out_left > 0 )
1979 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1981 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001982 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001983
Hanno Becker2b1e3542018-08-06 11:19:13 +01001984 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001985 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001988
1989 if( ret <= 0 )
1990 return( ret );
1991
makise-homuraaf9513b2020-08-24 18:26:27 +03001992 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001993 {
Darryl Green11999bb2018-03-13 15:22:58 +00001994 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001995 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001996 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001997 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1998 }
1999
Paul Bakker5121ce52009-01-03 21:22:43 +00002000 ssl->out_left -= ret;
2001 }
2002
Hanno Becker2b1e3542018-08-06 11:19:13 +01002003#if defined(MBEDTLS_SSL_PROTO_DTLS)
2004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002005 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002006 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002007 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002008 else
2009#endif
2010 {
2011 ssl->out_hdr = ssl->out_buf + 8;
2012 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002013 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002016
2017 return( 0 );
2018}
2019
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002020/*
2021 * Functions to handle the DTLS retransmission state machine
2022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002024/*
2025 * Append current handshake message to current outgoing flight
2026 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002028{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2031 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2032 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002033
2034 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002035 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002039 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002040 }
2041
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002042 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002043 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2045 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002047 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048 }
2049
2050 /* Copy current handshake message with headers */
2051 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2052 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002053 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002054 msg->next = NULL;
2055
2056 /* Append to the current flight */
2057 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002058 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002059 else
2060 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062 while( cur->next != NULL )
2063 cur = cur->next;
2064 cur->next = msg;
2065 }
2066
Hanno Becker3b235902018-08-06 09:54:53 +01002067 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002068 return( 0 );
2069}
2070
2071/*
2072 * Free the current flight of handshake messages
2073 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002074void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002075{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076 mbedtls_ssl_flight_item *cur = flight;
2077 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078
2079 while( cur != NULL )
2080 {
2081 next = cur->next;
2082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002083 mbedtls_free( cur->p );
2084 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002085
2086 cur = next;
2087 }
2088}
2089
2090/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002091 * Swap transform_out and out_ctr with the alternative ones
2092 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002093static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002094{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002096 unsigned char tmp_out_ctr[8];
2097
2098 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2099 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002101 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002102 }
2103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002106 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002107 tmp_transform = ssl->transform_out;
2108 ssl->transform_out = ssl->handshake->alt_transform_out;
2109 ssl->handshake->alt_transform_out = tmp_transform;
2110
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002111 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002112 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2113 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002114 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002115
2116 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002117 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002118
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002119 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002120}
2121
2122/*
2123 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002124 */
2125int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2126{
2127 int ret = 0;
2128
2129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2130
2131 ret = mbedtls_ssl_flight_transmit( ssl );
2132
2133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2134
2135 return( ret );
2136}
2137
2138/*
2139 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002140 *
2141 * Need to remember the current message in case flush_output returns
2142 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002143 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002145int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146{
Janos Follath865b3eb2019-12-16 11:46:15 +00002147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002148 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002151 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002153
2154 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002155 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002156 ret = ssl_swap_epochs( ssl );
2157 if( ret != 0 )
2158 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002161 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162
2163 while( ssl->handshake->cur_msg != NULL )
2164 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002165 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002166 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002167
Hanno Beckere1dcb032018-08-17 16:47:58 +01002168 int const is_finished =
2169 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2170 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2171
Hanno Becker04da1892018-08-14 13:22:10 +01002172 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2173 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2174
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002175 /* Swap epochs before sending Finished: we can't do it after
2176 * sending ChangeCipherSpec, in case write returns WANT_READ.
2177 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002178 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002179 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002181 ret = ssl_swap_epochs( ssl );
2182 if( ret != 0 )
2183 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002184 }
2185
Hanno Becker67bc7c32018-08-06 11:33:50 +01002186 ret = ssl_get_remaining_payload_in_datagram( ssl );
2187 if( ret < 0 )
2188 return( ret );
2189 max_frag_len = (size_t) ret;
2190
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002191 /* CCS is copied as is, while HS messages may need fragmentation */
2192 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2193 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002194 if( max_frag_len == 0 )
2195 {
2196 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2197 return( ret );
2198
2199 continue;
2200 }
2201
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002202 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002203 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002204 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002205
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002206 /* Update position inside current message */
2207 ssl->handshake->cur_msg_p += cur->len;
2208 }
2209 else
2210 {
2211 const unsigned char * const p = ssl->handshake->cur_msg_p;
2212 const size_t hs_len = cur->len - 12;
2213 const size_t frag_off = p - ( cur->p + 12 );
2214 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002215 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002216
Hanno Beckere1dcb032018-08-17 16:47:58 +01002217 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002218 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002219 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002220 {
2221 ret = ssl_swap_epochs( ssl );
2222 if( ret != 0 )
2223 return( ret );
2224 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002225
Hanno Becker67bc7c32018-08-06 11:33:50 +01002226 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2227 return( ret );
2228
2229 continue;
2230 }
2231 max_hs_frag_len = max_frag_len - 12;
2232
2233 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2234 max_hs_frag_len : rem_len;
2235
2236 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002237 {
2238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002239 (unsigned) cur_hs_frag_len,
2240 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002241 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002242
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002243 /* Messages are stored with handshake headers as if not fragmented,
2244 * copy beginning of headers then fill fragmentation fields.
2245 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2246 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002247
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002248 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2249 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2250 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2251
Hanno Becker67bc7c32018-08-06 11:33:50 +01002252 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2253 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2254 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002255
2256 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2257
Hanno Becker3f7b9732018-08-28 09:53:25 +01002258 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002259 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2260 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002261 ssl->out_msgtype = cur->type;
2262
2263 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002264 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002265 }
2266
2267 /* If done with the current message move to the next one if any */
2268 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2269 {
2270 if( cur->next != NULL )
2271 {
2272 ssl->handshake->cur_msg = cur->next;
2273 ssl->handshake->cur_msg_p = cur->next->p + 12;
2274 }
2275 else
2276 {
2277 ssl->handshake->cur_msg = NULL;
2278 ssl->handshake->cur_msg_p = NULL;
2279 }
2280 }
2281
2282 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002283 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002286 return( ret );
2287 }
2288 }
2289
Hanno Becker67bc7c32018-08-06 11:33:50 +01002290 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2291 return( ret );
2292
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002293 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002294 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2295 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002296 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002297 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002299 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002300 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002301
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002302 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002303
2304 return( 0 );
2305}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002306
2307/*
2308 * To be called when the last message of an incoming flight is received.
2309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002311{
2312 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002313 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002314 ssl->handshake->flight = NULL;
2315 ssl->handshake->cur_msg = NULL;
2316
2317 /* The next incoming flight will start with this msg_seq */
2318 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2319
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002320 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002321 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002322
Hanno Becker0271f962018-08-16 13:23:47 +01002323 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002324 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002325
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002326 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002327 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2330 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002331 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002333 }
2334 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002336}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002337
2338/*
2339 * To be called when the last message of an outgoing flight is send.
2340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002342{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002343 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002344 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2347 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002350 }
2351 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002353}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002355
Paul Bakker5121ce52009-01-03 21:22:43 +00002356/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002357 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002358 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002359
2360/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002361 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002362 *
2363 * - fill in handshake headers
2364 * - update handshake checksum
2365 * - DTLS: save message for resending
2366 * - then pass to the record layer
2367 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002368 * DTLS: except for HelloRequest, messages are only queued, and will only be
2369 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002370 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002371 * Inputs:
2372 * - ssl->out_msglen: 4 + actual handshake message len
2373 * (4 is the size of handshake headers for TLS)
2374 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2375 * - ssl->out_msg + 4: the handshake message body
2376 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002377 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002378 * - ssl->out_msglen: the length of the record contents
2379 * (including handshake headers but excluding record headers)
2380 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002381 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002382int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002383{
Janos Follath865b3eb2019-12-16 11:46:15 +00002384 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002385 const size_t hs_len = ssl->out_msglen - 4;
2386 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002387
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2389
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002390 /*
2391 * Sanity checks
2392 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002393 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002394 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2395 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2397 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002398 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002399
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002400 /* Whenever we send anything different from a
2401 * HelloRequest we should be in a handshake - double check. */
2402 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2403 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002404 ssl->handshake == NULL )
2405 {
2406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2407 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2408 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002411 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002412 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002414 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002415 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2416 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002417 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002418#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002419
Hanno Beckerb50a2532018-08-06 11:52:54 +01002420 /* Double-check that we did not exceed the bounds
2421 * of the outgoing record buffer.
2422 * This should never fail as the various message
2423 * writing functions must obey the bounds of the
2424 * outgoing record buffer, but better be safe.
2425 *
2426 * Note: We deliberately do not check for the MTU or MFL here.
2427 */
2428 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2429 {
2430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002431 "size %" MBEDTLS_PRINTF_SIZET
2432 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002433 ssl->out_msglen,
2434 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002435 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2436 }
2437
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002438 /*
2439 * Fill handshake headers
2440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002442 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002443 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2444 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2445 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002446
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002447 /*
2448 * DTLS has additional fields in the Handshake layer,
2449 * between the length field and the actual payload:
2450 * uint16 message_seq;
2451 * uint24 fragment_offset;
2452 * uint24 fragment_length;
2453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002455 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002456 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002457 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002458 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002459 {
2460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002461 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002462 hs_len,
2463 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002464 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2465 }
2466
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002467 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002468 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002469
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002470 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002471 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002472 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002473 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2474 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2475 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002476 }
2477 else
2478 {
2479 ssl->out_msg[4] = 0;
2480 ssl->out_msg[5] = 0;
2481 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002482
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002483 /* Handshake hashes are computed without fragmentation,
2484 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002485 memset( ssl->out_msg + 6, 0x00, 3 );
2486 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002487 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002489
Hanno Becker0207e532018-08-28 10:28:28 +01002490 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002491 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2492 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002493 }
2494
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002495 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002497 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002498 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2499 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002500 {
2501 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2502 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002504 return( ret );
2505 }
2506 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002507 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002509 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002510 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002511 {
2512 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2513 return( ret );
2514 }
2515 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002516
2517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2518
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520}
2521
2522/*
2523 * Record layer functions
2524 */
2525
2526/*
2527 * Write current record.
2528 *
2529 * Uses:
2530 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2531 * - ssl->out_msglen: length of the record content (excl headers)
2532 * - ssl->out_msg: record content
2533 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002534int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002535{
2536 int ret, done = 0;
2537 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002538 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002539
2540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002541
Paul Bakker05ef8352012-05-08 09:17:57 +00002542 if( !done )
2543 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002544 unsigned i;
2545 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002546#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2547 size_t out_buf_len = ssl->out_buf_len;
2548#else
2549 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2550#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002551 /* Skip writing the record content type to after the encryption,
2552 * as it may change when using the CID extension. */
2553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002555 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002556
Hanno Becker19859472018-08-06 09:40:20 +01002557 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002558 ssl->out_len[0] = (unsigned char)( len >> 8 );
2559 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002560
Paul Bakker48916f92012-09-16 19:57:18 +00002561 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002562 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002563 mbedtls_record rec;
2564
2565 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002566 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002567 rec.data_len = ssl->out_msglen;
2568 rec.data_offset = ssl->out_msg - rec.buf;
2569
2570 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2571 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2572 ssl->conf->transport, rec.ver );
2573 rec.type = ssl->out_msgtype;
2574
Hanno Beckera0e20d02019-05-15 14:03:01 +01002575#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002576 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002577 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002578#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002579
Hanno Beckera18d1322018-01-03 14:27:32 +00002580 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002581 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002582 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002584 return( ret );
2585 }
2586
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002587 if( rec.data_offset != 0 )
2588 {
2589 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2590 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2591 }
2592
Hanno Becker6430faf2019-05-08 11:57:13 +01002593 /* Update the record content type and CID. */
2594 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002595#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002596 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002597#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002598 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002599 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2600 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002601 }
2602
Hanno Becker5903de42019-05-03 14:46:38 +01002603 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002604
2605#if defined(MBEDTLS_SSL_PROTO_DTLS)
2606 /* In case of DTLS, double-check that we don't exceed
2607 * the remaining space in the datagram. */
2608 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2609 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002610 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002611 if( ret < 0 )
2612 return( ret );
2613
2614 if( protected_record_size > (size_t) ret )
2615 {
2616 /* Should never happen */
2617 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2618 }
2619 }
2620#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002621
Hanno Becker6430faf2019-05-08 11:57:13 +01002622 /* Now write the potentially updated record content type. */
2623 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2624
Paul Elliott9f352112020-12-09 14:55:45 +00002625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002626 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002627 ssl->out_hdr[0], ssl->out_hdr[1],
2628 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002631 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002632
2633 ssl->out_left += protected_record_size;
2634 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002635 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002636
Hanno Beckerdd772292020-02-05 10:38:31 +00002637 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002638 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2639 break;
2640
2641 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002642 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002643 {
2644 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2645 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2646 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002647 }
2648
Hanno Becker67bc7c32018-08-06 11:33:50 +01002649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002650 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2651 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002652 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002653 size_t remaining;
2654 ret = ssl_get_remaining_payload_in_datagram( ssl );
2655 if( ret < 0 )
2656 {
2657 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2658 ret );
2659 return( ret );
2660 }
2661
2662 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002663 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002664 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002665 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002666 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002667 else
2668 {
Hanno Becker513815a2018-08-20 11:56:09 +01002669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002670 }
2671 }
2672#endif /* MBEDTLS_SSL_PROTO_DTLS */
2673
2674 if( ( flush == SSL_FORCE_FLUSH ) &&
2675 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002678 return( ret );
2679 }
2680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002682
2683 return( 0 );
2684}
2685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002687
2688static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2689{
2690 if( ssl->in_msglen < ssl->in_hslen ||
2691 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2692 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2693 {
2694 return( 1 );
2695 }
2696 return( 0 );
2697}
Hanno Becker44650b72018-08-16 12:51:11 +01002698
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002699static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002700{
2701 return( ( ssl->in_msg[9] << 16 ) |
2702 ( ssl->in_msg[10] << 8 ) |
2703 ssl->in_msg[11] );
2704}
2705
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002706static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002707{
2708 return( ( ssl->in_msg[6] << 16 ) |
2709 ( ssl->in_msg[7] << 8 ) |
2710 ssl->in_msg[8] );
2711}
2712
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002713static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002714{
2715 uint32_t msg_len, frag_off, frag_len;
2716
2717 msg_len = ssl_get_hs_total_len( ssl );
2718 frag_off = ssl_get_hs_frag_off( ssl );
2719 frag_len = ssl_get_hs_frag_len( ssl );
2720
2721 if( frag_off > msg_len )
2722 return( -1 );
2723
2724 if( frag_len > msg_len - frag_off )
2725 return( -1 );
2726
2727 if( frag_len + 12 > ssl->in_msglen )
2728 return( -1 );
2729
2730 return( 0 );
2731}
2732
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002733/*
2734 * Mark bits in bitmask (used for DTLS HS reassembly)
2735 */
2736static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2737{
2738 unsigned int start_bits, end_bits;
2739
2740 start_bits = 8 - ( offset % 8 );
2741 if( start_bits != 8 )
2742 {
2743 size_t first_byte_idx = offset / 8;
2744
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002745 /* Special case */
2746 if( len <= start_bits )
2747 {
2748 for( ; len != 0; len-- )
2749 mask[first_byte_idx] |= 1 << ( start_bits - len );
2750
2751 /* Avoid potential issues with offset or len becoming invalid */
2752 return;
2753 }
2754
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002755 offset += start_bits; /* Now offset % 8 == 0 */
2756 len -= start_bits;
2757
2758 for( ; start_bits != 0; start_bits-- )
2759 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2760 }
2761
2762 end_bits = len % 8;
2763 if( end_bits != 0 )
2764 {
2765 size_t last_byte_idx = ( offset + len ) / 8;
2766
2767 len -= end_bits; /* Now len % 8 == 0 */
2768
2769 for( ; end_bits != 0; end_bits-- )
2770 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2771 }
2772
2773 memset( mask + offset / 8, 0xFF, len / 8 );
2774}
2775
2776/*
2777 * Check that bitmask is full
2778 */
2779static int ssl_bitmask_check( unsigned char *mask, size_t len )
2780{
2781 size_t i;
2782
2783 for( i = 0; i < len / 8; i++ )
2784 if( mask[i] != 0xFF )
2785 return( -1 );
2786
2787 for( i = 0; i < len % 8; i++ )
2788 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2789 return( -1 );
2790
2791 return( 0 );
2792}
2793
Hanno Becker56e205e2018-08-16 09:06:12 +01002794/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002795static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002796 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002797{
Hanno Becker56e205e2018-08-16 09:06:12 +01002798 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002799
Hanno Becker56e205e2018-08-16 09:06:12 +01002800 alloc_len = 12; /* Handshake header */
2801 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002802
Hanno Beckerd07df862018-08-16 09:14:58 +01002803 if( add_bitmap )
2804 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002805
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002806 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002807}
Hanno Becker56e205e2018-08-16 09:06:12 +01002808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002810
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002811static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002812{
2813 return( ( ssl->in_msg[1] << 16 ) |
2814 ( ssl->in_msg[2] << 8 ) |
2815 ssl->in_msg[3] );
2816}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002817
Simon Butcher99000142016-10-13 17:21:01 +01002818int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002819{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002821 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002823 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002825 }
2826
Hanno Becker12555c62018-08-16 12:47:53 +01002827 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002830 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002831 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002834 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002835 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002836 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002837 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002838
Hanno Becker44650b72018-08-16 12:51:11 +01002839 if( ssl_check_hs_header( ssl ) != 0 )
2840 {
2841 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2842 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2843 }
2844
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002845 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002846 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2847 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2848 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2849 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002850 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002851 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2852 {
2853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2854 recv_msg_seq,
2855 ssl->handshake->in_msg_seq ) );
2856 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2857 }
2858
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002859 /* Retransmit only on last message from previous flight, to avoid
2860 * too many retransmissions.
2861 * Besides, No sane server ever retransmits HelloVerifyRequest */
2862 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002863 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002864 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002866 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002867 recv_msg_seq,
2868 ssl->handshake->in_flight_start_seq ) );
2869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002873 return( ret );
2874 }
2875 }
2876 else
2877 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002879 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002880 recv_msg_seq,
2881 ssl->handshake->in_msg_seq ) );
2882 }
2883
Hanno Becker90333da2017-10-10 11:27:13 +01002884 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002885 }
2886 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002887
Hanno Becker6d97ef52018-08-16 13:09:04 +01002888 /* Message reassembly is handled alongside buffering of future
2889 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002890 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002891 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002892 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002893 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002895 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002896 }
2897 }
2898 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002900 /* With TLS we don't handle fragmentation (for now) */
2901 if( ssl->in_msglen < ssl->in_hslen )
2902 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2904 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002905 }
2906
Simon Butcher99000142016-10-13 17:21:01 +01002907 return( 0 );
2908}
2909
2910void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2911{
Hanno Becker0271f962018-08-16 13:23:47 +01002912 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002913
Hanno Becker0271f962018-08-16 13:23:47 +01002914 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002915 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002916 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002917 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002918
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002919 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002921 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002922 ssl->handshake != NULL )
2923 {
Hanno Becker0271f962018-08-16 13:23:47 +01002924 unsigned offset;
2925 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002926
Hanno Becker0271f962018-08-16 13:23:47 +01002927 /* Increment handshake sequence number */
2928 hs->in_msg_seq++;
2929
2930 /*
2931 * Clear up handshake buffering and reassembly structure.
2932 */
2933
2934 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002935 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002936
2937 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002938 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2939 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002940 offset++, hs_buf++ )
2941 {
2942 *hs_buf = *(hs_buf + 1);
2943 }
2944
2945 /* Create a fresh last entry */
2946 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002947 }
2948#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002949}
2950
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002951/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002952 * DTLS anti-replay: RFC 6347 4.1.2.6
2953 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002954 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2955 * Bit n is set iff record number in_window_top - n has been seen.
2956 *
2957 * Usually, in_window_top is the last record number seen and the lsb of
2958 * in_window is set. The only exception is the initial state (record number 0
2959 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002962void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002963{
2964 ssl->in_window_top = 0;
2965 ssl->in_window = 0;
2966}
2967
2968static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2969{
2970 return( ( (uint64_t) buf[0] << 40 ) |
2971 ( (uint64_t) buf[1] << 32 ) |
2972 ( (uint64_t) buf[2] << 24 ) |
2973 ( (uint64_t) buf[3] << 16 ) |
2974 ( (uint64_t) buf[4] << 8 ) |
2975 ( (uint64_t) buf[5] ) );
2976}
2977
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002978static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2979{
Janos Follath865b3eb2019-12-16 11:46:15 +00002980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002981 unsigned char *original_in_ctr;
2982
2983 // save original in_ctr
2984 original_in_ctr = ssl->in_ctr;
2985
2986 // use counter from record
2987 ssl->in_ctr = record_in_ctr;
2988
2989 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2990
2991 // restore the counter
2992 ssl->in_ctr = original_in_ctr;
2993
2994 return ret;
2995}
2996
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002997/*
2998 * Return 0 if sequence number is acceptable, -1 otherwise
2999 */
Hanno Becker0183d692019-07-12 08:50:37 +01003000int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003001{
3002 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3003 uint64_t bit;
3004
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003005 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003006 return( 0 );
3007
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003008 if( rec_seqnum > ssl->in_window_top )
3009 return( 0 );
3010
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003011 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003012
3013 if( bit >= 64 )
3014 return( -1 );
3015
3016 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3017 return( -1 );
3018
3019 return( 0 );
3020}
3021
3022/*
3023 * Update replay window on new validated record
3024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003026{
3027 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3028
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003029 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003030 return;
3031
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003032 if( rec_seqnum > ssl->in_window_top )
3033 {
3034 /* Update window_top and the contents of the window */
3035 uint64_t shift = rec_seqnum - ssl->in_window_top;
3036
3037 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003038 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003039 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003040 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003041 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003042 ssl->in_window |= 1;
3043 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003044
3045 ssl->in_window_top = rec_seqnum;
3046 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003047 else
3048 {
3049 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003050 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003051
3052 if( bit < 64 ) /* Always true, but be extra sure */
3053 ssl->in_window |= (uint64_t) 1 << bit;
3054 }
3055}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003057
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003058#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003059/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003060 * Without any SSL context, check if a datagram looks like a ClientHello with
3061 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003062 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003063 *
3064 * - if cookie is valid, return 0
3065 * - if ClientHello looks superficially valid but cookie is not,
3066 * fill obuf and set olen, then
3067 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3068 * - otherwise return a specific error code
3069 */
3070static int ssl_check_dtls_clihlo_cookie(
3071 mbedtls_ssl_cookie_write_t *f_cookie_write,
3072 mbedtls_ssl_cookie_check_t *f_cookie_check,
3073 void *p_cookie,
3074 const unsigned char *cli_id, size_t cli_id_len,
3075 const unsigned char *in, size_t in_len,
3076 unsigned char *obuf, size_t buf_len, size_t *olen )
3077{
3078 size_t sid_len, cookie_len;
3079 unsigned char *p;
3080
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003081 /*
3082 * Structure of ClientHello with record and handshake headers,
3083 * and expected values. We don't need to check a lot, more checks will be
3084 * done when actually parsing the ClientHello - skipping those checks
3085 * avoids code duplication and does not make cookie forging any easier.
3086 *
3087 * 0-0 ContentType type; copied, must be handshake
3088 * 1-2 ProtocolVersion version; copied
3089 * 3-4 uint16 epoch; copied, must be 0
3090 * 5-10 uint48 sequence_number; copied
3091 * 11-12 uint16 length; (ignored)
3092 *
3093 * 13-13 HandshakeType msg_type; (ignored)
3094 * 14-16 uint24 length; (ignored)
3095 * 17-18 uint16 message_seq; copied
3096 * 19-21 uint24 fragment_offset; copied, must be 0
3097 * 22-24 uint24 fragment_length; (ignored)
3098 *
3099 * 25-26 ProtocolVersion client_version; (ignored)
3100 * 27-58 Random random; (ignored)
3101 * 59-xx SessionID session_id; 1 byte len + sid_len content
3102 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3103 * ...
3104 *
3105 * Minimum length is 61 bytes.
3106 */
3107 if( in_len < 61 ||
3108 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3109 in[3] != 0 || in[4] != 0 ||
3110 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3111 {
3112 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3113 }
3114
3115 sid_len = in[59];
3116 if( sid_len > in_len - 61 )
3117 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3118
3119 cookie_len = in[60 + sid_len];
3120 if( cookie_len > in_len - 60 )
3121 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3122
3123 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3124 cli_id, cli_id_len ) == 0 )
3125 {
3126 /* Valid cookie */
3127 return( 0 );
3128 }
3129
3130 /*
3131 * If we get here, we've got an invalid cookie, let's prepare HVR.
3132 *
3133 * 0-0 ContentType type; copied
3134 * 1-2 ProtocolVersion version; copied
3135 * 3-4 uint16 epoch; copied
3136 * 5-10 uint48 sequence_number; copied
3137 * 11-12 uint16 length; olen - 13
3138 *
3139 * 13-13 HandshakeType msg_type; hello_verify_request
3140 * 14-16 uint24 length; olen - 25
3141 * 17-18 uint16 message_seq; copied
3142 * 19-21 uint24 fragment_offset; copied
3143 * 22-24 uint24 fragment_length; olen - 25
3144 *
3145 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3146 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3147 *
3148 * Minimum length is 28.
3149 */
3150 if( buf_len < 28 )
3151 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3152
3153 /* Copy most fields and adapt others */
3154 memcpy( obuf, in, 25 );
3155 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3156 obuf[25] = 0xfe;
3157 obuf[26] = 0xff;
3158
3159 /* Generate and write actual cookie */
3160 p = obuf + 28;
3161 if( f_cookie_write( p_cookie,
3162 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3163 {
3164 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3165 }
3166
3167 *olen = p - obuf;
3168
3169 /* Go back and fill length fields */
3170 obuf[27] = (unsigned char)( *olen - 28 );
3171
3172 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3173 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3174 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3175
3176 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3177 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3178
3179 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3180}
3181
3182/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003183 * Handle possible client reconnect with the same UDP quadruplet
3184 * (RFC 6347 Section 4.2.8).
3185 *
3186 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3187 * that looks like a ClientHello.
3188 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003189 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003190 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003191 * - if the input looks like a ClientHello with a valid cookie,
3192 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003193 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003194 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003195 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003196 * This function is called (through ssl_check_client_reconnect()) when an
3197 * unexpected record is found in ssl_get_next_record(), which will discard the
3198 * record if we return 0, and bubble up the return value otherwise (this
3199 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3200 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003201 */
3202static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3203{
Janos Follath865b3eb2019-12-16 11:46:15 +00003204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003205 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003206
Hanno Becker2fddd372019-07-10 14:37:41 +01003207 if( ssl->conf->f_cookie_write == NULL ||
3208 ssl->conf->f_cookie_check == NULL )
3209 {
3210 /* If we can't use cookies to verify reachability of the peer,
3211 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3213 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003214 return( 0 );
3215 }
3216
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003217 ret = ssl_check_dtls_clihlo_cookie(
3218 ssl->conf->f_cookie_write,
3219 ssl->conf->f_cookie_check,
3220 ssl->conf->p_cookie,
3221 ssl->cli_id, ssl->cli_id_len,
3222 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003223 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003224
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3226
3227 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003228 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003229 int send_ret;
3230 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3231 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3232 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003233 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003234 * If the error is permanent we'll catch it later,
3235 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003236 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3237 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3238 (void) send_ret;
3239
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003240 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003241 }
3242
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003243 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003244 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003246 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003247 {
3248 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3249 return( ret );
3250 }
3251
3252 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003253 }
3254
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003255 return( ret );
3256}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003257#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003258
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003259static int ssl_check_record_type( uint8_t record_type )
3260{
3261 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3262 record_type != MBEDTLS_SSL_MSG_ALERT &&
3263 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3264 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3265 {
3266 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3267 }
3268
3269 return( 0 );
3270}
3271
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003272/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003273 * ContentType type;
3274 * ProtocolVersion version;
3275 * uint16 epoch; // DTLS only
3276 * uint48 sequence_number; // DTLS only
3277 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003278 *
3279 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003280 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003281 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3282 *
3283 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003284 * 1. proceed with the record if this function returns 0
3285 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3286 * 3. return CLIENT_RECONNECT if this function return that value
3287 * 4. drop the whole datagram if this function returns anything else.
3288 * Point 2 is needed when the peer is resending, and we have already received
3289 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003290 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003291static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003292 unsigned char *buf,
3293 size_t len,
3294 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003295{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003296 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003297
Hanno Beckere5e7e782019-07-11 12:29:35 +01003298 size_t const rec_hdr_type_offset = 0;
3299 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003300
Hanno Beckere5e7e782019-07-11 12:29:35 +01003301 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3302 rec_hdr_type_len;
3303 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003304
Hanno Beckere5e7e782019-07-11 12:29:35 +01003305 size_t const rec_hdr_ctr_len = 8;
3306#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003307 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003308 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3309 rec_hdr_version_len;
3310
Hanno Beckera0e20d02019-05-15 14:03:01 +01003311#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003312 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3313 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003314 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003315#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3316#endif /* MBEDTLS_SSL_PROTO_DTLS */
3317
3318 size_t rec_hdr_len_offset; /* To be determined */
3319 size_t const rec_hdr_len_len = 2;
3320
3321 /*
3322 * Check minimum lengths for record header.
3323 */
3324
3325#if defined(MBEDTLS_SSL_PROTO_DTLS)
3326 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3327 {
3328 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3329 }
3330 else
3331#endif /* MBEDTLS_SSL_PROTO_DTLS */
3332 {
3333 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3334 }
3335
3336 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3337 {
3338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3339 (unsigned) len,
3340 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3341 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3342 }
3343
3344 /*
3345 * Parse and validate record content type
3346 */
3347
3348 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003349
3350 /* Check record content type */
3351#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3352 rec->cid_len = 0;
3353
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003354 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003355 ssl->conf->cid_len != 0 &&
3356 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003357 {
3358 /* Shift pointers to account for record header including CID
3359 * struct {
3360 * ContentType special_type = tls12_cid;
3361 * ProtocolVersion version;
3362 * uint16 epoch;
3363 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003364 * opaque cid[cid_length]; // Additional field compared to
3365 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003366 * uint16 length;
3367 * opaque enc_content[DTLSCiphertext.length];
3368 * } DTLSCiphertext;
3369 */
3370
3371 /* So far, we only support static CID lengths
3372 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003373 rec_hdr_cid_len = ssl->conf->cid_len;
3374 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003375
Hanno Beckere5e7e782019-07-11 12:29:35 +01003376 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003377 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3379 (unsigned) len,
3380 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003381 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003382 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003383
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003384 /* configured CID len is guaranteed at most 255, see
3385 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3386 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003387 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003388 }
3389 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003390#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003391 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003392 if( ssl_check_record_type( rec->type ) )
3393 {
Hanno Becker54229812019-07-12 14:40:00 +01003394 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3395 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003396 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3397 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003398 }
3399
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 /*
3401 * Parse and validate record version
3402 */
3403
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003404 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3405 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003406 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3407 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003408 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003409
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003410 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003411 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3413 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003414 }
3415
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003416 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003417 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3419 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003420 }
3421
Hanno Beckere5e7e782019-07-11 12:29:35 +01003422 /*
3423 * Parse/Copy record sequence number.
3424 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003425
Hanno Beckere5e7e782019-07-11 12:29:35 +01003426#if defined(MBEDTLS_SSL_PROTO_DTLS)
3427 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003428 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003429 /* Copy explicit record sequence number from input buffer. */
3430 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3431 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003432 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003433 else
3434#endif /* MBEDTLS_SSL_PROTO_DTLS */
3435 {
3436 /* Copy implicit record sequence number from SSL context structure. */
3437 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3438 }
Paul Bakker40e46942009-01-03 21:51:57 +00003439
Hanno Beckere5e7e782019-07-11 12:29:35 +01003440 /*
3441 * Parse record length.
3442 */
3443
Hanno Beckere5e7e782019-07-11 12:29:35 +01003444 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003445 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3446 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003448
Paul Elliott9f352112020-12-09 14:55:45 +00003449 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003450 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003451 rec->type,
3452 major_ver, minor_ver, rec->data_len ) );
3453
3454 rec->buf = buf;
3455 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003456
Hanno Beckerd417cc92019-07-26 08:20:27 +01003457 if( rec->data_len == 0 )
3458 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003459
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003460 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003461 * DTLS-related tests.
3462 * Check epoch before checking length constraint because
3463 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3464 * message gets duplicated before the corresponding Finished message,
3465 * the second ChangeCipherSpec should be discarded because it belongs
3466 * to an old epoch, but not because its length is shorter than
3467 * the minimum record length for packets using the new record transform.
3468 * Note that these two kinds of failures are handled differently,
3469 * as an unexpected record is silently skipped but an invalid
3470 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003471 */
3472#if defined(MBEDTLS_SSL_PROTO_DTLS)
3473 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3474 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003475 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003476
Hanno Becker955a5c92019-07-10 17:12:07 +01003477 /* Check that the datagram is large enough to contain a record
3478 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003479 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003480 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3482 (unsigned) len,
3483 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003484 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3485 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003486
Hanno Becker37cfe732019-07-10 17:20:01 +01003487 /* Records from other, non-matching epochs are silently discarded.
3488 * (The case of same-port Client reconnects must be considered in
3489 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003490 if( rec_epoch != ssl->in_epoch )
3491 {
3492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003493 "expected %u, received %lu",
3494 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003495
Hanno Becker552f7472019-07-19 10:59:12 +01003496 /* Records from the next epoch are considered for buffering
3497 * (concretely: early Finished messages). */
3498 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003499 {
Hanno Becker552f7472019-07-19 10:59:12 +01003500 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3501 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003502 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003503
Hanno Becker2fddd372019-07-10 14:37:41 +01003504 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003505 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003506#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003507 /* For records from the correct epoch, check whether their
3508 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003509 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3510 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003511 {
3512 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3513 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3514 }
3515#endif
3516 }
3517#endif /* MBEDTLS_SSL_PROTO_DTLS */
3518
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003519 return( 0 );
3520}
Paul Bakker5121ce52009-01-03 21:22:43 +00003521
Paul Bakker5121ce52009-01-03 21:22:43 +00003522
Hanno Becker2fddd372019-07-10 14:37:41 +01003523#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3524static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3525{
3526 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3527
3528 /*
3529 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3530 * access the first byte of record content (handshake type), as we
3531 * have an active transform (possibly iv_len != 0), so use the
3532 * fact that the record header len is 13 instead.
3533 */
3534 if( rec_epoch == 0 &&
3535 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3536 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3537 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3538 ssl->in_left > 13 &&
3539 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3540 {
3541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3542 "from the same port" ) );
3543 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003544 }
3545
3546 return( 0 );
3547}
Hanno Becker2fddd372019-07-10 14:37:41 +01003548#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003549
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003550/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003551 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003552 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003553static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3554 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003555{
3556 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003557
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003559 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003560
Paul Bakker48916f92012-09-16 19:57:18 +00003561 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003563 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003564
Hanno Beckera18d1322018-01-03 14:27:32 +00003565 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003566 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003567 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003569
Hanno Beckera0e20d02019-05-15 14:03:01 +01003570#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003571 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3572 ssl->conf->ignore_unexpected_cid
3573 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3574 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003575 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003576 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003577 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003578#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003579
Paul Bakker5121ce52009-01-03 21:22:43 +00003580 return( ret );
3581 }
3582
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003583 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003584 {
3585 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003586 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003587 }
3588
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003589 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003590 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003591
Hanno Beckera0e20d02019-05-15 14:03:01 +01003592#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003593 /* We have already checked the record content type
3594 * in ssl_parse_record_header(), failing or silently
3595 * dropping the record in the case of an unknown type.
3596 *
3597 * Since with the use of CIDs, the record content type
3598 * might change during decryption, re-check the record
3599 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003600 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003601 {
3602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3603 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3604 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003605#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003606
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003607 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003608 {
3609#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3610 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003611 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003612 {
3613 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3615 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3616 }
3617#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3618
3619 ssl->nb_zero++;
3620
3621 /*
3622 * Three or more empty messages may be a DoS attack
3623 * (excessive CPU consumption).
3624 */
3625 if( ssl->nb_zero > 3 )
3626 {
3627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003628 "messages, possible DoS attack" ) );
3629 /* Treat the records as if they were not properly authenticated,
3630 * thereby failing the connection if we see more than allowed
3631 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003632 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3633 }
3634 }
3635 else
3636 ssl->nb_zero = 0;
3637
3638#if defined(MBEDTLS_SSL_PROTO_DTLS)
3639 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3640 {
3641 ; /* in_ctr read from peer, not maintained internally */
3642 }
3643 else
3644#endif
3645 {
3646 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003647 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003648 if( ++ssl->in_ctr[i - 1] != 0 )
3649 break;
3650
3651 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003652 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003653 {
3654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3655 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3656 }
3657 }
3658
Paul Bakker5121ce52009-01-03 21:22:43 +00003659 }
3660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003661#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003662 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003663 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003664 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003665 }
3666#endif
3667
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003668 /* Check actual (decrypted) record content length against
3669 * configured maximum. */
3670 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3671 {
3672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3673 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3674 }
3675
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003676 return( 0 );
3677}
3678
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003679/*
3680 * Read a record.
3681 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003682 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3683 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3684 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003685 */
Hanno Becker1097b342018-08-15 14:09:41 +01003686
3687/* Helper functions for mbedtls_ssl_read_record(). */
3688static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003689static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3690static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003691
Hanno Becker327c93b2018-08-15 13:56:18 +01003692int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003693 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003694{
Janos Follath865b3eb2019-12-16 11:46:15 +00003695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003697 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003698
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003699 if( ssl->keep_current_message == 0 )
3700 {
3701 do {
Simon Butcher99000142016-10-13 17:21:01 +01003702
Hanno Becker26994592018-08-15 14:14:59 +01003703 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003704 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003705 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003706
Hanno Beckere74d5562018-08-15 14:26:08 +01003707 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003708 {
Hanno Becker40f50842018-08-15 14:48:01 +01003709#if defined(MBEDTLS_SSL_PROTO_DTLS)
3710 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003711
Hanno Becker40f50842018-08-15 14:48:01 +01003712 /* We only check for buffered messages if the
3713 * current datagram is fully consumed. */
3714 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003715 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003716 {
Hanno Becker40f50842018-08-15 14:48:01 +01003717 if( ssl_load_buffered_message( ssl ) == 0 )
3718 have_buffered = 1;
3719 }
3720
3721 if( have_buffered == 0 )
3722#endif /* MBEDTLS_SSL_PROTO_DTLS */
3723 {
3724 ret = ssl_get_next_record( ssl );
3725 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3726 continue;
3727
3728 if( ret != 0 )
3729 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003730 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003731 return( ret );
3732 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003733 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003734 }
3735
3736 ret = mbedtls_ssl_handle_message_type( ssl );
3737
Hanno Becker40f50842018-08-15 14:48:01 +01003738#if defined(MBEDTLS_SSL_PROTO_DTLS)
3739 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3740 {
3741 /* Buffer future message */
3742 ret = ssl_buffer_message( ssl );
3743 if( ret != 0 )
3744 return( ret );
3745
3746 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3747 }
3748#endif /* MBEDTLS_SSL_PROTO_DTLS */
3749
Hanno Becker90333da2017-10-10 11:27:13 +01003750 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3751 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003752
3753 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003754 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003755 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003756 return( ret );
3757 }
3758
Hanno Becker327c93b2018-08-15 13:56:18 +01003759 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003760 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003761 {
3762 mbedtls_ssl_update_handshake_status( ssl );
3763 }
Simon Butcher99000142016-10-13 17:21:01 +01003764 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003765 else
Simon Butcher99000142016-10-13 17:21:01 +01003766 {
Hanno Becker02f59072018-08-15 14:00:24 +01003767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003768 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003769 }
3770
3771 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3772
3773 return( 0 );
3774}
3775
Hanno Becker40f50842018-08-15 14:48:01 +01003776#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003777static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003778{
Hanno Becker40f50842018-08-15 14:48:01 +01003779 if( ssl->in_left > ssl->next_record_offset )
3780 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003781
Hanno Becker40f50842018-08-15 14:48:01 +01003782 return( 0 );
3783}
3784
3785static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3786{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003787 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003788 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003789 int ret = 0;
3790
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003791 if( hs == NULL )
3792 return( -1 );
3793
Hanno Beckere00ae372018-08-20 09:39:42 +01003794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3795
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003796 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3797 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3798 {
3799 /* Check if we have seen a ChangeCipherSpec before.
3800 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003801 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003802 {
3803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3804 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003805 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003806 }
3807
Hanno Becker39b8bc92018-08-28 17:17:13 +01003808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003809 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3810 ssl->in_msglen = 1;
3811 ssl->in_msg[0] = 1;
3812
3813 /* As long as they are equal, the exact value doesn't matter. */
3814 ssl->in_left = 0;
3815 ssl->next_record_offset = 0;
3816
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003817 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003818 goto exit;
3819 }
Hanno Becker37f95322018-08-16 13:55:32 +01003820
Hanno Beckerb8f50142018-08-28 10:01:34 +01003821#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003822 /* Debug only */
3823 {
3824 unsigned offset;
3825 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3826 {
3827 hs_buf = &hs->buffering.hs[offset];
3828 if( hs_buf->is_valid == 1 )
3829 {
3830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3831 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003832 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003833 }
3834 }
3835 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003836#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003837
3838 /* Check if we have buffered and/or fully reassembled the
3839 * next handshake message. */
3840 hs_buf = &hs->buffering.hs[0];
3841 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3842 {
3843 /* Synthesize a record containing the buffered HS message. */
3844 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3845 ( hs_buf->data[2] << 8 ) |
3846 hs_buf->data[3];
3847
3848 /* Double-check that we haven't accidentally buffered
3849 * a message that doesn't fit into the input buffer. */
3850 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3851 {
3852 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3853 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3854 }
3855
3856 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3857 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3858 hs_buf->data, msg_len + 12 );
3859
3860 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3861 ssl->in_hslen = msg_len + 12;
3862 ssl->in_msglen = msg_len + 12;
3863 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3864
3865 ret = 0;
3866 goto exit;
3867 }
3868 else
3869 {
3870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3871 hs->in_msg_seq ) );
3872 }
3873
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003874 ret = -1;
3875
3876exit:
3877
3878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3879 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003880}
3881
Hanno Beckera02b0b42018-08-21 17:20:27 +01003882static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3883 size_t desired )
3884{
3885 int offset;
3886 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3888 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003889
Hanno Becker01315ea2018-08-21 17:22:17 +01003890 /* Get rid of future records epoch first, if such exist. */
3891 ssl_free_buffered_record( ssl );
3892
3893 /* Check if we have enough space available now. */
3894 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3895 hs->buffering.total_bytes_buffered ) )
3896 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003898 return( 0 );
3899 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003900
Hanno Becker4f432ad2018-08-28 10:02:32 +01003901 /* We don't have enough space to buffer the next expected handshake
3902 * message. Remove buffers used for future messages to gain space,
3903 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003904 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3905 offset >= 0; offset-- )
3906 {
3907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3908 offset ) );
3909
Hanno Beckerb309b922018-08-23 13:18:05 +01003910 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003911
3912 /* Check if we have enough space available now. */
3913 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3914 hs->buffering.total_bytes_buffered ) )
3915 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003917 return( 0 );
3918 }
3919 }
3920
3921 return( -1 );
3922}
3923
Hanno Becker40f50842018-08-15 14:48:01 +01003924static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3925{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003926 int ret = 0;
3927 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3928
3929 if( hs == NULL )
3930 return( 0 );
3931
3932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3933
3934 switch( ssl->in_msgtype )
3935 {
3936 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003938
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003939 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003940 break;
3941
3942 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003943 {
3944 unsigned recv_msg_seq_offset;
3945 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3946 mbedtls_ssl_hs_buffer *hs_buf;
3947 size_t msg_len = ssl->in_hslen - 12;
3948
3949 /* We should never receive an old handshake
3950 * message - double-check nonetheless. */
3951 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3952 {
3953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3954 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3955 }
3956
3957 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3958 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3959 {
3960 /* Silently ignore -- message too far in the future */
3961 MBEDTLS_SSL_DEBUG_MSG( 2,
3962 ( "Ignore future HS message with sequence number %u, "
3963 "buffering window %u - %u",
3964 recv_msg_seq, ssl->handshake->in_msg_seq,
3965 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3966
3967 goto exit;
3968 }
3969
3970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3971 recv_msg_seq, recv_msg_seq_offset ) );
3972
3973 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3974
3975 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003976 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003977 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003978 size_t reassembly_buf_sz;
3979
Hanno Becker37f95322018-08-16 13:55:32 +01003980 hs_buf->is_fragmented =
3981 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3982
3983 /* We copy the message back into the input buffer
3984 * after reassembly, so check that it's not too large.
3985 * This is an implementation-specific limitation
3986 * and not one from the standard, hence it is not
3987 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003988 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003989 {
3990 /* Ignore message */
3991 goto exit;
3992 }
3993
Hanno Beckere0b150f2018-08-21 15:51:03 +01003994 /* Check if we have enough space to buffer the message. */
3995 if( hs->buffering.total_bytes_buffered >
3996 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3997 {
3998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3999 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4000 }
4001
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004002 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4003 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004004
4005 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4006 hs->buffering.total_bytes_buffered ) )
4007 {
4008 if( recv_msg_seq_offset > 0 )
4009 {
4010 /* If we can't buffer a future message because
4011 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004012 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4013 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4014 " (already %" MBEDTLS_PRINTF_SIZET
4015 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004016 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004017 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004018 goto exit;
4019 }
Hanno Beckere1801392018-08-21 16:51:05 +01004020 else
4021 {
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) -- attempt to make space by freeing buffered future messages\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 Beckere1801392018-08-21 16:51:05 +01004028 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004029
Hanno Beckera02b0b42018-08-21 17:20:27 +01004030 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004031 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4033 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4034 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4035 " (already %" MBEDTLS_PRINTF_SIZET
4036 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004037 msg_len,
4038 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004039 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004040 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004041 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4042 goto exit;
4043 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004044 }
4045
Paul Elliottd48d5c62021-01-07 14:47:05 +00004046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004047 msg_len ) );
4048
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004049 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4050 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004051 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004052 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004053 goto exit;
4054 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004055 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004056
4057 /* Prepare final header: copy msg_type, length and message_seq,
4058 * then add standardised fragment_offset and fragment_length */
4059 memcpy( hs_buf->data, ssl->in_msg, 6 );
4060 memset( hs_buf->data + 6, 0, 3 );
4061 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4062
4063 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004064
4065 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004066 }
4067 else
4068 {
4069 /* Make sure msg_type and length are consistent */
4070 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4071 {
4072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4073 /* Ignore */
4074 goto exit;
4075 }
4076 }
4077
Hanno Becker4422bbb2018-08-20 09:40:19 +01004078 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004079 {
4080 size_t frag_len, frag_off;
4081 unsigned char * const msg = hs_buf->data + 12;
4082
4083 /*
4084 * Check and copy current fragment
4085 */
4086
4087 /* Validation of header fields already done in
4088 * mbedtls_ssl_prepare_handshake_record(). */
4089 frag_off = ssl_get_hs_frag_off( ssl );
4090 frag_len = ssl_get_hs_frag_len( ssl );
4091
Paul Elliottd48d5c62021-01-07 14:47:05 +00004092 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4093 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004094 frag_off, frag_len ) );
4095 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4096
4097 if( hs_buf->is_fragmented )
4098 {
4099 unsigned char * const bitmask = msg + msg_len;
4100 ssl_bitmask_set( bitmask, frag_off, frag_len );
4101 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4102 msg_len ) == 0 );
4103 }
4104 else
4105 {
4106 hs_buf->is_complete = 1;
4107 }
4108
4109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4110 hs_buf->is_complete ? "" : "not yet " ) );
4111 }
4112
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004113 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004114 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004115
4116 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004117 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004118 break;
4119 }
4120
4121exit:
4122
4123 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4124 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004125}
4126#endif /* MBEDTLS_SSL_PROTO_DTLS */
4127
Hanno Becker1097b342018-08-15 14:09:41 +01004128static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004129{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004130 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004131 * Consume last content-layer message and potentially
4132 * update in_msglen which keeps track of the contents'
4133 * consumption state.
4134 *
4135 * (1) Handshake messages:
4136 * Remove last handshake message, move content
4137 * and adapt in_msglen.
4138 *
4139 * (2) Alert messages:
4140 * Consume whole record content, in_msglen = 0.
4141 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004142 * (3) Change cipher spec:
4143 * Consume whole record content, in_msglen = 0.
4144 *
4145 * (4) Application data:
4146 * Don't do anything - the record layer provides
4147 * the application data as a stream transport
4148 * and consumes through mbedtls_ssl_read only.
4149 *
4150 */
4151
4152 /* Case (1): Handshake messages */
4153 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004154 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004155 /* Hard assertion to be sure that no application data
4156 * is in flight, as corrupting ssl->in_msglen during
4157 * ssl->in_offt != NULL is fatal. */
4158 if( ssl->in_offt != NULL )
4159 {
4160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4161 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4162 }
4163
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004164 /*
4165 * Get next Handshake message in the current record
4166 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004167
Hanno Becker4a810fb2017-05-24 16:27:30 +01004168 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004169 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004170 * current handshake content: If DTLS handshake
4171 * fragmentation is used, that's the fragment
4172 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004173 * size here is faulty and should be changed at
4174 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004175 * (2) While it doesn't seem to cause problems, one
4176 * has to be very careful not to assume that in_hslen
4177 * is always <= in_msglen in a sensible communication.
4178 * Again, it's wrong for DTLS handshake fragmentation.
4179 * The following check is therefore mandatory, and
4180 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004181 * Additionally, ssl->in_hslen might be arbitrarily out of
4182 * bounds after handling a DTLS message with an unexpected
4183 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004184 */
4185 if( ssl->in_hslen < ssl->in_msglen )
4186 {
4187 ssl->in_msglen -= ssl->in_hslen;
4188 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4189 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004190
Hanno Becker4a810fb2017-05-24 16:27:30 +01004191 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4192 ssl->in_msg, ssl->in_msglen );
4193 }
4194 else
4195 {
4196 ssl->in_msglen = 0;
4197 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004198
Hanno Becker4a810fb2017-05-24 16:27:30 +01004199 ssl->in_hslen = 0;
4200 }
4201 /* Case (4): Application data */
4202 else if( ssl->in_offt != NULL )
4203 {
4204 return( 0 );
4205 }
4206 /* Everything else (CCS & Alerts) */
4207 else
4208 {
4209 ssl->in_msglen = 0;
4210 }
4211
Hanno Becker1097b342018-08-15 14:09:41 +01004212 return( 0 );
4213}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004214
Hanno Beckere74d5562018-08-15 14:26:08 +01004215static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4216{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004217 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004218 return( 1 );
4219
4220 return( 0 );
4221}
4222
Hanno Becker5f066e72018-08-16 14:56:31 +01004223#if defined(MBEDTLS_SSL_PROTO_DTLS)
4224
4225static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4226{
4227 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4228 if( hs == NULL )
4229 return;
4230
Hanno Becker01315ea2018-08-21 17:22:17 +01004231 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004232 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004233 hs->buffering.total_bytes_buffered -=
4234 hs->buffering.future_record.len;
4235
4236 mbedtls_free( hs->buffering.future_record.data );
4237 hs->buffering.future_record.data = NULL;
4238 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004239}
4240
4241static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4242{
4243 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4244 unsigned char * rec;
4245 size_t rec_len;
4246 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004247#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4248 size_t in_buf_len = ssl->in_buf_len;
4249#else
4250 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4251#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004252 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4253 return( 0 );
4254
4255 if( hs == NULL )
4256 return( 0 );
4257
Hanno Becker5f066e72018-08-16 14:56:31 +01004258 rec = hs->buffering.future_record.data;
4259 rec_len = hs->buffering.future_record.len;
4260 rec_epoch = hs->buffering.future_record.epoch;
4261
4262 if( rec == NULL )
4263 return( 0 );
4264
Hanno Becker4cb782d2018-08-20 11:19:05 +01004265 /* Only consider loading future records if the
4266 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004267 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004268 return( 0 );
4269
Hanno Becker5f066e72018-08-16 14:56:31 +01004270 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4271
4272 if( rec_epoch != ssl->in_epoch )
4273 {
4274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4275 goto exit;
4276 }
4277
4278 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4279
4280 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004281 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004282 {
4283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4284 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4285 }
4286
4287 memcpy( ssl->in_hdr, rec, rec_len );
4288 ssl->in_left = rec_len;
4289 ssl->next_record_offset = 0;
4290
4291 ssl_free_buffered_record( ssl );
4292
4293exit:
4294 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4295 return( 0 );
4296}
4297
Hanno Becker519f15d2019-07-11 12:43:20 +01004298static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4299 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004300{
4301 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004302
4303 /* Don't buffer future records outside handshakes. */
4304 if( hs == NULL )
4305 return( 0 );
4306
4307 /* Only buffer handshake records (we are only interested
4308 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004309 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004310 return( 0 );
4311
4312 /* Don't buffer more than one future epoch record. */
4313 if( hs->buffering.future_record.data != NULL )
4314 return( 0 );
4315
Hanno Becker01315ea2018-08-21 17:22:17 +01004316 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004317 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004318 hs->buffering.total_bytes_buffered ) )
4319 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4321 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4322 " (already %" MBEDTLS_PRINTF_SIZET
4323 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004324 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004325 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004326 return( 0 );
4327 }
4328
Hanno Becker5f066e72018-08-16 14:56:31 +01004329 /* Buffer record */
4330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004331 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004332 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004333
4334 /* ssl_parse_record_header() only considers records
4335 * of the next epoch as candidates for buffering. */
4336 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004337 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004338
4339 hs->buffering.future_record.data =
4340 mbedtls_calloc( 1, hs->buffering.future_record.len );
4341 if( hs->buffering.future_record.data == NULL )
4342 {
4343 /* If we run out of RAM trying to buffer a
4344 * record from the next epoch, just ignore. */
4345 return( 0 );
4346 }
4347
Hanno Becker519f15d2019-07-11 12:43:20 +01004348 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004349
Hanno Becker519f15d2019-07-11 12:43:20 +01004350 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004351 return( 0 );
4352}
4353
4354#endif /* MBEDTLS_SSL_PROTO_DTLS */
4355
Hanno Beckere74d5562018-08-15 14:26:08 +01004356static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004357{
Janos Follath865b3eb2019-12-16 11:46:15 +00004358 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004359 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004360
Hanno Becker5f066e72018-08-16 14:56:31 +01004361#if defined(MBEDTLS_SSL_PROTO_DTLS)
4362 /* We might have buffered a future record; if so,
4363 * and if the epoch matches now, load it.
4364 * On success, this call will set ssl->in_left to
4365 * the length of the buffered record, so that
4366 * the calls to ssl_fetch_input() below will
4367 * essentially be no-ops. */
4368 ret = ssl_load_buffered_record( ssl );
4369 if( ret != 0 )
4370 return( ret );
4371#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004372
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004373 /* Ensure that we have enough space available for the default form
4374 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4375 * with no space for CIDs counted in). */
4376 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4377 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004380 return( ret );
4381 }
4382
Hanno Beckere5e7e782019-07-11 12:29:35 +01004383 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4384 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004386#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004387 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004388 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004389 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4390 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004391 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004392 if( ret != 0 )
4393 return( ret );
4394
4395 /* Fall through to handling of unexpected records */
4396 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4397 }
4398
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004399 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4400 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004401#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004402 /* Reset in pointers to default state for TLS/DTLS records,
4403 * assuming no CID and no offset between record content and
4404 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004405 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004406
Hanno Becker7ae20e02019-07-12 08:33:49 +01004407 /* Setup internal message pointers from record structure. */
4408 ssl->in_msgtype = rec.type;
4409#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4410 ssl->in_len = ssl->in_cid + rec.cid_len;
4411#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4412 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4413 ssl->in_msglen = rec.data_len;
4414
Hanno Becker2fddd372019-07-10 14:37:41 +01004415 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004416 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004417 if( ret != 0 )
4418 return( ret );
4419#endif
4420
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004421 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004422 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004423
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4425 "(header)" ) );
4426 }
4427 else
4428 {
4429 /* Skip invalid record and the rest of the datagram */
4430 ssl->next_record_offset = 0;
4431 ssl->in_left = 0;
4432
4433 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4434 "(header)" ) );
4435 }
4436
4437 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004438 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004439 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004440 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004441#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004442 {
4443 return( ret );
4444 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004445 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004448 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004449 {
Hanno Beckera8814792019-07-10 15:01:45 +01004450 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004451 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004452 if( ssl->next_record_offset < ssl->in_left )
4453 {
4454 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4455 }
4456 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004457 else
4458#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004459 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004460 /*
4461 * Fetch record contents from underlying transport.
4462 */
Hanno Beckera3175662019-07-11 12:50:29 +01004463 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004464 if( ret != 0 )
4465 {
4466 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4467 return( ret );
4468 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004469
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004470 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004471 }
4472
4473 /*
4474 * Decrypt record contents.
4475 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004476
Hanno Beckerfdf66042019-07-11 13:07:45 +01004477 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004480 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004481 {
4482 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004483 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004484 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004485 /* Except when waiting for Finished as a bad mac here
4486 * probably means something went wrong in the handshake
4487 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4488 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4489 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4490 {
4491#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4492 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4493 {
4494 mbedtls_ssl_send_alert_message( ssl,
4495 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4496 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4497 }
4498#endif
4499 return( ret );
4500 }
4501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004502#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004503 if( ssl->conf->badmac_limit != 0 &&
4504 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4507 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004508 }
4509#endif
4510
Hanno Becker4a810fb2017-05-24 16:27:30 +01004511 /* As above, invalid records cause
4512 * dismissal of the whole datagram. */
4513
4514 ssl->next_record_offset = 0;
4515 ssl->in_left = 0;
4516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004518 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004519 }
4520
4521 return( ret );
4522 }
4523 else
4524#endif
4525 {
4526 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004527#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4528 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004529 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 mbedtls_ssl_send_alert_message( ssl,
4531 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4532 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004533 }
4534#endif
4535 return( ret );
4536 }
4537 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004538
Hanno Becker44d89b22019-07-12 09:40:44 +01004539
4540 /* Reset in pointers to default state for TLS/DTLS records,
4541 * assuming no CID and no offset between record content and
4542 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004543 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004544#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4545 ssl->in_len = ssl->in_cid + rec.cid_len;
4546#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004547 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004548
Hanno Becker8685c822019-07-12 09:37:30 +01004549 /* The record content type may change during decryption,
4550 * so re-read it. */
4551 ssl->in_msgtype = rec.type;
4552 /* Also update the input buffer, because unfortunately
4553 * the server-side ssl_parse_client_hello() reparses the
4554 * record header when receiving a ClientHello initiating
4555 * a renegotiation. */
4556 ssl->in_hdr[0] = rec.type;
4557 ssl->in_msg = rec.buf + rec.data_offset;
4558 ssl->in_msglen = rec.data_len;
4559 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4560 ssl->in_len[1] = (unsigned char)( rec.data_len );
4561
Simon Butcher99000142016-10-13 17:21:01 +01004562 return( 0 );
4563}
4564
4565int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4566{
Janos Follath865b3eb2019-12-16 11:46:15 +00004567 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004568
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004569 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004570 * Handle particular types of records
4571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004572 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004573 {
Simon Butcher99000142016-10-13 17:21:01 +01004574 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4575 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004576 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004577 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004578 }
4579
Hanno Beckere678eaa2018-08-21 14:57:46 +01004580 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004581 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004582 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004583 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004584 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004585 ssl->in_msglen ) );
4586 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004587 }
4588
Hanno Beckere678eaa2018-08-21 14:57:46 +01004589 if( ssl->in_msg[0] != 1 )
4590 {
4591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4592 ssl->in_msg[0] ) );
4593 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4594 }
4595
4596#if defined(MBEDTLS_SSL_PROTO_DTLS)
4597 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4598 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4599 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4600 {
4601 if( ssl->handshake == NULL )
4602 {
4603 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4604 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4605 }
4606
4607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4608 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4609 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004610#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004611 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004613 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004614 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004615 if( ssl->in_msglen != 2 )
4616 {
4617 /* Note: Standard allows for more than one 2 byte alert
4618 to be packed in a single message, but Mbed TLS doesn't
4619 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004620 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004621 ssl->in_msglen ) );
4622 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4623 }
4624
Paul Elliott9f352112020-12-09 14:55:45 +00004625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004626 ssl->in_msg[0], ssl->in_msg[1] ) );
4627
4628 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004629 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004632 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004634 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004635 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004636 }
4637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004638 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4639 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4642 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004643 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004644
4645#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4646 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4647 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4648 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004650 /* Will be handled when trying to parse ServerHello */
4651 return( 0 );
4652 }
4653#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004654 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004655 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004656 }
4657
Hanno Beckerc76c6192017-06-06 10:03:17 +01004658#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004659 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004660 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004661 /* Drop unexpected ApplicationData records,
4662 * except at the beginning of renegotiations */
4663 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4664 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4665#if defined(MBEDTLS_SSL_RENEGOTIATION)
4666 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4667 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004668#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004669 )
4670 {
4671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4672 return( MBEDTLS_ERR_SSL_NON_FATAL );
4673 }
4674
4675 if( ssl->handshake != NULL &&
4676 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4677 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004678 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004679 }
4680 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004681#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004682
Paul Bakker5121ce52009-01-03 21:22:43 +00004683 return( 0 );
4684}
4685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004687{
irwir6c0da642019-09-26 21:07:41 +03004688 return( mbedtls_ssl_send_alert_message( ssl,
4689 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4690 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004691}
4692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004693int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004694 unsigned char level,
4695 unsigned char message )
4696{
Janos Follath865b3eb2019-12-16 11:46:15 +00004697 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004698
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004699 if( ssl == NULL || ssl->conf == NULL )
4700 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004703 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004706 ssl->out_msglen = 2;
4707 ssl->out_msg[0] = level;
4708 ssl->out_msg[1] = message;
4709
Hanno Becker67bc7c32018-08-06 11:33:50 +01004710 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004712 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004713 return( ret );
4714 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004716
4717 return( 0 );
4718}
4719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004720int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004721{
Janos Follath865b3eb2019-12-16 11:46:15 +00004722 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004726 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004727 ssl->out_msglen = 1;
4728 ssl->out_msg[0] = 1;
4729
Paul Bakker5121ce52009-01-03 21:22:43 +00004730 ssl->state++;
4731
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004732 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004733 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004734 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004735 return( ret );
4736 }
4737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004739
4740 return( 0 );
4741}
4742
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004744{
Janos Follath865b3eb2019-12-16 11:46:15 +00004745 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004748
Hanno Becker327c93b2018-08-15 13:56:18 +01004749 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004750 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004752 return( ret );
4753 }
4754
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004756 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004758 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4759 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004760 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004761 }
4762
Hanno Beckere678eaa2018-08-21 14:57:46 +01004763 /* CCS records are only accepted if they have length 1 and content '1',
4764 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004765
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004766 /*
4767 * Switch to our negotiated transform and session parameters for inbound
4768 * data.
4769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004771 ssl->transform_in = ssl->transform_negotiate;
4772 ssl->session_in = ssl->session_negotiate;
4773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004774#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004775 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004776 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004777#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004778 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004779#endif
4780
4781 /* Increment epoch */
4782 if( ++ssl->in_epoch == 0 )
4783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004785 /* This is highly unlikely to happen for legitimate reasons, so
4786 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004787 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004788 }
4789 }
4790 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004791#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004792 memset( ssl->in_ctr, 0, 8 );
4793
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004794 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004795
Paul Bakker5121ce52009-01-03 21:22:43 +00004796 ssl->state++;
4797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004799
4800 return( 0 );
4801}
4802
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004803/* Once ssl->out_hdr as the address of the beginning of the
4804 * next outgoing record is set, deduce the other pointers.
4805 *
4806 * Note: For TLS, we save the implicit record sequence number
4807 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4808 * and the caller has to make sure there's space for this.
4809 */
4810
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004811static size_t ssl_transform_get_explicit_iv_len(
4812 mbedtls_ssl_transform const *transform )
4813{
TRodziewiczef73f012021-05-13 14:53:36 +02004814 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004815 return( 0 );
4816
4817 return( transform->ivlen - transform->fixed_ivlen );
4818}
4819
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004820void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4821 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004822{
4823#if defined(MBEDTLS_SSL_PROTO_DTLS)
4824 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4825 {
4826 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004827#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004828 ssl->out_cid = ssl->out_ctr + 8;
4829 ssl->out_len = ssl->out_cid;
4830 if( transform != NULL )
4831 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004832#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004833 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004834#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004835 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004836 }
4837 else
4838#endif
4839 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004840 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004841#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004842 ssl->out_cid = ssl->out_len;
4843#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004844 ssl->out_iv = ssl->out_hdr + 5;
4845 }
4846
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004847 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004848 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004849 if( transform != NULL )
4850 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004851}
4852
4853/* Once ssl->in_hdr as the address of the beginning of the
4854 * next incoming record is set, deduce the other pointers.
4855 *
4856 * Note: For TLS, we save the implicit record sequence number
4857 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4858 * and the caller has to make sure there's space for this.
4859 */
4860
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004861void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004862{
Hanno Becker79594fd2019-05-08 09:38:41 +01004863 /* This function sets the pointers to match the case
4864 * of unprotected TLS/DTLS records, with both ssl->in_iv
4865 * and ssl->in_msg pointing to the beginning of the record
4866 * content.
4867 *
4868 * When decrypting a protected record, ssl->in_msg
4869 * will be shifted to point to the beginning of the
4870 * record plaintext.
4871 */
4872
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004873#if defined(MBEDTLS_SSL_PROTO_DTLS)
4874 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4875 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004876 /* This sets the header pointers to match records
4877 * without CID. When we receive a record containing
4878 * a CID, the fields are shifted accordingly in
4879 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004880 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004881#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004882 ssl->in_cid = ssl->in_ctr + 8;
4883 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004884#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004885 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004886#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004887 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004888 }
4889 else
4890#endif
4891 {
4892 ssl->in_ctr = ssl->in_hdr - 8;
4893 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004894#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004895 ssl->in_cid = ssl->in_len;
4896#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004897 ssl->in_iv = ssl->in_hdr + 5;
4898 }
4899
Hanno Becker79594fd2019-05-08 09:38:41 +01004900 /* This will be adjusted at record decryption time. */
4901 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004902}
4903
Paul Bakker5121ce52009-01-03 21:22:43 +00004904/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004905 * Setup an SSL context
4906 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004907
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004908void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004909{
4910 /* Set the incoming and outgoing record pointers. */
4911#if defined(MBEDTLS_SSL_PROTO_DTLS)
4912 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4913 {
4914 ssl->out_hdr = ssl->out_buf;
4915 ssl->in_hdr = ssl->in_buf;
4916 }
4917 else
4918#endif /* MBEDTLS_SSL_PROTO_DTLS */
4919 {
Hanno Becker12078f42021-03-02 15:28:41 +00004920 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004921 ssl->out_hdr = ssl->out_buf + 8;
4922 ssl->in_hdr = ssl->in_buf + 8;
4923 }
4924
4925 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004926 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4927 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004928}
4929
Paul Bakker5121ce52009-01-03 21:22:43 +00004930/*
4931 * SSL get accessors
4932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004934{
4935 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4936}
4937
Hanno Becker8b170a02017-10-10 11:51:19 +01004938int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4939{
4940 /*
4941 * Case A: We're currently holding back
4942 * a message for further processing.
4943 */
4944
4945 if( ssl->keep_current_message == 1 )
4946 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004948 return( 1 );
4949 }
4950
4951 /*
4952 * Case B: Further records are pending in the current datagram.
4953 */
4954
4955#if defined(MBEDTLS_SSL_PROTO_DTLS)
4956 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4957 ssl->in_left > ssl->next_record_offset )
4958 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004959 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004960 return( 1 );
4961 }
4962#endif /* MBEDTLS_SSL_PROTO_DTLS */
4963
4964 /*
4965 * Case C: A handshake message is being processed.
4966 */
4967
Hanno Becker8b170a02017-10-10 11:51:19 +01004968 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4969 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004970 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004971 return( 1 );
4972 }
4973
4974 /*
4975 * Case D: An application data message is being processed
4976 */
4977 if( ssl->in_offt != NULL )
4978 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004979 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004980 return( 1 );
4981 }
4982
4983 /*
4984 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004985 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004986 * we implement support for multiple alerts in single records.
4987 */
4988
4989 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4990 return( 0 );
4991}
4992
Paul Bakker43ca69c2011-01-15 17:35:19 +00004993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004994int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004995{
Hanno Becker3136ede2018-08-17 15:28:19 +01004996 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01004998 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004999
Hanno Becker5903de42019-05-03 14:46:38 +01005000 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5001
Hanno Becker78640902018-08-13 16:35:15 +01005002 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005003 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 case MBEDTLS_MODE_GCM:
5008 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005009 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005011 transform_expansion = transform->minlen;
5012 break;
5013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005015
5016 block_size = mbedtls_cipher_get_block_size(
5017 &transform->cipher_ctx_enc );
5018
Hanno Becker3136ede2018-08-17 15:28:19 +01005019 /* Expansion due to the addition of the MAC. */
5020 transform_expansion += transform->maclen;
5021
5022 /* Expansion due to the addition of CBC padding;
5023 * Theoretically up to 256 bytes, but we never use
5024 * more than the block size of the underlying cipher. */
5025 transform_expansion += block_size;
5026
5027 /* For TLS 1.1 or higher, an explicit IV is added
5028 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005029#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5030 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005031 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005032#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005033
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005034 break;
5035
5036 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005039 }
5040
Hanno Beckera0e20d02019-05-15 14:03:01 +01005041#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005042 if( transform->out_cid_len != 0 )
5043 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005044#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005045
Hanno Becker5903de42019-05-03 14:46:38 +01005046 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005047}
5048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005049#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005050/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005051 * Check record counters and renegotiate if they're above the limit.
5052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005053static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005054{
Hanno Beckerdd772292020-02-05 10:38:31 +00005055 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005056 int in_ctr_cmp;
5057 int out_ctr_cmp;
5058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5060 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005061 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005062 {
5063 return( 0 );
5064 }
5065
Andres AG2196c7f2016-12-15 17:01:16 +00005066 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5067 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005068 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005069 ssl->conf->renego_period + ep_len, 8 - ep_len );
5070
5071 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005072 {
5073 return( 0 );
5074 }
5075
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005076 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005077 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005078}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005080
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005081/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005082 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005083 * may only be sent for the purpose of initiating renegotiations.
5084 *
5085 * This function is introduced as a separate helper since the handling
5086 * of post-handshake handshake messages changes significantly in TLS 1.3,
5087 * and having a helper function allows to distinguish between TLS <= 1.2 and
5088 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5089 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005090static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005091{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005092 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005093
5094 /*
5095 * - For client-side, expect SERVER_HELLO_REQUEST.
5096 * - For server-side, expect CLIENT_HELLO.
5097 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5098 */
5099
5100#if defined(MBEDTLS_SSL_CLI_C)
5101 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5102 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5103 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5104 {
5105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5106
5107 /* With DTLS, drop the packet (probably from last handshake) */
5108#if defined(MBEDTLS_SSL_PROTO_DTLS)
5109 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5110 {
5111 return( 0 );
5112 }
5113#endif
5114 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5115 }
5116#endif /* MBEDTLS_SSL_CLI_C */
5117
5118#if defined(MBEDTLS_SSL_SRV_C)
5119 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5120 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5121 {
5122 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5123
5124 /* With DTLS, drop the packet (probably from last handshake) */
5125#if defined(MBEDTLS_SSL_PROTO_DTLS)
5126 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5127 {
5128 return( 0 );
5129 }
5130#endif
5131 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5132 }
5133#endif /* MBEDTLS_SSL_SRV_C */
5134
5135#if defined(MBEDTLS_SSL_RENEGOTIATION)
5136 /* Determine whether renegotiation attempt should be accepted */
5137 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5138 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5139 ssl->conf->allow_legacy_renegotiation ==
5140 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5141 {
5142 /*
5143 * Accept renegotiation request
5144 */
5145
5146 /* DTLS clients need to know renego is server-initiated */
5147#if defined(MBEDTLS_SSL_PROTO_DTLS)
5148 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5149 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5150 {
5151 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5152 }
5153#endif
5154 ret = mbedtls_ssl_start_renegotiation( ssl );
5155 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5156 ret != 0 )
5157 {
5158 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5159 ret );
5160 return( ret );
5161 }
5162 }
5163 else
5164#endif /* MBEDTLS_SSL_RENEGOTIATION */
5165 {
5166 /*
5167 * Refuse renegotiation
5168 */
5169
5170 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5171
TRodziewicz0f82ec62021-05-12 17:49:18 +02005172#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005173 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
5174 {
5175 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5176 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5177 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
5178 {
5179 return( ret );
5180 }
5181 }
5182 else
TRodziewicz0f82ec62021-05-12 17:49:18 +02005183#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005184 {
5185 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5186 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
5187 }
5188 }
5189
5190 return( 0 );
5191}
5192
Paul Bakker48916f92012-09-16 19:57:18 +00005193/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005194 * Receive application data decrypted from the SSL layer
5195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005197{
Janos Follath865b3eb2019-12-16 11:46:15 +00005198 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005199 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005200
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005201 if( ssl == NULL || ssl->conf == NULL )
5202 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005204 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005207 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005208 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005209 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005210 return( ret );
5211
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005212 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005213 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005214 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005215 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005216 return( ret );
5217 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005218 }
5219#endif
5220
Hanno Becker4a810fb2017-05-24 16:27:30 +01005221 /*
5222 * Check if renegotiation is necessary and/or handshake is
5223 * in process. If yes, perform/continue, and fall through
5224 * if an unexpected packet is received while the client
5225 * is waiting for the ServerHello.
5226 *
5227 * (There is no equivalent to the last condition on
5228 * the server-side as it is not treated as within
5229 * a handshake while waiting for the ClientHello
5230 * after a renegotiation request.)
5231 */
5232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005233#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005234 ret = ssl_check_ctr_renegotiate( ssl );
5235 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5236 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005237 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005238 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005239 return( ret );
5240 }
5241#endif
5242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005244 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005246 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5247 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005248 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005250 return( ret );
5251 }
5252 }
5253
Hanno Beckere41158b2017-10-23 13:30:32 +01005254 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005255 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005256 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005257 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005258 if( ssl->f_get_timer != NULL &&
5259 ssl->f_get_timer( ssl->p_timer ) == -1 )
5260 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005261 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005262 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005263
Hanno Becker327c93b2018-08-15 13:56:18 +01005264 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005265 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005266 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5267 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005268
Hanno Becker4a810fb2017-05-24 16:27:30 +01005269 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5270 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005271 }
5272
5273 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005274 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005275 {
5276 /*
5277 * OpenSSL sends empty messages to randomize the IV
5278 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005279 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005281 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005282 return( 0 );
5283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005284 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005285 return( ret );
5286 }
5287 }
5288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005289 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005290 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005291 ret = ssl_handle_hs_message_post_handshake( ssl );
5292 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005293 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005294 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5295 ret );
5296 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005297 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005298
Hanno Beckerf26cc722021-04-21 07:30:13 +01005299 /* At this point, we don't know whether the renegotiation triggered
5300 * by the post-handshake message has been completed or not. The cases
5301 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005302 * 1) The renegotiation is complete. In this case, no new record
5303 * has been read yet.
5304 * 2) The renegotiation is incomplete because the client received
5305 * an application data record while awaiting the ServerHello.
5306 * 3) The renegotiation is incomplete because the client received
5307 * a non-handshake, non-application data message while awaiting
5308 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005309 *
5310 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005311 * - For 1), the next iteration will read a new record and check
5312 * if it's application data.
5313 * - For 2), the loop condition isn't satisfied as application data
5314 * is present, hence continue is the same as break
5315 * - For 3), the loop condition is satisfied and read_record
5316 * will re-deliver the message that was held back by the client
5317 * when expecting the ServerHello.
5318 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005319
Hanno Becker90333da2017-10-10 11:27:13 +01005320 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005321 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005322#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005323 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005324 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005325 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005326 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005327 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005328 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005330 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005332 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005333 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005334 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5338 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005341 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005342 }
5343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5347 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005348 }
5349
5350 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005351
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005352 /* We're going to return something now, cancel timer,
5353 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005355 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005356
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005357#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005358 /* If we requested renego but received AppData, resend HelloRequest.
5359 * Do it now, after setting in_offt, to avoid taking this branch
5360 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005362 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005363 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005364 {
Hanno Becker786300f2020-02-05 10:46:40 +00005365 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005366 {
Hanno Becker786300f2020-02-05 10:46:40 +00005367 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5368 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005369 return( ret );
5370 }
5371 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005373#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005374 }
5375
5376 n = ( len < ssl->in_msglen )
5377 ? len : ssl->in_msglen;
5378
5379 memcpy( buf, ssl->in_offt, n );
5380 ssl->in_msglen -= n;
5381
gabor-mezei-arma3214132020-07-15 10:55:00 +02005382 /* Zeroising the plaintext buffer to erase unused application data
5383 from the memory. */
5384 mbedtls_platform_zeroize( ssl->in_offt, n );
5385
Paul Bakker5121ce52009-01-03 21:22:43 +00005386 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005387 {
5388 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005389 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005390 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005393 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005394 /* more data available */
5395 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005396 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005397
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005399
Paul Bakker23986e52011-04-24 08:57:21 +00005400 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005401}
5402
5403/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005404 * Send application data to be encrypted by the SSL layer, taking care of max
5405 * fragment length and buffer size.
5406 *
5407 * According to RFC 5246 Section 6.2.1:
5408 *
5409 * Zero-length fragments of Application data MAY be sent as they are
5410 * potentially useful as a traffic analysis countermeasure.
5411 *
5412 * Therefore, it is possible that the input message length is 0 and the
5413 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005414 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005415static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005416 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005417{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005418 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5419 const size_t max_len = (size_t) ret;
5420
5421 if( ret < 0 )
5422 {
5423 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5424 return( ret );
5425 }
5426
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005427 if( len > max_len )
5428 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005430 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005433 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5434 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005435 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005437 }
5438 else
5439#endif
5440 len = max_len;
5441 }
Paul Bakker887bd502011-06-08 13:10:54 +00005442
Paul Bakker5121ce52009-01-03 21:22:43 +00005443 if( ssl->out_left != 0 )
5444 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005445 /*
5446 * The user has previously tried to send the data and
5447 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5448 * written. In this case, we expect the high-level write function
5449 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005453 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005454 return( ret );
5455 }
5456 }
Paul Bakker887bd502011-06-08 13:10:54 +00005457 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005458 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005459 /*
5460 * The user is trying to send a message the first time, so we need to
5461 * copy the data into the internal buffers and setup the data structure
5462 * to keep track of partial writes
5463 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005464 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005466 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005467
Hanno Becker67bc7c32018-08-06 11:33:50 +01005468 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005471 return( ret );
5472 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005473 }
5474
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005475 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005476}
5477
5478/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005479 * Write application data (public-facing wrapper)
5480 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005481int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005482{
Janos Follath865b3eb2019-12-16 11:46:15 +00005483 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005484
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005485 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005486
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005487 if( ssl == NULL || ssl->conf == NULL )
5488 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5489
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005490#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005491 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5492 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005493 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005494 return( ret );
5495 }
5496#endif
5497
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005498 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005499 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005500 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005501 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005502 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005503 return( ret );
5504 }
5505 }
5506
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005507 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005508
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005509 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005510
5511 return( ret );
5512}
5513
5514/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005515 * Notify the peer that the connection is being closed
5516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005518{
Janos Follath865b3eb2019-12-16 11:46:15 +00005519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005520
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005521 if( ssl == NULL || ssl->conf == NULL )
5522 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005525
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005526 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005527 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005531 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5532 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5533 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005536 return( ret );
5537 }
5538 }
5539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005541
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005542 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005543}
5544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005545void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005546{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005547 if( transform == NULL )
5548 return;
5549
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5551 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005552
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005553#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 mbedtls_md_free( &transform->md_ctx_enc );
5555 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005556#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005557
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005558 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005559}
5560
Hanno Becker0271f962018-08-16 13:23:47 +01005561#if defined(MBEDTLS_SSL_PROTO_DTLS)
5562
Hanno Becker533ab5f2020-02-05 10:49:13 +00005563void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005564{
5565 unsigned offset;
5566 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5567
5568 if( hs == NULL )
5569 return;
5570
Hanno Becker283f5ef2018-08-24 09:34:47 +01005571 ssl_free_buffered_record( ssl );
5572
Hanno Becker0271f962018-08-16 13:23:47 +01005573 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005574 ssl_buffering_free_slot( ssl, offset );
5575}
5576
5577static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5578 uint8_t slot )
5579{
5580 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5581 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005582
5583 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5584 return;
5585
Hanno Beckere605b192018-08-21 15:59:07 +01005586 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005587 {
Hanno Beckere605b192018-08-21 15:59:07 +01005588 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005589 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005590 mbedtls_free( hs_buf->data );
5591 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005592 }
5593}
5594
5595#endif /* MBEDTLS_SSL_PROTO_DTLS */
5596
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005597/*
5598 * Convert version numbers to/from wire format
5599 * and, for DTLS, to/from TLS equivalent.
5600 *
5601 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005602 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005603 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5604 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005606void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005607 unsigned char ver[2] )
5608{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005609#if defined(MBEDTLS_SSL_PROTO_DTLS)
5610 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005613 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5614
5615 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5616 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5617 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005618 else
5619#else
5620 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005621#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005622 {
5623 ver[0] = (unsigned char) major;
5624 ver[1] = (unsigned char) minor;
5625 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005626}
5627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005628void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005629 const unsigned char ver[2] )
5630{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005631#if defined(MBEDTLS_SSL_PROTO_DTLS)
5632 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005633 {
5634 *major = 255 - ver[0] + 2;
5635 *minor = 255 - ver[1] + 1;
5636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005637 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005638 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5639 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005640 else
5641#else
5642 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005643#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005644 {
5645 *major = ver[0];
5646 *minor = ver[1];
5647 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005648}
5649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005650#endif /* MBEDTLS_SSL_TLS_C */