blob: fe7d1e5cb85fcbe000b2dcccc07c93f705b11204 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#if defined(MBEDTLS_PLATFORM_C)
30#include "mbedtls/platform.h"
31#else
32#include <stdlib.h>
33#define mbedtls_calloc calloc
34#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010035#endif
36
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000038#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000039#include "mbedtls/debug.h"
40#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050041#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010042#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020043#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020044#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020045
Rich Evans00ab4702015-02-06 13:43:58 +000046#include <string.h>
47
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050048#if defined(MBEDTLS_USE_PSA_CRYPTO)
49#include "mbedtls/psa_util.h"
50#include "psa/crypto.h"
51#endif
52
Janos Follath23bdca02016-10-07 14:47:14 +010053#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020055#endif
56
Hanno Beckercd9dcda2018-08-28 17:18:56 +010057static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010058
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020059/*
60 * Start a timer.
61 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062 */
Hanno Becker0f57a652020-02-05 10:37:26 +000063void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020065 if( ssl->f_set_timer == NULL )
66 return;
67
68 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
69 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070}
71
72/*
73 * Return -1 is timer is expired, 0 if it isn't.
74 */
Hanno Becker7876d122020-02-05 10:39:31 +000075int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020078 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020079
80 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020081 {
82 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020084 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020085
86 return( 0 );
87}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
94int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
98 int ret = 0;
99 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200103 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200104 */
105 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
106 {
107 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
108 goto exit;
109 }
110#if defined(MBEDTLS_SSL_PROTO_DTLS)
111 else
112 {
113 mbedtls_record rec;
114
115 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
116 if( ret != 0 )
117 {
118 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
119 goto exit;
120 }
121
122 if( ssl->transform_in != NULL )
123 {
124 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
128 goto exit;
129 }
130 }
131 }
132#endif /* MBEDTLS_SSL_PROTO_DTLS */
133
134exit:
135 /* On success, we have decrypted the buffer in-place, so make
136 * sure we don't leak any plaintext data. */
137 mbedtls_platform_zeroize( buf, buflen );
138
139 /* For the purpose of this API, treat messages with unexpected CID
140 * as well as such from future epochs as unexpected. */
141 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
142 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
143 {
144 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
145 }
146
147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
148 return( ret );
149}
150
Hanno Becker67bc7c32018-08-06 11:33:50 +0100151#define SSL_DONT_FORCE_FLUSH 0
152#define SSL_FORCE_FLUSH 1
153
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100155
Hanno Beckerd5847772018-08-28 10:09:23 +0100156/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100157static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
158 uint8_t slot );
159static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
160static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
161static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
162static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100163static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
164 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100165static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100166
Hanno Becker11682cc2018-08-22 14:41:02 +0100167static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100168{
Hanno Becker89490712020-02-05 10:50:12 +0000169 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000170#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
171 size_t out_buf_len = ssl->out_buf_len;
172#else
173 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
174#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100175
Darryl Greenb33cc762019-11-28 14:29:44 +0000176 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100177 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178
Darryl Greenb33cc762019-11-28 14:29:44 +0000179 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180}
181
Hanno Becker67bc7c32018-08-06 11:33:50 +0100182static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
183{
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 size_t const bytes_written = ssl->out_left;
185 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100186
187 /* Double-check that the write-index hasn't gone
188 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190 {
191 /* Should never happen... */
192 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
193 }
194
195 return( (int) ( mtu - bytes_written ) );
196}
197
198static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
199{
Janos Follath865b3eb2019-12-16 11:46:15 +0000200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100201 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400202 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
204#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400205 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100206
207 if( max_len > mfl )
208 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100209
210 /* By the standard (RFC 6066 Sect. 4), the MFL extension
211 * only limits the maximum record payload size, so in theory
212 * we would be allowed to pack multiple records of payload size
213 * MFL into a single datagram. However, this would mean that there's
214 * no way to explicitly communicate MTU restrictions to the peer.
215 *
216 * The following reduction of max_len makes sure that we never
217 * write datagrams larger than MFL + Record Expansion Overhead.
218 */
219 if( max_len <= ssl->out_left )
220 return( 0 );
221
222 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100223#endif
224
225 ret = ssl_get_remaining_space_in_datagram( ssl );
226 if( ret < 0 )
227 return( ret );
228 remaining = (size_t) ret;
229
230 ret = mbedtls_ssl_get_record_expansion( ssl );
231 if( ret < 0 )
232 return( ret );
233 expansion = (size_t) ret;
234
235 if( remaining <= expansion )
236 return( 0 );
237
238 remaining -= expansion;
239 if( remaining >= max_len )
240 remaining = max_len;
241
242 return( (int) remaining );
243}
244
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200245/*
246 * Double the retransmit timeout value, within the allowed range,
247 * returning -1 if the maximum value has already been reached.
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200250{
251 uint32_t new_timeout;
252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200253 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254 return( -1 );
255
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200256 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
257 * in the following way: after the initial transmission and a first
258 * retransmission, back off to a temporary estimated MTU of 508 bytes.
259 * This value is guaranteed to be deliverable (if not guaranteed to be
260 * delivered) of any compliant IPv4 (and IPv6) network, and should work
261 * on most non-IP stacks too. */
262 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400263 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
266 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200268 new_timeout = 2 * ssl->handshake->retransmit_timeout;
269
270 /* Avoid arithmetic overflow and range overflow */
271 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200272 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200273 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200274 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 }
276
277 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
279 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280
281 return( 0 );
282}
283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100292/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000293 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200294 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000295
Ronald Cron6f135e12021-12-08 16:57:54 +0100296#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100297
298static size_t ssl_compute_padding_length( size_t len,
299 size_t granularity )
300{
301 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
302}
303
Hanno Becker581bc1b2020-05-04 12:20:03 +0100304/* This functions transforms a (D)TLS plaintext fragment and a record content
305 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
306 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
307 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100308 *
309 * struct {
310 * opaque content[DTLSPlaintext.length];
311 * ContentType real_type;
312 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100313 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100314 *
315 * Input:
316 * - `content`: The beginning of the buffer holding the
317 * plaintext to be wrapped.
318 * - `*content_size`: The length of the plaintext in Bytes.
319 * - `max_len`: The number of Bytes available starting from
320 * `content`. This must be `>= *content_size`.
321 * - `rec_type`: The desired record content type.
322 *
323 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100324 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
325 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100326 *
327 * Returns:
328 * - `0` on success.
329 * - A negative error code if `max_len` didn't offer enough space
330 * for the expansion.
331 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100332static int ssl_build_inner_plaintext( unsigned char *content,
333 size_t *content_size,
334 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100335 uint8_t rec_type,
336 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100337{
338 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339
340 /* Write real content type */
341 if( remaining == 0 )
342 return( -1 );
343 content[ len ] = rec_type;
344 len++;
345 remaining--;
346
347 if( remaining < pad )
348 return( -1 );
349 memset( content + len, 0, pad );
350 len += pad;
351 remaining -= pad;
352
353 *content_size = len;
354 return( 0 );
355}
356
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357/* This function parses a (D)TLSInnerPlaintext structure.
358 * See ssl_build_inner_plaintext() for details. */
359static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100360 size_t *content_size,
361 uint8_t *rec_type )
362{
363 size_t remaining = *content_size;
364
365 /* Determine length of padding by skipping zeroes from the back. */
366 do
367 {
368 if( remaining == 0 )
369 return( -1 );
370 remaining--;
371 } while( content[ remaining ] == 0 );
372
373 *content_size = remaining;
374 *rec_type = content[ remaining ];
375
376 return( 0 );
377}
Ronald Cron6f135e12021-12-08 16:57:54 +0100378#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100380/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100381 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000382static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100383 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100384 mbedtls_record *rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000385 unsigned minor_ver,
386 size_t taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000387{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100388 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100389 *
390 * additional_data = seq_num + TLSCompressed.type +
391 * TLSCompressed.version + TLSCompressed.length;
392 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100393 * For the CID extension, this is extended as follows
394 * (quoting draft-ietf-tls-dtls-connection-id-05,
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100396 *
397 * additional_data = seq_num + DTLSPlaintext.type +
398 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100399 * cid +
400 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100401 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100402 *
403 * For TLS 1.3, the record sequence number is dropped from the AAD
404 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000405 * Moreover, the additional data involves the length of the TLS
406 * ciphertext, not the TLS plaintext as in earlier versions.
407 * Quoting RFC 8446 (TLS 1.3):
408 *
409 * additional_data = TLSCiphertext.opaque_type ||
410 * TLSCiphertext.legacy_record_version ||
411 * TLSCiphertext.length
412 *
413 * We pass the tag length to this function in order to compute the
414 * ciphertext length from the inner plaintext length rec->data_len via
415 *
416 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
417 *
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 */
419
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100420 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000421 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100422
Ronald Cron6f135e12021-12-08 16:57:54 +0100423#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000424 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
425 {
426 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
427 * which differs from the length of the TLSInnerPlaintext
428 * by the length of the authentication tag. */
429 ad_len_field += taglen;
430 }
431 else
Ronald Cron6f135e12021-12-08 16:57:54 +0100432#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100433 {
434 ((void) minor_ver);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000435 ((void) taglen);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
437 cur += sizeof( rec->ctr );
438 }
439
440 *cur = rec->type;
441 cur++;
442
443 memcpy( cur, rec->ver, sizeof( rec->ver ) );
444 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100445
Hanno Beckera0e20d02019-05-15 14:03:01 +0100446#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100447 if( rec->cid_len != 0 )
448 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 memcpy( cur, rec->cid, rec->cid_len );
450 cur += rec->cid_len;
451
452 *cur = rec->cid_len;
453 cur++;
454
Joe Subbiani6dd73642021-07-19 11:56:54 +0100455 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
Joe Subbiani6dd73642021-07-19 11:56:54 +0100461 MBEDTLS_PUT_UINT16_BE( ad_len_field, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100462 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464
465 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000466}
467
Hanno Becker67a37db2020-05-28 16:27:07 +0100468#if defined(MBEDTLS_GCM_C) || \
469 defined(MBEDTLS_CCM_C) || \
470 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100471static int ssl_transform_aead_dynamic_iv_is_explicit(
472 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100473{
Hanno Becker17263802020-05-28 07:05:48 +0100474 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100475}
476
Hanno Becker17263802020-05-28 07:05:48 +0100477/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
478 *
479 * Concretely, this occurs in two variants:
480 *
481 * a) Fixed and dynamic IV lengths add up to total IV length, giving
482 * IV = fixed_iv || dynamic_iv
483 *
Hanno Becker15952812020-06-04 13:31:46 +0100484 * This variant is used in TLS 1.2 when used with GCM or CCM.
485 *
Hanno Becker17263802020-05-28 07:05:48 +0100486 * b) Fixed IV lengths matches total IV length, giving
487 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100488 *
489 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
490 *
491 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100492 *
493 * This function has the precondition that
494 *
495 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
496 *
497 * which has to be ensured by the caller. If this precondition
498 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100499 */
500static void ssl_build_record_nonce( unsigned char *dst_iv,
501 size_t dst_iv_len,
502 unsigned char const *fixed_iv,
503 size_t fixed_iv_len,
504 unsigned char const *dynamic_iv,
505 size_t dynamic_iv_len )
506{
507 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100508
509 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100510 memset( dst_iv, 0, dst_iv_len );
511 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100512
Hanno Becker17263802020-05-28 07:05:48 +0100513 dst_iv += dst_iv_len - dynamic_iv_len;
514 for( i = 0; i < dynamic_iv_len; i++ )
515 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100516}
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100518
Hanno Beckera18d1322018-01-03 14:27:32 +0000519int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
520 mbedtls_ssl_transform *transform,
521 mbedtls_record *rec,
522 int (*f_rng)(void *, unsigned char *, size_t),
523 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000524{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100526 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000527 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100528 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100529 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 size_t post_avail;
531
532 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000533#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200534 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000535 ((void) ssl);
536#endif
537
538 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200539 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200540#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000542 ((void) f_rng);
543 ((void) p_rng);
544#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100549 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
552 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100553 if( rec == NULL
554 || rec->buf == NULL
555 || rec->buf_len < rec->data_offset
556 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100557#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100558 || rec->cid_len != 0
559#endif
560 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000561 {
562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100564 }
565
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000566 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100567 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000569 data, rec->data_len );
570
571 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
572
573 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
574 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
576 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000577 rec->data_len,
578 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
580 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100581
Hanno Becker92313402020-05-20 13:58:58 +0100582 /* The following two code paths implement the (D)TLSInnerPlaintext
583 * structure present in TLS 1.3 and DTLS 1.2 + CID.
584 *
585 * See ssl_build_inner_plaintext() for more information.
586 *
587 * Note that this changes `rec->data_len`, and hence
588 * `post_avail` needs to be recalculated afterwards.
589 *
590 * Note also that the two code paths cannot occur simultaneously
591 * since they apply to different versions of the protocol. There
592 * is hence no risk of double-addition of the inner plaintext.
593 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100594#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100595 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
596 {
Hanno Becker13996922020-05-28 16:15:19 +0100597 size_t padding =
598 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200599 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100600 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100601 &rec->data_len,
602 post_avail,
603 rec->type,
604 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100605 {
606 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
607 }
608
609 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
610 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100611#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100612
Hanno Beckera0e20d02019-05-15 14:03:01 +0100613#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100614 /*
615 * Add CID information
616 */
617 rec->cid_len = transform->out_cid_len;
618 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
619 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620
621 if( rec->cid_len != 0 )
622 {
Hanno Becker13996922020-05-28 16:15:19 +0100623 size_t padding =
624 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200625 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100626 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100627 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100628 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100629 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100630 * Note that this changes `rec->data_len`, and hence
631 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100632 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100633 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100634 &rec->data_len,
635 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100636 rec->type,
637 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 {
639 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
640 }
641
642 rec->type = MBEDTLS_SSL_MSG_CID;
643 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100644#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100645
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100646 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
647
Paul Bakker5121ce52009-01-03 21:22:43 +0000648 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100649 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000650 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000651#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 if( mode == MBEDTLS_MODE_STREAM ||
653 ( mode == MBEDTLS_MODE_CBC
654#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000655 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100656#endif
657 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000658 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000659 if( post_avail < transform->maclen )
660 {
661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
662 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
663 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200665 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000667
TRodziewicz345165c2021-07-06 13:42:11 +0200668 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000669 transform->minor_ver,
670 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000671
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100672 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
673 add_data_len );
674 if( ret != 0 )
675 goto hmac_failed_etm_disabled;
676 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
677 if( ret != 0 )
678 goto hmac_failed_etm_disabled;
679 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
680 if( ret != 0 )
681 goto hmac_failed_etm_disabled;
682 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
683 if( ret != 0 )
684 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000685
TRodziewicz345165c2021-07-06 13:42:11 +0200686 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200687#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200688
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000689 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
690 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200691
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000692 rec->data_len += transform->maclen;
693 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100694 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100695
696 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100697 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100698 if( ret != 0 )
699 {
700 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
701 return( ret );
702 }
Paul Bakker577e0062013-08-28 11:57:20 +0200703 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000704#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000705
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200706 /*
707 * Encrypt
708 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000709#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000711 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000712 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000713 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100714#if defined(MBEDTLS_USE_PSA_CRYPTO)
715 psa_status_t status;
716 size_t part_len;
717 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
718
719#endif /* MBEDTLS_USE_PSA_CRYPTO */
720
Paul Elliottd48d5c62021-01-07 14:47:05 +0000721 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000722 "including %d bytes of padding",
723 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000724
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100725#if defined(MBEDTLS_USE_PSA_CRYPTO)
726 status = psa_cipher_encrypt_setup( &cipher_op,
727 transform->psa_key_enc, transform->psa_alg );
728
729 if( status != PSA_SUCCESS )
730 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
731
732 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
733
734 if( status != PSA_SUCCESS )
735 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
736
737 status = psa_cipher_update( &cipher_op,
738 data, rec->data_len,
739 data, rec->data_len, &olen );
740
741 if( status != PSA_SUCCESS )
742 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
743
744 status = psa_cipher_finish( &cipher_op,
745 data + olen, rec->data_len - olen,
746 &part_len );
747
748 if( status != PSA_SUCCESS )
749 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
750
751 olen += part_len;
752#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
754 transform->iv_enc, transform->ivlen,
755 data, rec->data_len,
756 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200759 return( ret );
760 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100761#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200762
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000763 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
766 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200767 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000768 }
Paul Bakker68884e32013-01-07 18:20:04 +0100769 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000770#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000771
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200772#if defined(MBEDTLS_GCM_C) || \
773 defined(MBEDTLS_CCM_C) || \
774 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200776 mode == MBEDTLS_MODE_CCM ||
777 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000778 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200780 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100781 unsigned char *dynamic_iv;
782 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100783 int dynamic_iv_is_explicit =
784 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100785#if defined(MBEDTLS_USE_PSA_CRYPTO)
786 psa_status_t status;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100787#endif /* MBEDTLS_USE_PSA_CRYPTO */
788
Paul Bakkerca4ab492012-04-18 14:23:57 +0000789
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100790 /* Check that there's space for the authentication tag. */
791 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000792 {
793 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
794 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
795 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000796
Paul Bakker68884e32013-01-07 18:20:04 +0100797 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100798 * Build nonce for AEAD encryption.
799 *
800 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
801 * part of the IV is prepended to the ciphertext and
802 * can be chosen freely - in particular, it need not
803 * agree with the record sequence number.
804 * However, since ChaChaPoly as well as all AEAD modes
805 * in TLS 1.3 use the record sequence number as the
806 * dynamic part of the nonce, we uniformly use the
807 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100808 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100809 dynamic_iv = rec->ctr;
810 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200811
Hanno Becker17263802020-05-28 07:05:48 +0100812 ssl_build_record_nonce( iv, sizeof( iv ),
813 transform->iv_enc,
814 transform->fixed_ivlen,
815 dynamic_iv,
816 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100817
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100818 /*
819 * Build additional data for AEAD encryption.
820 * This depends on the TLS version.
821 */
822 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000823 transform->minor_ver,
824 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100825
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200826 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100827 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200828 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100829 dynamic_iv,
830 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000831 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100832 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000833 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200834 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000835 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000836
Paul Bakker68884e32013-01-07 18:20:04 +0100837 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200838 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200839 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100840#if defined(MBEDTLS_USE_PSA_CRYPTO)
841 status = psa_aead_encrypt( transform->psa_key_enc,
842 transform->psa_alg,
843 iv, transform->ivlen,
844 add_data, add_data_len,
845 data, rec->data_len,
846 data, rec->buf_len - (data - rec->buf),
847 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000848
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100849 if( status != PSA_SUCCESS )
850 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
851#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100852 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100854 add_data, add_data_len,
855 data, rec->data_len, /* src */
856 data, rec->buf_len - (data - rec->buf), /* dst */
857 &rec->data_len,
858 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200859 {
TRodziewicz18efb732021-04-29 23:12:19 +0200860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 return( ret );
862 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100863#endif /* MBEDTLS_USE_PSA_CRYPTO */
864
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100866 data + rec->data_len - transform->taglen,
867 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000869 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100870
871 /*
872 * Prefix record content with dynamic IV in case it is explicit.
873 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100874 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100875 {
876 if( rec->data_offset < dynamic_iv_len )
877 {
878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
879 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
880 }
881
882 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
883 rec->data_offset -= dynamic_iv_len;
884 rec->data_len += dynamic_iv_len;
885 }
886
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100887 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000888 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000889 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100890#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200891#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000893 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000894 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000895 size_t padlen, i;
896 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100897#if defined(MBEDTLS_USE_PSA_CRYPTO)
898 psa_status_t status;
899 size_t part_len;
900 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
901#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000902
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 /* Currently we're always using minimal padding
904 * (up to 255 bytes would be allowed). */
905 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
906 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000907 padlen = 0;
908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 /* Check there's enough space in the buffer for the padding. */
910 if( post_avail < padlen + 1 )
911 {
912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
913 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
914 }
915
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000917 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000918
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 rec->data_len += padlen + 1;
920 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921
TRodziewicz0f82ec62021-05-12 17:49:18 +0200922#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000923 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200924 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000925 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000926 */
TRodziewicz345165c2021-07-06 13:42:11 +0200927 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000928 {
TRodziewicz345165c2021-07-06 13:42:11 +0200929 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
930 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000931 }
TRodziewicz345165c2021-07-06 13:42:11 +0200932
933 if( rec->data_offset < transform->ivlen )
934 {
935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
936 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
937 }
938
939 /*
940 * Generate IV
941 */
942 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
943 if( ret != 0 )
944 return( ret );
945
946 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200947#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000948
Paul Elliottd48d5c62021-01-07 14:47:05 +0000949 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
950 "including %" MBEDTLS_PRINTF_SIZET
951 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200953 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000954
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100955#if defined(MBEDTLS_USE_PSA_CRYPTO)
956 status = psa_cipher_encrypt_setup( &cipher_op,
957 transform->psa_key_enc, transform->psa_alg );
958
959 if( status != PSA_SUCCESS )
960 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
961
962 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
963
964 if( status != PSA_SUCCESS )
965 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
966
967 status = psa_cipher_update( &cipher_op,
968 data, rec->data_len,
969 data, rec->data_len, &olen );
970
971 if( status != PSA_SUCCESS )
972 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
973
974 status = psa_cipher_finish( &cipher_op,
975 data + olen, rec->data_len - olen,
976 &part_len );
977
978 if( status != PSA_SUCCESS )
979 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
980
981 olen += part_len;
982#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000983 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
984 transform->iv_enc,
985 transform->ivlen,
986 data, rec->data_len,
987 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200988 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200990 return( ret );
991 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100992#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200993
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000994 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
997 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200998 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200999
TRodziewicz0f82ec62021-05-12 17:49:18 +02001000 data -= transform->ivlen;
1001 rec->data_offset -= transform->ivlen;
1002 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001005 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001006 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001007 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1008
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001009 /*
1010 * MAC(MAC_write_key, seq_num +
1011 * TLSCipherText.type +
1012 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001013 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001014 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001015 * ENC(content + padding + padding_length));
1016 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001017
1018 if( post_avail < transform->maclen)
1019 {
1020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1021 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1022 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001023
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001024 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001025 rec, transform->minor_ver,
1026 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001029 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001030 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001031
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001032 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1033 add_data_len );
1034 if( ret != 0 )
1035 goto hmac_failed_etm_enabled;
1036 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1037 data, rec->data_len );
1038 if( ret != 0 )
1039 goto hmac_failed_etm_enabled;
1040 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1041 if( ret != 0 )
1042 goto hmac_failed_etm_enabled;
1043 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1044 if( ret != 0 )
1045 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001046
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001047 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001048
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001049 rec->data_len += transform->maclen;
1050 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001051 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001052
1053 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001054 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001055 if( ret != 0 )
1056 {
1057 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1058 return( ret );
1059 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001060 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001062 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001063 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001064#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1067 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001068 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001069
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001070 /* Make extra sure authentication was performed, exactly once */
1071 if( auth_done != 1 )
1072 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1074 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001075 }
1076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001078
1079 return( 0 );
1080}
1081
Hanno Becker605949f2019-07-12 08:23:59 +01001082int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001083 mbedtls_ssl_transform *transform,
1084 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001085{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001086 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001088 int ret, auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001089#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001090 size_t padlen = 0, correct = 1;
1091#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001092 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001093 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001094 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001095
Hanno Beckera18d1322018-01-03 14:27:32 +00001096#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001097 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001098 ((void) ssl);
1099#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001102 if( rec == NULL ||
1103 rec->buf == NULL ||
1104 rec->buf_len < rec->data_offset ||
1105 rec->buf_len - rec->data_offset < rec->data_len )
1106 {
1107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001109 }
1110
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001111 data = rec->buf + rec->data_offset;
1112 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001113
Hanno Beckera0e20d02019-05-15 14:03:01 +01001114#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001115 /*
1116 * Match record's CID with incoming CID.
1117 */
Hanno Becker938489a2019-05-08 13:02:22 +01001118 if( rec->cid_len != transform->in_cid_len ||
1119 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1120 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001121 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001122 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001123#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001124
Hanno Beckerd086bf02021-03-22 13:01:27 +00001125#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001127 {
1128 padlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001129#if defined(MBEDTLS_USE_PSA_CRYPTO)
1130 psa_status_t status;
1131 size_t part_len;
1132 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1133#endif /* MBEDTLS_USE_PSA_CRYPTO */
1134
1135#if defined(MBEDTLS_USE_PSA_CRYPTO)
1136 status = psa_cipher_decrypt_setup( &cipher_op,
1137 transform->psa_key_dec, transform->psa_alg );
1138
1139 if( status != PSA_SUCCESS )
1140 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1141
1142 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1143
1144 if( status != PSA_SUCCESS )
1145 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1146
1147 status = psa_cipher_update( &cipher_op,
1148 data, rec->data_len,
1149 data, rec->data_len, &olen );
1150
1151 if( status != PSA_SUCCESS )
1152 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1153
1154 status = psa_cipher_finish( &cipher_op,
1155 data + olen, rec->data_len - olen,
1156 &part_len );
1157
1158 if( status != PSA_SUCCESS )
1159 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1160
1161 olen += part_len;
1162#else
1163
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001164 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1165 transform->iv_dec,
1166 transform->ivlen,
1167 data, rec->data_len,
1168 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001169 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001171 return( ret );
1172 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001173#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001174
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001175 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001176 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1178 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001179 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001180
Paul Bakker5121ce52009-01-03 21:22:43 +00001181 }
Paul Bakker68884e32013-01-07 18:20:04 +01001182 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001183#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001184#if defined(MBEDTLS_GCM_C) || \
1185 defined(MBEDTLS_CCM_C) || \
1186 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001188 mode == MBEDTLS_MODE_CCM ||
1189 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001190 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001191 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001192 unsigned char *dynamic_iv;
1193 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001194#if defined(MBEDTLS_USE_PSA_CRYPTO)
1195 psa_status_t status;
1196#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001197
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001198 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001199 * Extract dynamic part of nonce for AEAD decryption.
1200 *
1201 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1202 * part of the IV is prepended to the ciphertext and
1203 * can be chosen freely - in particular, it need not
1204 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001205 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001206 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001207 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001208 {
1209 if( rec->data_len < dynamic_iv_len )
1210 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001211 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1212 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001213 rec->data_len,
1214 dynamic_iv_len ) );
1215 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1216 }
1217 dynamic_iv = data;
1218
1219 data += dynamic_iv_len;
1220 rec->data_offset += dynamic_iv_len;
1221 rec->data_len -= dynamic_iv_len;
1222 }
Hanno Becker17263802020-05-28 07:05:48 +01001223 else
1224 {
1225 dynamic_iv = rec->ctr;
1226 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001227
1228 /* Check that there's space for the authentication tag. */
1229 if( rec->data_len < transform->taglen )
1230 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1232 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001233 rec->data_len,
1234 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001236 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001237 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001238
Hanno Beckerdf8be222020-05-21 15:30:57 +01001239 /*
1240 * Prepare nonce from dynamic and static parts.
1241 */
Hanno Becker17263802020-05-28 07:05:48 +01001242 ssl_build_record_nonce( iv, sizeof( iv ),
1243 transform->iv_dec,
1244 transform->fixed_ivlen,
1245 dynamic_iv,
1246 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001247
Hanno Beckerdf8be222020-05-21 15:30:57 +01001248 /*
1249 * Build additional data for AEAD encryption.
1250 * This depends on the TLS version.
1251 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001252 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001253 transform->minor_ver,
1254 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001255 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001256 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001257
Hanno Beckerd96a6522019-07-10 13:55:25 +01001258 /* Because of the check above, we know that there are
1259 * explicit_iv_len Bytes preceeding data, and taglen
1260 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001261 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001262 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001263
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001264 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001265 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001266 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001267
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001268 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001269 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001270 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001271#if defined(MBEDTLS_USE_PSA_CRYPTO)
1272 status = psa_aead_decrypt( transform->psa_key_dec,
1273 transform->psa_alg,
1274 iv, transform->ivlen,
1275 add_data, add_data_len,
1276 data, rec->data_len + transform->taglen,
1277 data, rec->buf_len - (data - rec->buf),
1278 &rec->data_len );
1279
1280 if( status != PSA_SUCCESS )
1281 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1282#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001283 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001284 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001285 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001286 data, rec->data_len + transform->taglen, /* src */
1287 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001288 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001289 {
TRodziewicz18efb732021-04-29 23:12:19 +02001290 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1293 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001294
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001295 return( ret );
1296 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001297#endif /* MBEDTLS_USE_PSA_CRYPTO */
1298
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001299 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001300
Hanno Beckerd96a6522019-07-10 13:55:25 +01001301 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001302 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001303 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1305 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001306 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001307 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001310#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001312 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001313 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001314#if defined(MBEDTLS_USE_PSA_CRYPTO)
1315 psa_status_t status;
1316 size_t part_len;
1317 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1318#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001319
Paul Bakker5121ce52009-01-03 21:22:43 +00001320 /*
Paul Bakker45829992013-01-03 14:52:21 +01001321 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001322 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001323#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001324 /* The ciphertext is prefixed with the CBC IV. */
1325 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001326#endif
Paul Bakker45829992013-01-03 14:52:21 +01001327
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001328 /* Size considerations:
1329 *
1330 * - The CBC cipher text must not be empty and hence
1331 * at least of size transform->ivlen.
1332 *
1333 * Together with the potential IV-prefix, this explains
1334 * the first of the two checks below.
1335 *
1336 * - The record must contain a MAC, either in plain or
1337 * encrypted, depending on whether Encrypt-then-MAC
1338 * is used or not.
1339 * - If it is, the message contains the IV-prefix,
1340 * the CBC ciphertext, and the MAC.
1341 * - If it is not, the padded plaintext, and hence
1342 * the CBC ciphertext, has at least length maclen + 1
1343 * because there is at least the padding length byte.
1344 *
1345 * As the CBC ciphertext is not empty, both cases give the
1346 * lower bound minlen + maclen + 1 on the record size, which
1347 * we test for in the second check below.
1348 */
1349 if( rec->data_len < minlen + transform->ivlen ||
1350 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001351 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001352 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1353 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1354 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001355 "+ 1 ) ( + expl IV )", rec->data_len,
1356 transform->ivlen,
1357 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001359 }
1360
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001361 /*
1362 * Authenticate before decrypt if enabled
1363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001365 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001366 {
Hanno Becker992b6872017-11-09 18:57:39 +00001367 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001369 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001370
Hanno Beckerd96a6522019-07-10 13:55:25 +01001371 /* Update data_len in tandem with add_data.
1372 *
1373 * The subtraction is safe because of the previous check
1374 * data_len >= minlen + maclen + 1.
1375 *
1376 * Afterwards, we know that data + data_len is followed by at
1377 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001378 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001379 *
1380 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001381 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001382 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001383 transform->minor_ver,
1384 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001385
Hanno Beckerd96a6522019-07-10 13:55:25 +01001386 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001387 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1388 add_data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001389 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1390 add_data_len );
1391 if( ret != 0 )
1392 goto hmac_failed_etm_enabled;
1393 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001394 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001395 if( ret != 0 )
1396 goto hmac_failed_etm_enabled;
1397 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1398 if( ret != 0 )
1399 goto hmac_failed_etm_enabled;
1400 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1401 if( ret != 0 )
1402 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001403
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001404 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1405 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001406 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001408
Hanno Beckerd96a6522019-07-10 13:55:25 +01001409 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001410 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001411 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001414 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1415 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001416 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001417 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001418
1419 hmac_failed_etm_enabled:
1420 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1421 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001422 {
1423 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1424 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001425 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001426 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001427 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001429
1430 /*
1431 * Check length sanity
1432 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001433
1434 /* We know from above that data_len > minlen >= 0,
1435 * so the following check in particular implies that
1436 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001437 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001438 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1440 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001442 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001443 }
1444
TRodziewicz0f82ec62021-05-12 17:49:18 +02001445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001446 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001447 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001448 */
TRodziewicz345165c2021-07-06 13:42:11 +02001449 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1450 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001451
TRodziewicz345165c2021-07-06 13:42:11 +02001452 data += transform->ivlen;
1453 rec->data_offset += transform->ivlen;
1454 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001456
Hanno Beckerd96a6522019-07-10 13:55:25 +01001457 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1458
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001459#if defined(MBEDTLS_USE_PSA_CRYPTO)
1460 status = psa_cipher_decrypt_setup( &cipher_op,
1461 transform->psa_key_dec, transform->psa_alg );
1462
1463 if( status != PSA_SUCCESS )
1464 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1465
1466 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1467
1468 if( status != PSA_SUCCESS )
1469 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1470
1471 status = psa_cipher_update( &cipher_op,
1472 data, rec->data_len,
1473 data, rec->data_len, &olen );
1474
1475 if( status != PSA_SUCCESS )
1476 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1477
1478 status = psa_cipher_finish( &cipher_op,
1479 data + olen, rec->data_len - olen,
1480 &part_len );
1481
1482 if( status != PSA_SUCCESS )
1483 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
1484
1485 olen += part_len;
1486#else
1487
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001488 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1489 transform->iv_dec, transform->ivlen,
1490 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001491 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001493 return( ret );
1494 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001495#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001496
Hanno Beckerd96a6522019-07-10 13:55:25 +01001497 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001499 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1501 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001502 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001503
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001504 /* Safe since data_len >= minlen + maclen + 1, so after having
1505 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001506 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1507 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001509
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001510 if( auth_done == 1 )
1511 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001512 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001513 rec->data_len,
1514 padlen + 1 );
1515 correct &= mask;
1516 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517 }
1518 else
Paul Bakker45829992013-01-03 14:52:21 +01001519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 if( rec->data_len < transform->maclen + padlen + 1 )
1522 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1524 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1525 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001526 rec->data_len,
1527 transform->maclen,
1528 padlen + 1 ) );
1529 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001530#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001531
Gabor Mezei90437e32021-10-20 11:59:27 +02001532 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001533 rec->data_len,
1534 transform->maclen + padlen + 1 );
1535 correct &= mask;
1536 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001537 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001538
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001539 padlen++;
1540
1541 /* Regardless of the validity of the padding,
1542 * we have data_len >= padlen here. */
1543
TRodziewicz0f82ec62021-05-12 17:49:18 +02001544#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001545 /* The padding check involves a series of up to 256
1546 * consecutive memory reads at the end of the record
1547 * plaintext buffer. In order to hide the length and
1548 * validity of the padding, always perform exactly
1549 * `min(256,plaintext_len)` reads (but take into account
1550 * only the last `padlen` bytes for the padding check). */
1551 size_t pad_count = 0;
1552 volatile unsigned char* const check = data;
1553
1554 /* Index of first padding byte; it has been ensured above
1555 * that the subtraction is safe. */
1556 size_t const padding_idx = rec->data_len - padlen;
1557 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1558 size_t const start_idx = rec->data_len - num_checks;
1559 size_t idx;
1560
1561 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001562 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001563 /* pad_count += (idx >= padding_idx) &&
1564 * (check[idx] == padlen - 1);
1565 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001566 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1567 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001568 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001569 pad_count += mask & equal;
1570 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001571 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001574 if( padlen > 0 && correct == 0 )
1575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001576#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001577 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001578
TRodziewicz0f82ec62021-05-12 17:49:18 +02001579#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001580
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001581 /* If the padding was found to be invalid, padlen == 0
1582 * and the subtraction is safe. If the padding was found valid,
1583 * padlen hasn't been changed and the previous assertion
1584 * data_len >= padlen still holds. */
1585 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001586 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001587 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001588#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1591 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001592 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001593
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001594#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001596 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001597#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001598
1599 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001600 * Authenticate if not done yet.
1601 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001602 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001603#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001604 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001605 {
Hanno Becker992b6872017-11-09 18:57:39 +00001606 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001607 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001608
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001609 /* If the initial value of padlen was such that
1610 * data_len < maclen + padlen + 1, then padlen
1611 * got reset to 1, and the initial check
1612 * data_len >= minlen + maclen + 1
1613 * guarantees that at this point we still
1614 * have at least data_len >= maclen.
1615 *
1616 * If the initial value of padlen was such that
1617 * data_len >= maclen + padlen + 1, then we have
1618 * subtracted either padlen + 1 (if the padding was correct)
1619 * or 0 (if the padding was incorrect) since then,
1620 * hence data_len >= maclen in any case.
1621 */
1622 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001623 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001624 transform->minor_ver,
1625 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001626
TRodziewicz0f82ec62021-05-12 17:49:18 +02001627#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001628 /*
1629 * The next two sizes are the minimum and maximum values of
1630 * data_len over all padlen values.
1631 *
1632 * They're independent of padlen, since we previously did
1633 * data_len -= padlen.
1634 *
1635 * Note that max_len + maclen is never more than the buffer
1636 * length, as we previously did in_msglen -= maclen too.
1637 */
1638 const size_t max_len = rec->data_len + padlen;
1639 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1640
Gabor Mezei90437e32021-10-20 11:59:27 +02001641 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001642 add_data, add_data_len,
1643 data, rec->data_len, min_len, max_len,
1644 mac_expect );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001645 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001646 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001647 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001648 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001649 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001650
Gabor Mezei90437e32021-10-20 11:59:27 +02001651 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001652 rec->data_len,
1653 min_len, max_len,
1654 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001655#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001656
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001657#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001658 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001659 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001660#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001661
Gabor Mezei90437e32021-10-20 11:59:27 +02001662 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001663 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#if defined(MBEDTLS_SSL_DEBUG_ALL)
1666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001667#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001668 correct = 0;
1669 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001670 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001671
1672 hmac_failed_etm_disabled:
1673 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1674 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1675 if( ret != 0 )
1676 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001677 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001678
1679 /*
1680 * Finally check the correct flag
1681 */
1682 if( correct == 0 )
1683 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001684#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001685
1686 /* Make extra sure authentication was performed, exactly once */
1687 if( auth_done != 1 )
1688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1690 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001691 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001692
Ronald Cron6f135e12021-12-08 16:57:54 +01001693#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001694 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1695 {
1696 /* Remove inner padding and infer true content type. */
1697 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1698 &rec->type );
1699
1700 if( ret != 0 )
1701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1702 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001703#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001704
Hanno Beckera0e20d02019-05-15 14:03:01 +01001705#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001706 if( rec->cid_len != 0 )
1707 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001708 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1709 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001710 if( ret != 0 )
1711 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1712 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001713#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
1717 return( 0 );
1718}
1719
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001720#undef MAC_NONE
1721#undef MAC_PLAINTEXT
1722#undef MAC_CIPHERTEXT
1723
Paul Bakker5121ce52009-01-03 21:22:43 +00001724/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001725 * Fill the input message buffer by appending data to it.
1726 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001727 *
1728 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1729 * available (from this read and/or a previous one). Otherwise, an error code
1730 * is returned (possibly EOF or WANT_READ).
1731 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001732 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1733 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1734 * since we always read a whole datagram at once.
1735 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001736 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001737 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001740{
Janos Follath865b3eb2019-12-16 11:46:15 +00001741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001742 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001743#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1744 size_t in_buf_len = ssl->in_buf_len;
1745#else
1746 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1747#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001750
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001751 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001754 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001755 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001756 }
1757
Darryl Greenb33cc762019-11-28 14:29:44 +00001758 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1761 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001762 }
1763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001766 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001767 uint32_t timeout;
1768
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001769 /*
1770 * The point is, we need to always read a full datagram at once, so we
1771 * sometimes read more then requested, and handle the additional data.
1772 * It could be the rest of the current record (while fetching the
1773 * header) and/or some other records in the same datagram.
1774 */
1775
1776 /*
1777 * Move to the next record in the already read datagram if applicable
1778 */
1779 if( ssl->next_record_offset != 0 )
1780 {
1781 if( ssl->in_left < ssl->next_record_offset )
1782 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1784 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001785 }
1786
1787 ssl->in_left -= ssl->next_record_offset;
1788
1789 if( ssl->in_left != 0 )
1790 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1792 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001793 ssl->next_record_offset ) );
1794 memmove( ssl->in_hdr,
1795 ssl->in_hdr + ssl->next_record_offset,
1796 ssl->in_left );
1797 }
1798
1799 ssl->next_record_offset = 0;
1800 }
1801
Paul Elliottd48d5c62021-01-07 14:47:05 +00001802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1803 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001804 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001805
1806 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001807 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001808 */
1809 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001812 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001813 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001814
1815 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001816 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001817 * are not at the beginning of a new record, the caller did something
1818 * wrong.
1819 */
1820 if( ssl->in_left != 0 )
1821 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1823 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001824 }
1825
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001826 /*
1827 * Don't even try to read if time's out already.
1828 * This avoids by-passing the timer when repeatedly receiving messages
1829 * that will end up being dropped.
1830 */
Hanno Becker7876d122020-02-05 10:39:31 +00001831 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001832 {
1833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001834 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001835 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001836 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001837 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001838 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001841 timeout = ssl->handshake->retransmit_timeout;
1842 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001843 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001844
Paul Elliott9f352112020-12-09 14:55:45 +00001845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001846
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001847 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001848 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1849 timeout );
1850 else
1851 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001853 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001854
1855 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001857 }
1858
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001859 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001860 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001862 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001865 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001866 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1867 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001869 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001870 }
1871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001873 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001875 return( ret );
1876 }
1877
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001878 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001879 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001881 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001883 {
Hanno Becker786300f2020-02-05 10:46:40 +00001884 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001885 {
Hanno Becker786300f2020-02-05 10:46:40 +00001886 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1887 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001888 return( ret );
1889 }
1890
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001891 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001892 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001894 }
1895
Paul Bakker5121ce52009-01-03 21:22:43 +00001896 if( ret < 0 )
1897 return( ret );
1898
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001899 ssl->in_left = ret;
1900 }
1901 else
1902#endif
1903 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1905 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001906 ssl->in_left, nb_want ) );
1907
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001908 while( ssl->in_left < nb_want )
1909 {
1910 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001911
Hanno Becker7876d122020-02-05 10:39:31 +00001912 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001913 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1914 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001915 {
1916 if( ssl->f_recv_timeout != NULL )
1917 {
1918 ret = ssl->f_recv_timeout( ssl->p_bio,
1919 ssl->in_hdr + ssl->in_left, len,
1920 ssl->conf->read_timeout );
1921 }
1922 else
1923 {
1924 ret = ssl->f_recv( ssl->p_bio,
1925 ssl->in_hdr + ssl->in_left, len );
1926 }
1927 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001928
Paul Elliottd48d5c62021-01-07 14:47:05 +00001929 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1930 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001931 ssl->in_left, nb_want ) );
1932 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
1934 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001936
1937 if( ret < 0 )
1938 return( ret );
1939
makise-homuraaf9513b2020-08-24 18:26:27 +03001940 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001941 {
Darryl Green11999bb2018-03-13 15:22:58 +00001942 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001943 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00001944 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001945 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1946 }
1947
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001948 ssl->in_left += ret;
1949 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001950 }
1951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001953
1954 return( 0 );
1955}
1956
1957/*
1958 * Flush any data not yet written
1959 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001961{
Janos Follath865b3eb2019-12-16 11:46:15 +00001962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001963 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001966
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001967 if( ssl->f_send == NULL )
1968 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001970 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001972 }
1973
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001974 /* Avoid incrementing counter if data is flushed */
1975 if( ssl->out_left == 0 )
1976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001978 return( 0 );
1979 }
1980
Paul Bakker5121ce52009-01-03 21:22:43 +00001981 while( ssl->out_left > 0 )
1982 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
1984 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01001985 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001986
Hanno Becker2b1e3542018-08-06 11:19:13 +01001987 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001988 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001991
1992 if( ret <= 0 )
1993 return( ret );
1994
makise-homuraaf9513b2020-08-24 18:26:27 +03001995 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001996 {
Darryl Green11999bb2018-03-13 15:22:58 +00001997 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00001998 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00001999 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002000 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2001 }
2002
Paul Bakker5121ce52009-01-03 21:22:43 +00002003 ssl->out_left -= ret;
2004 }
2005
Hanno Becker2b1e3542018-08-06 11:19:13 +01002006#if defined(MBEDTLS_SSL_PROTO_DTLS)
2007 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002008 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002009 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002010 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002011 else
2012#endif
2013 {
2014 ssl->out_hdr = ssl->out_buf + 8;
2015 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002016 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002019
2020 return( 0 );
2021}
2022
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002023/*
2024 * Functions to handle the DTLS retransmission state machine
2025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002027/*
2028 * Append current handshake message to current outgoing flight
2029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002031{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2034 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2035 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002036
2037 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002038 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002039 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002040 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002042 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002043 }
2044
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002045 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002046 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002047 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2048 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002050 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002051 }
2052
2053 /* Copy current handshake message with headers */
2054 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2055 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002056 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002057 msg->next = NULL;
2058
2059 /* Append to the current flight */
2060 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002061 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002062 else
2063 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002064 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002065 while( cur->next != NULL )
2066 cur = cur->next;
2067 cur->next = msg;
2068 }
2069
Hanno Becker3b235902018-08-06 09:54:53 +01002070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002071 return( 0 );
2072}
2073
2074/*
2075 * Free the current flight of handshake messages
2076 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002077void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002078{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 mbedtls_ssl_flight_item *cur = flight;
2080 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002081
2082 while( cur != NULL )
2083 {
2084 next = cur->next;
2085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086 mbedtls_free( cur->p );
2087 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002088
2089 cur = next;
2090 }
2091}
2092
2093/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002094 * Swap transform_out and out_ctr with the alternative ones
2095 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002096static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002097{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002099 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002100
2101 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002104 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105 }
2106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002108
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002109 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110 tmp_transform = ssl->transform_out;
2111 ssl->transform_out = ssl->handshake->alt_transform_out;
2112 ssl->handshake->alt_transform_out = tmp_transform;
2113
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002114 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002115 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2116 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2117 sizeof( ssl->cur_out_ctr ) );
2118 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2119 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002120
2121 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002122 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002123
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002124 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002125}
2126
2127/*
2128 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002129 */
2130int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2131{
2132 int ret = 0;
2133
2134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2135
2136 ret = mbedtls_ssl_flight_transmit( ssl );
2137
2138 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2139
2140 return( ret );
2141}
2142
2143/*
2144 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002145 *
2146 * Need to remember the current message in case flush_output returns
2147 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002148 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002150int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002151{
Janos Follath865b3eb2019-12-16 11:46:15 +00002152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002153 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002156 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002158
2159 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002160 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002161 ret = ssl_swap_epochs( ssl );
2162 if( ret != 0 )
2163 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002166 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002167
2168 while( ssl->handshake->cur_msg != NULL )
2169 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002170 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002171 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002172
Hanno Beckere1dcb032018-08-17 16:47:58 +01002173 int const is_finished =
2174 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2175 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2176
Hanno Becker04da1892018-08-14 13:22:10 +01002177 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2178 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2179
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002180 /* Swap epochs before sending Finished: we can't do it after
2181 * sending ChangeCipherSpec, in case write returns WANT_READ.
2182 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002183 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002184 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002185 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002186 ret = ssl_swap_epochs( ssl );
2187 if( ret != 0 )
2188 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002189 }
2190
Hanno Becker67bc7c32018-08-06 11:33:50 +01002191 ret = ssl_get_remaining_payload_in_datagram( ssl );
2192 if( ret < 0 )
2193 return( ret );
2194 max_frag_len = (size_t) ret;
2195
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002196 /* CCS is copied as is, while HS messages may need fragmentation */
2197 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2198 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002199 if( max_frag_len == 0 )
2200 {
2201 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2202 return( ret );
2203
2204 continue;
2205 }
2206
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002207 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002208 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002209 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002210
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002211 /* Update position inside current message */
2212 ssl->handshake->cur_msg_p += cur->len;
2213 }
2214 else
2215 {
2216 const unsigned char * const p = ssl->handshake->cur_msg_p;
2217 const size_t hs_len = cur->len - 12;
2218 const size_t frag_off = p - ( cur->p + 12 );
2219 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002220 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002221
Hanno Beckere1dcb032018-08-17 16:47:58 +01002222 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002223 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002224 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002225 {
2226 ret = ssl_swap_epochs( ssl );
2227 if( ret != 0 )
2228 return( ret );
2229 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002230
Hanno Becker67bc7c32018-08-06 11:33:50 +01002231 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2232 return( ret );
2233
2234 continue;
2235 }
2236 max_hs_frag_len = max_frag_len - 12;
2237
2238 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2239 max_hs_frag_len : rem_len;
2240
2241 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002242 {
2243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002244 (unsigned) cur_hs_frag_len,
2245 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002246 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002247
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002248 /* Messages are stored with handshake headers as if not fragmented,
2249 * copy beginning of headers then fill fragmentation fields.
2250 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2251 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002252
Joe Subbiani5ecac212021-06-24 13:00:03 +01002253 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2254 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2255 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002256
Joe Subbiani5ecac212021-06-24 13:00:03 +01002257 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2258 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2259 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002260
2261 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2262
Hanno Becker3f7b9732018-08-28 09:53:25 +01002263 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002264 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2265 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002266 ssl->out_msgtype = cur->type;
2267
2268 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002269 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002270 }
2271
2272 /* If done with the current message move to the next one if any */
2273 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2274 {
2275 if( cur->next != NULL )
2276 {
2277 ssl->handshake->cur_msg = cur->next;
2278 ssl->handshake->cur_msg_p = cur->next->p + 12;
2279 }
2280 else
2281 {
2282 ssl->handshake->cur_msg = NULL;
2283 ssl->handshake->cur_msg_p = NULL;
2284 }
2285 }
2286
2287 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002288 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002289 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291 return( ret );
2292 }
2293 }
2294
Hanno Becker67bc7c32018-08-06 11:33:50 +01002295 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2296 return( ret );
2297
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002298 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2300 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002301 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002302 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002304 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002305 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002306
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002308
2309 return( 0 );
2310}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002311
2312/*
2313 * To be called when the last message of an incoming flight is received.
2314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002316{
2317 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002318 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002319 ssl->handshake->flight = NULL;
2320 ssl->handshake->cur_msg = NULL;
2321
2322 /* The next incoming flight will start with this msg_seq */
2323 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2324
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002325 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002326 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002327
Hanno Becker0271f962018-08-16 13:23:47 +01002328 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002329 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002330
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002331 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002332 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2335 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002338 }
2339 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002341}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002342
2343/*
2344 * To be called when the last message of an outgoing flight is send.
2345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002347{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002348 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002349 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2352 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002353 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002355 }
2356 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002358}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002360
Paul Bakker5121ce52009-01-03 21:22:43 +00002361/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002362 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002363 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002364
2365/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002366 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002367 *
2368 * - fill in handshake headers
2369 * - update handshake checksum
2370 * - DTLS: save message for resending
2371 * - then pass to the record layer
2372 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002373 * DTLS: except for HelloRequest, messages are only queued, and will only be
2374 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002375 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002376 * Inputs:
2377 * - ssl->out_msglen: 4 + actual handshake message len
2378 * (4 is the size of handshake headers for TLS)
2379 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2380 * - ssl->out_msg + 4: the handshake message body
2381 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002382 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002383 * - ssl->out_msglen: the length of the record contents
2384 * (including handshake headers but excluding record headers)
2385 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002386 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002387int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2388 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002389{
Janos Follath865b3eb2019-12-16 11:46:15 +00002390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002391 const size_t hs_len = ssl->out_msglen - 4;
2392 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002393
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2395
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002396 /*
2397 * Sanity checks
2398 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002399 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002400 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2401 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002402 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2403 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002404 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002405
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002406 /* Whenever we send anything different from a
2407 * HelloRequest we should be in a handshake - double check. */
2408 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2409 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002410 ssl->handshake == NULL )
2411 {
2412 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2413 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2414 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002415
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002417 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002418 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2422 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002424#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002425
Hanno Beckerb50a2532018-08-06 11:52:54 +01002426 /* Double-check that we did not exceed the bounds
2427 * of the outgoing record buffer.
2428 * This should never fail as the various message
2429 * writing functions must obey the bounds of the
2430 * outgoing record buffer, but better be safe.
2431 *
2432 * Note: We deliberately do not check for the MTU or MFL here.
2433 */
2434 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2435 {
2436 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002437 "size %" MBEDTLS_PRINTF_SIZET
2438 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002439 ssl->out_msglen,
2440 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002441 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2442 }
2443
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002444 /*
2445 * Fill handshake headers
2446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002448 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002449 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2450 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2451 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002452
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002453 /*
2454 * DTLS has additional fields in the Handshake layer,
2455 * between the length field and the actual payload:
2456 * uint16 message_seq;
2457 * uint24 fragment_offset;
2458 * uint24 fragment_length;
2459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002461 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002462 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002463 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002464 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002465 {
2466 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002467 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002468 hs_len,
2469 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002470 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2471 }
2472
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002473 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002474 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002475
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002476 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002477 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002478 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002479 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002480 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002481 }
2482 else
2483 {
2484 ssl->out_msg[4] = 0;
2485 ssl->out_msg[5] = 0;
2486 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002487
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002488 /* Handshake hashes are computed without fragmentation,
2489 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002490 memset( ssl->out_msg + 6, 0x00, 3 );
2491 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002492 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002494
Hanno Becker0207e532018-08-28 10:28:28 +01002495 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002496 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002497 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 }
2499
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002500 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002502 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002503 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2504 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002505 {
2506 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2507 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002509 return( ret );
2510 }
2511 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002512 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002513#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002514 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002515 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002516 {
2517 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2518 return( ret );
2519 }
2520 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002521
2522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2523
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002524 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002525}
2526
2527/*
2528 * Record layer functions
2529 */
2530
2531/*
2532 * Write current record.
2533 *
2534 * Uses:
2535 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2536 * - ssl->out_msglen: length of the record content (excl headers)
2537 * - ssl->out_msg: record content
2538 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002539int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002540{
2541 int ret, done = 0;
2542 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002543 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002544
2545 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002546
Paul Bakker05ef8352012-05-08 09:17:57 +00002547 if( !done )
2548 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002549 unsigned i;
2550 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002551#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2552 size_t out_buf_len = ssl->out_buf_len;
2553#else
2554 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2555#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002556 /* Skip writing the record content type to after the encryption,
2557 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002558 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002559#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002560 /* TLS 1.3 still uses the TLS 1.2 version identifier
2561 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002562 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2563 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002564#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002565 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2566 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002567
Jerry Yuae0b2e22021-10-08 15:21:19 +08002568 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002569 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002570
Paul Bakker48916f92012-09-16 19:57:18 +00002571 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002572 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002573 mbedtls_record rec;
2574
2575 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002576 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002577 rec.data_len = ssl->out_msglen;
2578 rec.data_offset = ssl->out_msg - rec.buf;
2579
Jerry Yud96a5c22021-09-29 17:46:51 +08002580 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002581 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002582 ssl->conf->transport, rec.ver );
2583 rec.type = ssl->out_msgtype;
2584
Hanno Beckera0e20d02019-05-15 14:03:01 +01002585#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002586 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002587 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002588#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002589
Hanno Beckera18d1322018-01-03 14:27:32 +00002590 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002591 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002594 return( ret );
2595 }
2596
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002597 if( rec.data_offset != 0 )
2598 {
2599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2601 }
2602
Hanno Becker6430faf2019-05-08 11:57:13 +01002603 /* Update the record content type and CID. */
2604 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002605#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002606 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002607#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002608 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002609 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002610 }
2611
Hanno Becker5903de42019-05-03 14:46:38 +01002612 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002613
2614#if defined(MBEDTLS_SSL_PROTO_DTLS)
2615 /* In case of DTLS, double-check that we don't exceed
2616 * the remaining space in the datagram. */
2617 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2618 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002619 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002620 if( ret < 0 )
2621 return( ret );
2622
2623 if( protected_record_size > (size_t) ret )
2624 {
2625 /* Should never happen */
2626 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2627 }
2628 }
2629#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002630
Hanno Becker6430faf2019-05-08 11:57:13 +01002631 /* Now write the potentially updated record content type. */
2632 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2633
Paul Elliott9f352112020-12-09 14:55:45 +00002634 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002635 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002636 ssl->out_hdr[0], ssl->out_hdr[1],
2637 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002638
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002639 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002640 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002641
2642 ssl->out_left += protected_record_size;
2643 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002644 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002645
Hanno Beckerdd772292020-02-05 10:38:31 +00002646 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002647 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2648 break;
2649
2650 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002651 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002652 {
2653 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2654 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2655 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002656 }
2657
Hanno Becker67bc7c32018-08-06 11:33:50 +01002658#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002659 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2660 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002661 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002662 size_t remaining;
2663 ret = ssl_get_remaining_payload_in_datagram( ssl );
2664 if( ret < 0 )
2665 {
2666 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2667 ret );
2668 return( ret );
2669 }
2670
2671 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002672 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002673 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002674 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002675 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002676 else
2677 {
Hanno Becker513815a2018-08-20 11:56:09 +01002678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002679 }
2680 }
2681#endif /* MBEDTLS_SSL_PROTO_DTLS */
2682
2683 if( ( flush == SSL_FORCE_FLUSH ) &&
2684 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002687 return( ret );
2688 }
2689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002691
2692 return( 0 );
2693}
2694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002696
2697static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2698{
2699 if( ssl->in_msglen < ssl->in_hslen ||
2700 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2701 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2702 {
2703 return( 1 );
2704 }
2705 return( 0 );
2706}
Hanno Becker44650b72018-08-16 12:51:11 +01002707
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002708static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002709{
2710 return( ( ssl->in_msg[9] << 16 ) |
2711 ( ssl->in_msg[10] << 8 ) |
2712 ssl->in_msg[11] );
2713}
2714
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002715static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002716{
2717 return( ( ssl->in_msg[6] << 16 ) |
2718 ( ssl->in_msg[7] << 8 ) |
2719 ssl->in_msg[8] );
2720}
2721
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002722static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002723{
2724 uint32_t msg_len, frag_off, frag_len;
2725
2726 msg_len = ssl_get_hs_total_len( ssl );
2727 frag_off = ssl_get_hs_frag_off( ssl );
2728 frag_len = ssl_get_hs_frag_len( ssl );
2729
2730 if( frag_off > msg_len )
2731 return( -1 );
2732
2733 if( frag_len > msg_len - frag_off )
2734 return( -1 );
2735
2736 if( frag_len + 12 > ssl->in_msglen )
2737 return( -1 );
2738
2739 return( 0 );
2740}
2741
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002742/*
2743 * Mark bits in bitmask (used for DTLS HS reassembly)
2744 */
2745static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2746{
2747 unsigned int start_bits, end_bits;
2748
2749 start_bits = 8 - ( offset % 8 );
2750 if( start_bits != 8 )
2751 {
2752 size_t first_byte_idx = offset / 8;
2753
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002754 /* Special case */
2755 if( len <= start_bits )
2756 {
2757 for( ; len != 0; len-- )
2758 mask[first_byte_idx] |= 1 << ( start_bits - len );
2759
2760 /* Avoid potential issues with offset or len becoming invalid */
2761 return;
2762 }
2763
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002764 offset += start_bits; /* Now offset % 8 == 0 */
2765 len -= start_bits;
2766
2767 for( ; start_bits != 0; start_bits-- )
2768 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2769 }
2770
2771 end_bits = len % 8;
2772 if( end_bits != 0 )
2773 {
2774 size_t last_byte_idx = ( offset + len ) / 8;
2775
2776 len -= end_bits; /* Now len % 8 == 0 */
2777
2778 for( ; end_bits != 0; end_bits-- )
2779 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2780 }
2781
2782 memset( mask + offset / 8, 0xFF, len / 8 );
2783}
2784
2785/*
2786 * Check that bitmask is full
2787 */
2788static int ssl_bitmask_check( unsigned char *mask, size_t len )
2789{
2790 size_t i;
2791
2792 for( i = 0; i < len / 8; i++ )
2793 if( mask[i] != 0xFF )
2794 return( -1 );
2795
2796 for( i = 0; i < len % 8; i++ )
2797 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2798 return( -1 );
2799
2800 return( 0 );
2801}
2802
Hanno Becker56e205e2018-08-16 09:06:12 +01002803/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002804static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002805 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002806{
Hanno Becker56e205e2018-08-16 09:06:12 +01002807 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002808
Hanno Becker56e205e2018-08-16 09:06:12 +01002809 alloc_len = 12; /* Handshake header */
2810 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002811
Hanno Beckerd07df862018-08-16 09:14:58 +01002812 if( add_bitmap )
2813 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002814
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002815 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002816}
Hanno Becker56e205e2018-08-16 09:06:12 +01002817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002819
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002820static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002821{
2822 return( ( ssl->in_msg[1] << 16 ) |
2823 ( ssl->in_msg[2] << 8 ) |
2824 ssl->in_msg[3] );
2825}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002826
Simon Butcher99000142016-10-13 17:21:01 +01002827int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002828{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002830 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002832 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002834 }
2835
Hanno Becker12555c62018-08-16 12:47:53 +01002836 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002839 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002840 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002843 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002844 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002845 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002846 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002847
Hanno Becker44650b72018-08-16 12:51:11 +01002848 if( ssl_check_hs_header( ssl ) != 0 )
2849 {
2850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2851 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2852 }
2853
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002854 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002855 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2856 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2857 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2858 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002859 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002860 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2861 {
2862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2863 recv_msg_seq,
2864 ssl->handshake->in_msg_seq ) );
2865 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2866 }
2867
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002868 /* Retransmit only on last message from previous flight, to avoid
2869 * too many retransmissions.
2870 * Besides, No sane server ever retransmits HelloVerifyRequest */
2871 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002873 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002875 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002876 recv_msg_seq,
2877 ssl->handshake->in_flight_start_seq ) );
2878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002882 return( ret );
2883 }
2884 }
2885 else
2886 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002888 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002889 recv_msg_seq,
2890 ssl->handshake->in_msg_seq ) );
2891 }
2892
Hanno Becker90333da2017-10-10 11:27:13 +01002893 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002894 }
2895 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002896
Hanno Becker6d97ef52018-08-16 13:09:04 +01002897 /* Message reassembly is handled alongside buffering of future
2898 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002899 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002900 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002901 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002902 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002904 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002905 }
2906 }
2907 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002909 /* With TLS we don't handle fragmentation (for now) */
2910 if( ssl->in_msglen < ssl->in_hslen )
2911 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2913 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002914 }
2915
Simon Butcher99000142016-10-13 17:21:01 +01002916 return( 0 );
2917}
2918
2919void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2920{
Hanno Becker0271f962018-08-16 13:23:47 +01002921 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002922
Hanno Becker0271f962018-08-16 13:23:47 +01002923 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002924 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002925 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002926 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002927
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002928 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002931 ssl->handshake != NULL )
2932 {
Hanno Becker0271f962018-08-16 13:23:47 +01002933 unsigned offset;
2934 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002935
Hanno Becker0271f962018-08-16 13:23:47 +01002936 /* Increment handshake sequence number */
2937 hs->in_msg_seq++;
2938
2939 /*
2940 * Clear up handshake buffering and reassembly structure.
2941 */
2942
2943 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002944 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002945
2946 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002947 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2948 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002949 offset++, hs_buf++ )
2950 {
2951 *hs_buf = *(hs_buf + 1);
2952 }
2953
2954 /* Create a fresh last entry */
2955 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002956 }
2957#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002958}
2959
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002960/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002961 * DTLS anti-replay: RFC 6347 4.1.2.6
2962 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002963 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2964 * Bit n is set iff record number in_window_top - n has been seen.
2965 *
2966 * Usually, in_window_top is the last record number seen and the lsb of
2967 * in_window is set. The only exception is the initial state (record number 0
2968 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002971void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002972{
2973 ssl->in_window_top = 0;
2974 ssl->in_window = 0;
2975}
2976
2977static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2978{
2979 return( ( (uint64_t) buf[0] << 40 ) |
2980 ( (uint64_t) buf[1] << 32 ) |
2981 ( (uint64_t) buf[2] << 24 ) |
2982 ( (uint64_t) buf[3] << 16 ) |
2983 ( (uint64_t) buf[4] << 8 ) |
2984 ( (uint64_t) buf[5] ) );
2985}
2986
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002987static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2988{
Janos Follath865b3eb2019-12-16 11:46:15 +00002989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002990 unsigned char *original_in_ctr;
2991
2992 // save original in_ctr
2993 original_in_ctr = ssl->in_ctr;
2994
2995 // use counter from record
2996 ssl->in_ctr = record_in_ctr;
2997
2998 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2999
3000 // restore the counter
3001 ssl->in_ctr = original_in_ctr;
3002
3003 return ret;
3004}
3005
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003006/*
3007 * Return 0 if sequence number is acceptable, -1 otherwise
3008 */
Hanno Becker0183d692019-07-12 08:50:37 +01003009int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003010{
3011 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3012 uint64_t bit;
3013
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003014 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003015 return( 0 );
3016
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003017 if( rec_seqnum > ssl->in_window_top )
3018 return( 0 );
3019
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003020 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003021
3022 if( bit >= 64 )
3023 return( -1 );
3024
3025 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3026 return( -1 );
3027
3028 return( 0 );
3029}
3030
3031/*
3032 * Update replay window on new validated record
3033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003035{
3036 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3037
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003038 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003039 return;
3040
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003041 if( rec_seqnum > ssl->in_window_top )
3042 {
3043 /* Update window_top and the contents of the window */
3044 uint64_t shift = rec_seqnum - ssl->in_window_top;
3045
3046 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003047 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003048 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003049 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003050 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003051 ssl->in_window |= 1;
3052 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003053
3054 ssl->in_window_top = rec_seqnum;
3055 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003056 else
3057 {
3058 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003059 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003060
3061 if( bit < 64 ) /* Always true, but be extra sure */
3062 ssl->in_window |= (uint64_t) 1 << bit;
3063 }
3064}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003066
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003067#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003068/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003069 * Without any SSL context, check if a datagram looks like a ClientHello with
3070 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003071 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003072 *
3073 * - if cookie is valid, return 0
3074 * - if ClientHello looks superficially valid but cookie is not,
3075 * fill obuf and set olen, then
3076 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3077 * - otherwise return a specific error code
3078 */
3079static int ssl_check_dtls_clihlo_cookie(
3080 mbedtls_ssl_cookie_write_t *f_cookie_write,
3081 mbedtls_ssl_cookie_check_t *f_cookie_check,
3082 void *p_cookie,
3083 const unsigned char *cli_id, size_t cli_id_len,
3084 const unsigned char *in, size_t in_len,
3085 unsigned char *obuf, size_t buf_len, size_t *olen )
3086{
3087 size_t sid_len, cookie_len;
3088 unsigned char *p;
3089
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003090 /*
3091 * Structure of ClientHello with record and handshake headers,
3092 * and expected values. We don't need to check a lot, more checks will be
3093 * done when actually parsing the ClientHello - skipping those checks
3094 * avoids code duplication and does not make cookie forging any easier.
3095 *
3096 * 0-0 ContentType type; copied, must be handshake
3097 * 1-2 ProtocolVersion version; copied
3098 * 3-4 uint16 epoch; copied, must be 0
3099 * 5-10 uint48 sequence_number; copied
3100 * 11-12 uint16 length; (ignored)
3101 *
3102 * 13-13 HandshakeType msg_type; (ignored)
3103 * 14-16 uint24 length; (ignored)
3104 * 17-18 uint16 message_seq; copied
3105 * 19-21 uint24 fragment_offset; copied, must be 0
3106 * 22-24 uint24 fragment_length; (ignored)
3107 *
3108 * 25-26 ProtocolVersion client_version; (ignored)
3109 * 27-58 Random random; (ignored)
3110 * 59-xx SessionID session_id; 1 byte len + sid_len content
3111 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3112 * ...
3113 *
3114 * Minimum length is 61 bytes.
3115 */
3116 if( in_len < 61 ||
3117 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3118 in[3] != 0 || in[4] != 0 ||
3119 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3120 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003121 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003122 }
3123
3124 sid_len = in[59];
3125 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003126 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003127
3128 cookie_len = in[60 + sid_len];
3129 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003130 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003131
3132 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3133 cli_id, cli_id_len ) == 0 )
3134 {
3135 /* Valid cookie */
3136 return( 0 );
3137 }
3138
3139 /*
3140 * If we get here, we've got an invalid cookie, let's prepare HVR.
3141 *
3142 * 0-0 ContentType type; copied
3143 * 1-2 ProtocolVersion version; copied
3144 * 3-4 uint16 epoch; copied
3145 * 5-10 uint48 sequence_number; copied
3146 * 11-12 uint16 length; olen - 13
3147 *
3148 * 13-13 HandshakeType msg_type; hello_verify_request
3149 * 14-16 uint24 length; olen - 25
3150 * 17-18 uint16 message_seq; copied
3151 * 19-21 uint24 fragment_offset; copied
3152 * 22-24 uint24 fragment_length; olen - 25
3153 *
3154 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3155 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3156 *
3157 * Minimum length is 28.
3158 */
3159 if( buf_len < 28 )
3160 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3161
3162 /* Copy most fields and adapt others */
3163 memcpy( obuf, in, 25 );
3164 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3165 obuf[25] = 0xfe;
3166 obuf[26] = 0xff;
3167
3168 /* Generate and write actual cookie */
3169 p = obuf + 28;
3170 if( f_cookie_write( p_cookie,
3171 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3172 {
3173 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3174 }
3175
3176 *olen = p - obuf;
3177
3178 /* Go back and fill length fields */
3179 obuf[27] = (unsigned char)( *olen - 28 );
3180
Joe Subbianifbeb6922021-07-16 14:27:50 +01003181 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3182 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3183 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003184
Joe Subbiani6dd73642021-07-19 11:56:54 +01003185 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003186
3187 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3188}
3189
3190/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003191 * Handle possible client reconnect with the same UDP quadruplet
3192 * (RFC 6347 Section 4.2.8).
3193 *
3194 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3195 * that looks like a ClientHello.
3196 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003197 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003198 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003199 * - if the input looks like a ClientHello with a valid cookie,
3200 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003201 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003202 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003203 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003204 * This function is called (through ssl_check_client_reconnect()) when an
3205 * unexpected record is found in ssl_get_next_record(), which will discard the
3206 * record if we return 0, and bubble up the return value otherwise (this
3207 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3208 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003209 */
3210static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3211{
Janos Follath865b3eb2019-12-16 11:46:15 +00003212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003213 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003214
Hanno Becker2fddd372019-07-10 14:37:41 +01003215 if( ssl->conf->f_cookie_write == NULL ||
3216 ssl->conf->f_cookie_check == NULL )
3217 {
3218 /* If we can't use cookies to verify reachability of the peer,
3219 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3221 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003222 return( 0 );
3223 }
3224
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225 ret = ssl_check_dtls_clihlo_cookie(
3226 ssl->conf->f_cookie_write,
3227 ssl->conf->f_cookie_check,
3228 ssl->conf->p_cookie,
3229 ssl->cli_id, ssl->cli_id_len,
3230 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003231 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003232
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003233 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3234
3235 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003236 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003237 int send_ret;
3238 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3239 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3240 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003241 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003242 * If the error is permanent we'll catch it later,
3243 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003244 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3245 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3246 (void) send_ret;
3247
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003248 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003249 }
3250
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003251 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003252 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003254 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003255 {
3256 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3257 return( ret );
3258 }
3259
3260 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003261 }
3262
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003263 return( ret );
3264}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003265#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003266
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003267static int ssl_check_record_type( uint8_t record_type )
3268{
3269 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3270 record_type != MBEDTLS_SSL_MSG_ALERT &&
3271 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3272 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3273 {
3274 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3275 }
3276
3277 return( 0 );
3278}
3279
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003280/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003281 * ContentType type;
3282 * ProtocolVersion version;
3283 * uint16 epoch; // DTLS only
3284 * uint48 sequence_number; // DTLS only
3285 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003286 *
3287 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003288 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003289 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3290 *
3291 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003292 * 1. proceed with the record if this function returns 0
3293 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3294 * 3. return CLIENT_RECONNECT if this function return that value
3295 * 4. drop the whole datagram if this function returns anything else.
3296 * Point 2 is needed when the peer is resending, and we have already received
3297 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003298 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003299static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003300 unsigned char *buf,
3301 size_t len,
3302 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003303{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003304 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003305
Hanno Beckere5e7e782019-07-11 12:29:35 +01003306 size_t const rec_hdr_type_offset = 0;
3307 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003308
Hanno Beckere5e7e782019-07-11 12:29:35 +01003309 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3310 rec_hdr_type_len;
3311 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003312
Hanno Beckere5e7e782019-07-11 12:29:35 +01003313 size_t const rec_hdr_ctr_len = 8;
3314#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003315 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003316 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3317 rec_hdr_version_len;
3318
Hanno Beckera0e20d02019-05-15 14:03:01 +01003319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003320 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3321 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003322 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003323#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3324#endif /* MBEDTLS_SSL_PROTO_DTLS */
3325
3326 size_t rec_hdr_len_offset; /* To be determined */
3327 size_t const rec_hdr_len_len = 2;
3328
3329 /*
3330 * Check minimum lengths for record header.
3331 */
3332
3333#if defined(MBEDTLS_SSL_PROTO_DTLS)
3334 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3335 {
3336 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3337 }
3338 else
3339#endif /* MBEDTLS_SSL_PROTO_DTLS */
3340 {
3341 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3342 }
3343
3344 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3345 {
3346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3347 (unsigned) len,
3348 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3349 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3350 }
3351
3352 /*
3353 * Parse and validate record content type
3354 */
3355
3356 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003357
3358 /* Check record content type */
3359#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3360 rec->cid_len = 0;
3361
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003362 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003363 ssl->conf->cid_len != 0 &&
3364 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003365 {
3366 /* Shift pointers to account for record header including CID
3367 * struct {
3368 * ContentType special_type = tls12_cid;
3369 * ProtocolVersion version;
3370 * uint16 epoch;
3371 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003372 * opaque cid[cid_length]; // Additional field compared to
3373 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003374 * uint16 length;
3375 * opaque enc_content[DTLSCiphertext.length];
3376 * } DTLSCiphertext;
3377 */
3378
3379 /* So far, we only support static CID lengths
3380 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003381 rec_hdr_cid_len = ssl->conf->cid_len;
3382 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003383
Hanno Beckere5e7e782019-07-11 12:29:35 +01003384 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003385 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3387 (unsigned) len,
3388 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003389 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003390 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003391
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003392 /* configured CID len is guaranteed at most 255, see
3393 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3394 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003395 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003396 }
3397 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003398#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003399 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 if( ssl_check_record_type( rec->type ) )
3401 {
Hanno Becker54229812019-07-12 14:40:00 +01003402 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3403 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3405 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003406 }
3407
Hanno Beckere5e7e782019-07-11 12:29:35 +01003408 /*
3409 * Parse and validate record version
3410 */
3411
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003412 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3413 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003414 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3415 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003416 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003417
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003418 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003419 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3421 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003422 }
3423
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003424 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3427 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003428 }
3429
Hanno Beckere5e7e782019-07-11 12:29:35 +01003430 /*
3431 * Parse/Copy record sequence number.
3432 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003433
Hanno Beckere5e7e782019-07-11 12:29:35 +01003434#if defined(MBEDTLS_SSL_PROTO_DTLS)
3435 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003436 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003437 /* Copy explicit record sequence number from input buffer. */
3438 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3439 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003440 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003441 else
3442#endif /* MBEDTLS_SSL_PROTO_DTLS */
3443 {
3444 /* Copy implicit record sequence number from SSL context structure. */
3445 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3446 }
Paul Bakker40e46942009-01-03 21:51:57 +00003447
Hanno Beckere5e7e782019-07-11 12:29:35 +01003448 /*
3449 * Parse record length.
3450 */
3451
Hanno Beckere5e7e782019-07-11 12:29:35 +01003452 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003453 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3454 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003455 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003456
Paul Elliott9f352112020-12-09 14:55:45 +00003457 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003458 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003459 rec->type,
3460 major_ver, minor_ver, rec->data_len ) );
3461
3462 rec->buf = buf;
3463 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003464
Hanno Beckerd417cc92019-07-26 08:20:27 +01003465 if( rec->data_len == 0 )
3466 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003467
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003468 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003469 * DTLS-related tests.
3470 * Check epoch before checking length constraint because
3471 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3472 * message gets duplicated before the corresponding Finished message,
3473 * the second ChangeCipherSpec should be discarded because it belongs
3474 * to an old epoch, but not because its length is shorter than
3475 * the minimum record length for packets using the new record transform.
3476 * Note that these two kinds of failures are handled differently,
3477 * as an unexpected record is silently skipped but an invalid
3478 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003479 */
3480#if defined(MBEDTLS_SSL_PROTO_DTLS)
3481 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3482 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003483 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003484
Hanno Becker955a5c92019-07-10 17:12:07 +01003485 /* Check that the datagram is large enough to contain a record
3486 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003487 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003488 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3490 (unsigned) len,
3491 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003492 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3493 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003494
Hanno Becker37cfe732019-07-10 17:20:01 +01003495 /* Records from other, non-matching epochs are silently discarded.
3496 * (The case of same-port Client reconnects must be considered in
3497 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003498 if( rec_epoch != ssl->in_epoch )
3499 {
3500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003501 "expected %u, received %lu",
3502 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003503
Hanno Becker552f7472019-07-19 10:59:12 +01003504 /* Records from the next epoch are considered for buffering
3505 * (concretely: early Finished messages). */
3506 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003507 {
Hanno Becker552f7472019-07-19 10:59:12 +01003508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3509 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003510 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003511
Hanno Becker2fddd372019-07-10 14:37:41 +01003512 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003513 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003514#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003515 /* For records from the correct epoch, check whether their
3516 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003517 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3518 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003519 {
3520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3521 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3522 }
3523#endif
3524 }
3525#endif /* MBEDTLS_SSL_PROTO_DTLS */
3526
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003527 return( 0 );
3528}
Paul Bakker5121ce52009-01-03 21:22:43 +00003529
Paul Bakker5121ce52009-01-03 21:22:43 +00003530
Hanno Becker2fddd372019-07-10 14:37:41 +01003531#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3532static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3533{
3534 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3535
3536 /*
3537 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3538 * access the first byte of record content (handshake type), as we
3539 * have an active transform (possibly iv_len != 0), so use the
3540 * fact that the record header len is 13 instead.
3541 */
3542 if( rec_epoch == 0 &&
3543 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3544 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3545 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3546 ssl->in_left > 13 &&
3547 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3548 {
3549 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3550 "from the same port" ) );
3551 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003552 }
3553
3554 return( 0 );
3555}
Hanno Becker2fddd372019-07-10 14:37:41 +01003556#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003557
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003558/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003559 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003560 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003561static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3562 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003563{
3564 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003567 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003568
Ronald Cron7e38cba2021-11-24 12:43:39 +01003569 /*
3570 * In TLS 1.3, always treat ChangeCipherSpec records
3571 * as unencrypted. The only thing we do with them is
3572 * check the length and content and ignore them.
3573 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003574#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003575 if( ssl->transform_in != NULL &&
3576 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3577 {
3578 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3579 done = 1;
3580 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003581#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003582
Paul Bakker48916f92012-09-16 19:57:18 +00003583 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003584 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003585 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003586
Hanno Beckera18d1322018-01-03 14:27:32 +00003587 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003588 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003591
Hanno Beckera0e20d02019-05-15 14:03:01 +01003592#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003593 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3594 ssl->conf->ignore_unexpected_cid
3595 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3596 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003597 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003598 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003599 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003600#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003601
Paul Bakker5121ce52009-01-03 21:22:43 +00003602 return( ret );
3603 }
3604
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003605 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003606 {
3607 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003608 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003609 }
3610
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003611 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003612 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003613
Hanno Beckera0e20d02019-05-15 14:03:01 +01003614#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003615 /* We have already checked the record content type
3616 * in ssl_parse_record_header(), failing or silently
3617 * dropping the record in the case of an unknown type.
3618 *
3619 * Since with the use of CIDs, the record content type
3620 * might change during decryption, re-check the record
3621 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003622 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003623 {
3624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3625 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3626 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003627#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003628
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003629 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003630 {
3631#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3632 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003633 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003634 {
3635 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3637 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3638 }
3639#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3640
3641 ssl->nb_zero++;
3642
3643 /*
3644 * Three or more empty messages may be a DoS attack
3645 * (excessive CPU consumption).
3646 */
3647 if( ssl->nb_zero > 3 )
3648 {
3649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003650 "messages, possible DoS attack" ) );
3651 /* Treat the records as if they were not properly authenticated,
3652 * thereby failing the connection if we see more than allowed
3653 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003654 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3655 }
3656 }
3657 else
3658 ssl->nb_zero = 0;
3659
3660#if defined(MBEDTLS_SSL_PROTO_DTLS)
3661 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3662 {
3663 ; /* in_ctr read from peer, not maintained internally */
3664 }
3665 else
3666#endif
3667 {
3668 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003669 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3670 i > mbedtls_ssl_ep_len( ssl ); i-- )
3671 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003672 if( ++ssl->in_ctr[i - 1] != 0 )
3673 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003674 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003675
3676 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003677 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003678 {
3679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3680 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3681 }
3682 }
3683
Paul Bakker5121ce52009-01-03 21:22:43 +00003684 }
3685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003686#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003687 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003690 }
3691#endif
3692
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003693 /* Check actual (decrypted) record content length against
3694 * configured maximum. */
3695 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3696 {
3697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3698 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3699 }
3700
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003701 return( 0 );
3702}
3703
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003704/*
3705 * Read a record.
3706 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003707 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3708 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3709 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003710 */
Hanno Becker1097b342018-08-15 14:09:41 +01003711
3712/* Helper functions for mbedtls_ssl_read_record(). */
3713static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003714static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3715static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003716
Hanno Becker327c93b2018-08-15 13:56:18 +01003717int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003718 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003719{
Janos Follath865b3eb2019-12-16 11:46:15 +00003720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003722 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003723
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003724 if( ssl->keep_current_message == 0 )
3725 {
3726 do {
Simon Butcher99000142016-10-13 17:21:01 +01003727
Hanno Becker26994592018-08-15 14:14:59 +01003728 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003729 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003730 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003731
Hanno Beckere74d5562018-08-15 14:26:08 +01003732 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003733 {
Hanno Becker40f50842018-08-15 14:48:01 +01003734#if defined(MBEDTLS_SSL_PROTO_DTLS)
3735 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003736
Hanno Becker40f50842018-08-15 14:48:01 +01003737 /* We only check for buffered messages if the
3738 * current datagram is fully consumed. */
3739 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003740 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003741 {
Hanno Becker40f50842018-08-15 14:48:01 +01003742 if( ssl_load_buffered_message( ssl ) == 0 )
3743 have_buffered = 1;
3744 }
3745
3746 if( have_buffered == 0 )
3747#endif /* MBEDTLS_SSL_PROTO_DTLS */
3748 {
3749 ret = ssl_get_next_record( ssl );
3750 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3751 continue;
3752
3753 if( ret != 0 )
3754 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003755 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003756 return( ret );
3757 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003758 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003759 }
3760
3761 ret = mbedtls_ssl_handle_message_type( ssl );
3762
Hanno Becker40f50842018-08-15 14:48:01 +01003763#if defined(MBEDTLS_SSL_PROTO_DTLS)
3764 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3765 {
3766 /* Buffer future message */
3767 ret = ssl_buffer_message( ssl );
3768 if( ret != 0 )
3769 return( ret );
3770
3771 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3772 }
3773#endif /* MBEDTLS_SSL_PROTO_DTLS */
3774
Hanno Becker90333da2017-10-10 11:27:13 +01003775 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3776 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003777
3778 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003779 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003780 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003781 return( ret );
3782 }
3783
Hanno Becker327c93b2018-08-15 13:56:18 +01003784 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003785 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003786 {
3787 mbedtls_ssl_update_handshake_status( ssl );
3788 }
Simon Butcher99000142016-10-13 17:21:01 +01003789 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003790 else
Simon Butcher99000142016-10-13 17:21:01 +01003791 {
Hanno Becker02f59072018-08-15 14:00:24 +01003792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003793 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003794 }
3795
3796 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3797
3798 return( 0 );
3799}
3800
Hanno Becker40f50842018-08-15 14:48:01 +01003801#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003802static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003803{
Hanno Becker40f50842018-08-15 14:48:01 +01003804 if( ssl->in_left > ssl->next_record_offset )
3805 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003806
Hanno Becker40f50842018-08-15 14:48:01 +01003807 return( 0 );
3808}
3809
3810static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3811{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003812 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003813 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003814 int ret = 0;
3815
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003816 if( hs == NULL )
3817 return( -1 );
3818
Hanno Beckere00ae372018-08-20 09:39:42 +01003819 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3820
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003821 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3822 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3823 {
3824 /* Check if we have seen a ChangeCipherSpec before.
3825 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003826 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003827 {
3828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3829 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003830 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003831 }
3832
Hanno Becker39b8bc92018-08-28 17:17:13 +01003833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003834 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3835 ssl->in_msglen = 1;
3836 ssl->in_msg[0] = 1;
3837
3838 /* As long as they are equal, the exact value doesn't matter. */
3839 ssl->in_left = 0;
3840 ssl->next_record_offset = 0;
3841
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003842 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003843 goto exit;
3844 }
Hanno Becker37f95322018-08-16 13:55:32 +01003845
Hanno Beckerb8f50142018-08-28 10:01:34 +01003846#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003847 /* Debug only */
3848 {
3849 unsigned offset;
3850 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3851 {
3852 hs_buf = &hs->buffering.hs[offset];
3853 if( hs_buf->is_valid == 1 )
3854 {
3855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3856 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003857 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003858 }
3859 }
3860 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003861#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003862
3863 /* Check if we have buffered and/or fully reassembled the
3864 * next handshake message. */
3865 hs_buf = &hs->buffering.hs[0];
3866 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3867 {
3868 /* Synthesize a record containing the buffered HS message. */
3869 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3870 ( hs_buf->data[2] << 8 ) |
3871 hs_buf->data[3];
3872
3873 /* Double-check that we haven't accidentally buffered
3874 * a message that doesn't fit into the input buffer. */
3875 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3876 {
3877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3878 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3879 }
3880
3881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3882 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3883 hs_buf->data, msg_len + 12 );
3884
3885 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3886 ssl->in_hslen = msg_len + 12;
3887 ssl->in_msglen = msg_len + 12;
3888 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3889
3890 ret = 0;
3891 goto exit;
3892 }
3893 else
3894 {
3895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3896 hs->in_msg_seq ) );
3897 }
3898
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003899 ret = -1;
3900
3901exit:
3902
3903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3904 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003905}
3906
Hanno Beckera02b0b42018-08-21 17:20:27 +01003907static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3908 size_t desired )
3909{
3910 int offset;
3911 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3913 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003914
Hanno Becker01315ea2018-08-21 17:22:17 +01003915 /* Get rid of future records epoch first, if such exist. */
3916 ssl_free_buffered_record( ssl );
3917
3918 /* Check if we have enough space available now. */
3919 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3920 hs->buffering.total_bytes_buffered ) )
3921 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003923 return( 0 );
3924 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003925
Hanno Becker4f432ad2018-08-28 10:02:32 +01003926 /* We don't have enough space to buffer the next expected handshake
3927 * message. Remove buffers used for future messages to gain space,
3928 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003929 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3930 offset >= 0; offset-- )
3931 {
3932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3933 offset ) );
3934
Hanno Beckerb309b922018-08-23 13:18:05 +01003935 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003936
3937 /* Check if we have enough space available now. */
3938 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3939 hs->buffering.total_bytes_buffered ) )
3940 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003942 return( 0 );
3943 }
3944 }
3945
3946 return( -1 );
3947}
3948
Hanno Becker40f50842018-08-15 14:48:01 +01003949static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3950{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003951 int ret = 0;
3952 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3953
3954 if( hs == NULL )
3955 return( 0 );
3956
3957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3958
3959 switch( ssl->in_msgtype )
3960 {
3961 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003963
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003964 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003965 break;
3966
3967 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003968 {
3969 unsigned recv_msg_seq_offset;
3970 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3971 mbedtls_ssl_hs_buffer *hs_buf;
3972 size_t msg_len = ssl->in_hslen - 12;
3973
3974 /* We should never receive an old handshake
3975 * message - double-check nonetheless. */
3976 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3977 {
3978 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3979 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3980 }
3981
3982 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3983 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3984 {
3985 /* Silently ignore -- message too far in the future */
3986 MBEDTLS_SSL_DEBUG_MSG( 2,
3987 ( "Ignore future HS message with sequence number %u, "
3988 "buffering window %u - %u",
3989 recv_msg_seq, ssl->handshake->in_msg_seq,
3990 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3991
3992 goto exit;
3993 }
3994
3995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3996 recv_msg_seq, recv_msg_seq_offset ) );
3997
3998 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3999
4000 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004001 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004002 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004003 size_t reassembly_buf_sz;
4004
Hanno Becker37f95322018-08-16 13:55:32 +01004005 hs_buf->is_fragmented =
4006 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4007
4008 /* We copy the message back into the input buffer
4009 * after reassembly, so check that it's not too large.
4010 * This is an implementation-specific limitation
4011 * and not one from the standard, hence it is not
4012 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004013 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004014 {
4015 /* Ignore message */
4016 goto exit;
4017 }
4018
Hanno Beckere0b150f2018-08-21 15:51:03 +01004019 /* Check if we have enough space to buffer the message. */
4020 if( hs->buffering.total_bytes_buffered >
4021 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4022 {
4023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4024 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4025 }
4026
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004027 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4028 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004029
4030 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4031 hs->buffering.total_bytes_buffered ) )
4032 {
4033 if( recv_msg_seq_offset > 0 )
4034 {
4035 /* If we can't buffer a future message because
4036 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4038 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4039 " (already %" MBEDTLS_PRINTF_SIZET
4040 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004041 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004042 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004043 goto exit;
4044 }
Hanno Beckere1801392018-08-21 16:51:05 +01004045 else
4046 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4048 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4049 " (already %" MBEDTLS_PRINTF_SIZET
4050 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004051 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004052 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004053 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004054
Hanno Beckera02b0b42018-08-21 17:20:27 +01004055 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004056 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004057 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4058 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4059 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4060 " (already %" MBEDTLS_PRINTF_SIZET
4061 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004062 msg_len,
4063 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004064 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004065 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004066 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4067 goto exit;
4068 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004069 }
4070
Paul Elliottd48d5c62021-01-07 14:47:05 +00004071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004072 msg_len ) );
4073
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004074 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4075 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004076 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004077 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004078 goto exit;
4079 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004080 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004081
4082 /* Prepare final header: copy msg_type, length and message_seq,
4083 * then add standardised fragment_offset and fragment_length */
4084 memcpy( hs_buf->data, ssl->in_msg, 6 );
4085 memset( hs_buf->data + 6, 0, 3 );
4086 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4087
4088 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004089
4090 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004091 }
4092 else
4093 {
4094 /* Make sure msg_type and length are consistent */
4095 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4096 {
4097 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4098 /* Ignore */
4099 goto exit;
4100 }
4101 }
4102
Hanno Becker4422bbb2018-08-20 09:40:19 +01004103 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004104 {
4105 size_t frag_len, frag_off;
4106 unsigned char * const msg = hs_buf->data + 12;
4107
4108 /*
4109 * Check and copy current fragment
4110 */
4111
4112 /* Validation of header fields already done in
4113 * mbedtls_ssl_prepare_handshake_record(). */
4114 frag_off = ssl_get_hs_frag_off( ssl );
4115 frag_len = ssl_get_hs_frag_len( ssl );
4116
Paul Elliottd48d5c62021-01-07 14:47:05 +00004117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4118 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004119 frag_off, frag_len ) );
4120 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4121
4122 if( hs_buf->is_fragmented )
4123 {
4124 unsigned char * const bitmask = msg + msg_len;
4125 ssl_bitmask_set( bitmask, frag_off, frag_len );
4126 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4127 msg_len ) == 0 );
4128 }
4129 else
4130 {
4131 hs_buf->is_complete = 1;
4132 }
4133
4134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4135 hs_buf->is_complete ? "" : "not yet " ) );
4136 }
4137
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004138 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004139 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004140
4141 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004142 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004143 break;
4144 }
4145
4146exit:
4147
4148 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4149 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004150}
4151#endif /* MBEDTLS_SSL_PROTO_DTLS */
4152
Hanno Becker1097b342018-08-15 14:09:41 +01004153static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004154{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004155 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004156 * Consume last content-layer message and potentially
4157 * update in_msglen which keeps track of the contents'
4158 * consumption state.
4159 *
4160 * (1) Handshake messages:
4161 * Remove last handshake message, move content
4162 * and adapt in_msglen.
4163 *
4164 * (2) Alert messages:
4165 * Consume whole record content, in_msglen = 0.
4166 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004167 * (3) Change cipher spec:
4168 * Consume whole record content, in_msglen = 0.
4169 *
4170 * (4) Application data:
4171 * Don't do anything - the record layer provides
4172 * the application data as a stream transport
4173 * and consumes through mbedtls_ssl_read only.
4174 *
4175 */
4176
4177 /* Case (1): Handshake messages */
4178 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004179 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004180 /* Hard assertion to be sure that no application data
4181 * is in flight, as corrupting ssl->in_msglen during
4182 * ssl->in_offt != NULL is fatal. */
4183 if( ssl->in_offt != NULL )
4184 {
4185 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4186 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4187 }
4188
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004189 /*
4190 * Get next Handshake message in the current record
4191 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004192
Hanno Becker4a810fb2017-05-24 16:27:30 +01004193 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004194 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004195 * current handshake content: If DTLS handshake
4196 * fragmentation is used, that's the fragment
4197 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004198 * size here is faulty and should be changed at
4199 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004200 * (2) While it doesn't seem to cause problems, one
4201 * has to be very careful not to assume that in_hslen
4202 * is always <= in_msglen in a sensible communication.
4203 * Again, it's wrong for DTLS handshake fragmentation.
4204 * The following check is therefore mandatory, and
4205 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004206 * Additionally, ssl->in_hslen might be arbitrarily out of
4207 * bounds after handling a DTLS message with an unexpected
4208 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004209 */
4210 if( ssl->in_hslen < ssl->in_msglen )
4211 {
4212 ssl->in_msglen -= ssl->in_hslen;
4213 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4214 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004215
Hanno Becker4a810fb2017-05-24 16:27:30 +01004216 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4217 ssl->in_msg, ssl->in_msglen );
4218 }
4219 else
4220 {
4221 ssl->in_msglen = 0;
4222 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004223
Hanno Becker4a810fb2017-05-24 16:27:30 +01004224 ssl->in_hslen = 0;
4225 }
4226 /* Case (4): Application data */
4227 else if( ssl->in_offt != NULL )
4228 {
4229 return( 0 );
4230 }
4231 /* Everything else (CCS & Alerts) */
4232 else
4233 {
4234 ssl->in_msglen = 0;
4235 }
4236
Hanno Becker1097b342018-08-15 14:09:41 +01004237 return( 0 );
4238}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004239
Hanno Beckere74d5562018-08-15 14:26:08 +01004240static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4241{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004242 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004243 return( 1 );
4244
4245 return( 0 );
4246}
4247
Hanno Becker5f066e72018-08-16 14:56:31 +01004248#if defined(MBEDTLS_SSL_PROTO_DTLS)
4249
4250static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4251{
4252 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4253 if( hs == NULL )
4254 return;
4255
Hanno Becker01315ea2018-08-21 17:22:17 +01004256 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004257 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004258 hs->buffering.total_bytes_buffered -=
4259 hs->buffering.future_record.len;
4260
4261 mbedtls_free( hs->buffering.future_record.data );
4262 hs->buffering.future_record.data = NULL;
4263 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004264}
4265
4266static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4267{
4268 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4269 unsigned char * rec;
4270 size_t rec_len;
4271 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004272#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4273 size_t in_buf_len = ssl->in_buf_len;
4274#else
4275 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4276#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004277 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4278 return( 0 );
4279
4280 if( hs == NULL )
4281 return( 0 );
4282
Hanno Becker5f066e72018-08-16 14:56:31 +01004283 rec = hs->buffering.future_record.data;
4284 rec_len = hs->buffering.future_record.len;
4285 rec_epoch = hs->buffering.future_record.epoch;
4286
4287 if( rec == NULL )
4288 return( 0 );
4289
Hanno Becker4cb782d2018-08-20 11:19:05 +01004290 /* Only consider loading future records if the
4291 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004292 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004293 return( 0 );
4294
Hanno Becker5f066e72018-08-16 14:56:31 +01004295 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4296
4297 if( rec_epoch != ssl->in_epoch )
4298 {
4299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4300 goto exit;
4301 }
4302
4303 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4304
4305 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004306 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004307 {
4308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4309 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4310 }
4311
4312 memcpy( ssl->in_hdr, rec, rec_len );
4313 ssl->in_left = rec_len;
4314 ssl->next_record_offset = 0;
4315
4316 ssl_free_buffered_record( ssl );
4317
4318exit:
4319 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4320 return( 0 );
4321}
4322
Hanno Becker519f15d2019-07-11 12:43:20 +01004323static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4324 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004325{
4326 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004327
4328 /* Don't buffer future records outside handshakes. */
4329 if( hs == NULL )
4330 return( 0 );
4331
4332 /* Only buffer handshake records (we are only interested
4333 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004334 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004335 return( 0 );
4336
4337 /* Don't buffer more than one future epoch record. */
4338 if( hs->buffering.future_record.data != NULL )
4339 return( 0 );
4340
Hanno Becker01315ea2018-08-21 17:22:17 +01004341 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004342 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004343 hs->buffering.total_bytes_buffered ) )
4344 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004345 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4346 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4347 " (already %" MBEDTLS_PRINTF_SIZET
4348 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004349 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004350 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004351 return( 0 );
4352 }
4353
Hanno Becker5f066e72018-08-16 14:56:31 +01004354 /* Buffer record */
4355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004356 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004357 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004358
4359 /* ssl_parse_record_header() only considers records
4360 * of the next epoch as candidates for buffering. */
4361 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004362 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004363
4364 hs->buffering.future_record.data =
4365 mbedtls_calloc( 1, hs->buffering.future_record.len );
4366 if( hs->buffering.future_record.data == NULL )
4367 {
4368 /* If we run out of RAM trying to buffer a
4369 * record from the next epoch, just ignore. */
4370 return( 0 );
4371 }
4372
Hanno Becker519f15d2019-07-11 12:43:20 +01004373 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004374
Hanno Becker519f15d2019-07-11 12:43:20 +01004375 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004376 return( 0 );
4377}
4378
4379#endif /* MBEDTLS_SSL_PROTO_DTLS */
4380
Hanno Beckere74d5562018-08-15 14:26:08 +01004381static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004382{
Janos Follath865b3eb2019-12-16 11:46:15 +00004383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004384 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004385
Hanno Becker5f066e72018-08-16 14:56:31 +01004386#if defined(MBEDTLS_SSL_PROTO_DTLS)
4387 /* We might have buffered a future record; if so,
4388 * and if the epoch matches now, load it.
4389 * On success, this call will set ssl->in_left to
4390 * the length of the buffered record, so that
4391 * the calls to ssl_fetch_input() below will
4392 * essentially be no-ops. */
4393 ret = ssl_load_buffered_record( ssl );
4394 if( ret != 0 )
4395 return( ret );
4396#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004397
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004398 /* Ensure that we have enough space available for the default form
4399 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4400 * with no space for CIDs counted in). */
4401 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4402 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004403 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004404 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004405 return( ret );
4406 }
4407
Hanno Beckere5e7e782019-07-11 12:29:35 +01004408 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4409 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004410 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004411#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004412 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004413 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004414 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4415 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004416 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004417 if( ret != 0 )
4418 return( ret );
4419
4420 /* Fall through to handling of unexpected records */
4421 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4422 }
4423
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004424 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4425 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004426#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004427 /* Reset in pointers to default state for TLS/DTLS records,
4428 * assuming no CID and no offset between record content and
4429 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004430 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004431
Hanno Becker7ae20e02019-07-12 08:33:49 +01004432 /* Setup internal message pointers from record structure. */
4433 ssl->in_msgtype = rec.type;
4434#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4435 ssl->in_len = ssl->in_cid + rec.cid_len;
4436#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4437 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4438 ssl->in_msglen = rec.data_len;
4439
Hanno Becker2fddd372019-07-10 14:37:41 +01004440 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004441 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004442 if( ret != 0 )
4443 return( ret );
4444#endif
4445
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004446 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004447 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004448
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004449 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4450 "(header)" ) );
4451 }
4452 else
4453 {
4454 /* Skip invalid record and the rest of the datagram */
4455 ssl->next_record_offset = 0;
4456 ssl->in_left = 0;
4457
4458 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4459 "(header)" ) );
4460 }
4461
4462 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004463 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004464 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004465 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004466#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004467 {
4468 return( ret );
4469 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004470 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004471
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004472#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004473 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004474 {
Hanno Beckera8814792019-07-10 15:01:45 +01004475 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004476 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004477 if( ssl->next_record_offset < ssl->in_left )
4478 {
4479 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4480 }
4481 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004482 else
4483#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004484 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004485 /*
4486 * Fetch record contents from underlying transport.
4487 */
Hanno Beckera3175662019-07-11 12:50:29 +01004488 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004489 if( ret != 0 )
4490 {
4491 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4492 return( ret );
4493 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004494
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004495 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004496 }
4497
4498 /*
4499 * Decrypt record contents.
4500 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004501
Hanno Beckerfdf66042019-07-11 13:07:45 +01004502 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004504#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004505 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004506 {
4507 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004508 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004509 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004510 /* Except when waiting for Finished as a bad mac here
4511 * probably means something went wrong in the handshake
4512 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4513 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4514 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4515 {
4516#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4517 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4518 {
4519 mbedtls_ssl_send_alert_message( ssl,
4520 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4521 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4522 }
4523#endif
4524 return( ret );
4525 }
4526
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004527 if( ssl->conf->badmac_limit != 0 &&
4528 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004529 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4531 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004532 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004533
Hanno Becker4a810fb2017-05-24 16:27:30 +01004534 /* As above, invalid records cause
4535 * dismissal of the whole datagram. */
4536
4537 ssl->next_record_offset = 0;
4538 ssl->in_left = 0;
4539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004541 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004542 }
4543
4544 return( ret );
4545 }
4546 else
4547#endif
4548 {
4549 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004550#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4551 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004552 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553 mbedtls_ssl_send_alert_message( ssl,
4554 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4555 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004556 }
4557#endif
4558 return( ret );
4559 }
4560 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004561
Hanno Becker44d89b22019-07-12 09:40:44 +01004562
4563 /* Reset in pointers to default state for TLS/DTLS records,
4564 * assuming no CID and no offset between record content and
4565 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004566 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004567#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4568 ssl->in_len = ssl->in_cid + rec.cid_len;
4569#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004570 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004571
Hanno Becker8685c822019-07-12 09:37:30 +01004572 /* The record content type may change during decryption,
4573 * so re-read it. */
4574 ssl->in_msgtype = rec.type;
4575 /* Also update the input buffer, because unfortunately
4576 * the server-side ssl_parse_client_hello() reparses the
4577 * record header when receiving a ClientHello initiating
4578 * a renegotiation. */
4579 ssl->in_hdr[0] = rec.type;
4580 ssl->in_msg = rec.buf + rec.data_offset;
4581 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004582 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004583
Simon Butcher99000142016-10-13 17:21:01 +01004584 return( 0 );
4585}
4586
4587int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4588{
Janos Follath865b3eb2019-12-16 11:46:15 +00004589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004590
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004591 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004592 * Handle particular types of records
4593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004595 {
Simon Butcher99000142016-10-13 17:21:01 +01004596 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4597 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004598 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004599 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004600 }
4601
Hanno Beckere678eaa2018-08-21 14:57:46 +01004602 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004603 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004604 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004605 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004607 ssl->in_msglen ) );
4608 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004609 }
4610
Hanno Beckere678eaa2018-08-21 14:57:46 +01004611 if( ssl->in_msg[0] != 1 )
4612 {
4613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4614 ssl->in_msg[0] ) );
4615 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4616 }
4617
4618#if defined(MBEDTLS_SSL_PROTO_DTLS)
4619 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4620 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4621 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4622 {
4623 if( ssl->handshake == NULL )
4624 {
4625 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4626 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4627 }
4628
4629 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4630 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4631 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004632#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004633
Ronald Cron6f135e12021-12-08 16:57:54 +01004634#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004635 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4636 {
4637#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4638 MBEDTLS_SSL_DEBUG_MSG( 1,
4639 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4640 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4641#else
4642 MBEDTLS_SSL_DEBUG_MSG( 1,
4643 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4644 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4645#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4646 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004647#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004648 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004650 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004651 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004652 if( ssl->in_msglen != 2 )
4653 {
4654 /* Note: Standard allows for more than one 2 byte alert
4655 to be packed in a single message, but Mbed TLS doesn't
4656 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004658 ssl->in_msglen ) );
4659 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4660 }
4661
Paul Elliott9f352112020-12-09 14:55:45 +00004662 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 ssl->in_msg[0], ssl->in_msg[1] ) );
4664
4665 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004666 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004668 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004669 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004671 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004672 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004673 }
4674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004675 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4676 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004677 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4679 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004680 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004681
4682#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4683 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4684 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4685 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004686 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004687 /* Will be handled when trying to parse ServerHello */
4688 return( 0 );
4689 }
4690#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004691 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004692 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004693 }
4694
Hanno Beckerc76c6192017-06-06 10:03:17 +01004695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004697 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004698 /* Drop unexpected ApplicationData records,
4699 * except at the beginning of renegotiations */
4700 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4701 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4702#if defined(MBEDTLS_SSL_RENEGOTIATION)
4703 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4704 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004705#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004706 )
4707 {
4708 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4709 return( MBEDTLS_ERR_SSL_NON_FATAL );
4710 }
4711
4712 if( ssl->handshake != NULL &&
4713 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4714 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004715 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004716 }
4717 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004718#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004719
Paul Bakker5121ce52009-01-03 21:22:43 +00004720 return( 0 );
4721}
4722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004724{
irwir6c0da642019-09-26 21:07:41 +03004725 return( mbedtls_ssl_send_alert_message( ssl,
4726 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4727 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004728}
4729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004731 unsigned char level,
4732 unsigned char message )
4733{
Janos Follath865b3eb2019-12-16 11:46:15 +00004734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004735
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004736 if( ssl == NULL || ssl->conf == NULL )
4737 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004740 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004743 ssl->out_msglen = 2;
4744 ssl->out_msg[0] = level;
4745 ssl->out_msg[1] = message;
4746
Hanno Becker67bc7c32018-08-06 11:33:50 +01004747 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004749 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004750 return( ret );
4751 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004753
4754 return( 0 );
4755}
4756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004757int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004758{
Janos Follath865b3eb2019-12-16 11:46:15 +00004759 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004763 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004764 ssl->out_msglen = 1;
4765 ssl->out_msg[0] = 1;
4766
Paul Bakker5121ce52009-01-03 21:22:43 +00004767 ssl->state++;
4768
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004769 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004770 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004772 return( ret );
4773 }
4774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004776
4777 return( 0 );
4778}
4779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004780int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004781{
Janos Follath865b3eb2019-12-16 11:46:15 +00004782 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004785
Hanno Becker327c93b2018-08-15 13:56:18 +01004786 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004787 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004788 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004789 return( ret );
4790 }
4791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004793 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004795 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4796 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004798 }
4799
Hanno Beckere678eaa2018-08-21 14:57:46 +01004800 /* CCS records are only accepted if they have length 1 and content '1',
4801 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004802
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004803 /*
4804 * Switch to our negotiated transform and session parameters for inbound
4805 * data.
4806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004808 ssl->transform_in = ssl->transform_negotiate;
4809 ssl->session_in = ssl->session_negotiate;
4810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004812 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004813 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004815 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004816#endif
4817
4818 /* Increment epoch */
4819 if( ++ssl->in_epoch == 0 )
4820 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004822 /* This is highly unlikely to happen for legitimate reasons, so
4823 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004824 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004825 }
4826 }
4827 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004828#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004829 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004830
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004831 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004832
Paul Bakker5121ce52009-01-03 21:22:43 +00004833 ssl->state++;
4834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004836
4837 return( 0 );
4838}
4839
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004840/* Once ssl->out_hdr as the address of the beginning of the
4841 * next outgoing record is set, deduce the other pointers.
4842 *
4843 * Note: For TLS, we save the implicit record sequence number
4844 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4845 * and the caller has to make sure there's space for this.
4846 */
4847
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004848static size_t ssl_transform_get_explicit_iv_len(
4849 mbedtls_ssl_transform const *transform )
4850{
TRodziewiczef73f012021-05-13 14:53:36 +02004851 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004852 return( 0 );
4853
4854 return( transform->ivlen - transform->fixed_ivlen );
4855}
4856
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004857void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4858 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004859{
4860#if defined(MBEDTLS_SSL_PROTO_DTLS)
4861 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4862 {
4863 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004864#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004865 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004866 ssl->out_len = ssl->out_cid;
4867 if( transform != NULL )
4868 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004869#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004870 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004871#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004872 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004873 }
4874 else
4875#endif
4876 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004877 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004878#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004879 ssl->out_cid = ssl->out_len;
4880#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004881 ssl->out_iv = ssl->out_hdr + 5;
4882 }
4883
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004884 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004885 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004886 if( transform != NULL )
4887 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004888}
4889
4890/* Once ssl->in_hdr as the address of the beginning of the
4891 * next incoming record is set, deduce the other pointers.
4892 *
4893 * Note: For TLS, we save the implicit record sequence number
4894 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4895 * and the caller has to make sure there's space for this.
4896 */
4897
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004898void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004899{
Hanno Becker79594fd2019-05-08 09:38:41 +01004900 /* This function sets the pointers to match the case
4901 * of unprotected TLS/DTLS records, with both ssl->in_iv
4902 * and ssl->in_msg pointing to the beginning of the record
4903 * content.
4904 *
4905 * When decrypting a protected record, ssl->in_msg
4906 * will be shifted to point to the beginning of the
4907 * record plaintext.
4908 */
4909
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004910#if defined(MBEDTLS_SSL_PROTO_DTLS)
4911 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4912 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004913 /* This sets the header pointers to match records
4914 * without CID. When we receive a record containing
4915 * a CID, the fields are shifted accordingly in
4916 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004917 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004918#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004919 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004920 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004921#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004922 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004923#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004924 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004925 }
4926 else
4927#endif
4928 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08004929 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004930 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004931#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004932 ssl->in_cid = ssl->in_len;
4933#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004934 ssl->in_iv = ssl->in_hdr + 5;
4935 }
4936
Hanno Becker79594fd2019-05-08 09:38:41 +01004937 /* This will be adjusted at record decryption time. */
4938 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004939}
4940
Paul Bakker5121ce52009-01-03 21:22:43 +00004941/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004942 * Setup an SSL context
4943 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004944
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004945void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004946{
4947 /* Set the incoming and outgoing record pointers. */
4948#if defined(MBEDTLS_SSL_PROTO_DTLS)
4949 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4950 {
4951 ssl->out_hdr = ssl->out_buf;
4952 ssl->in_hdr = ssl->in_buf;
4953 }
4954 else
4955#endif /* MBEDTLS_SSL_PROTO_DTLS */
4956 {
Hanno Becker12078f42021-03-02 15:28:41 +00004957 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004958 ssl->out_hdr = ssl->out_buf + 8;
4959 ssl->in_hdr = ssl->in_buf + 8;
4960 }
4961
4962 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004963 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4964 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004965}
4966
Paul Bakker5121ce52009-01-03 21:22:43 +00004967/*
4968 * SSL get accessors
4969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004970size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004971{
4972 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4973}
4974
Hanno Becker8b170a02017-10-10 11:51:19 +01004975int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4976{
4977 /*
4978 * Case A: We're currently holding back
4979 * a message for further processing.
4980 */
4981
4982 if( ssl->keep_current_message == 1 )
4983 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004984 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004985 return( 1 );
4986 }
4987
4988 /*
4989 * Case B: Further records are pending in the current datagram.
4990 */
4991
4992#if defined(MBEDTLS_SSL_PROTO_DTLS)
4993 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4994 ssl->in_left > ssl->next_record_offset )
4995 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004996 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004997 return( 1 );
4998 }
4999#endif /* MBEDTLS_SSL_PROTO_DTLS */
5000
5001 /*
5002 * Case C: A handshake message is being processed.
5003 */
5004
Hanno Becker8b170a02017-10-10 11:51:19 +01005005 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5006 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005007 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005008 return( 1 );
5009 }
5010
5011 /*
5012 * Case D: An application data message is being processed
5013 */
5014 if( ssl->in_offt != NULL )
5015 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005016 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005017 return( 1 );
5018 }
5019
5020 /*
5021 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005022 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005023 * we implement support for multiple alerts in single records.
5024 */
5025
5026 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5027 return( 0 );
5028}
5029
Paul Bakker43ca69c2011-01-15 17:35:19 +00005030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005032{
Hanno Becker3136ede2018-08-17 15:28:19 +01005033 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005035 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005036
Hanno Becker5903de42019-05-03 14:46:38 +01005037 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5038
Hanno Becker78640902018-08-13 16:35:15 +01005039 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005040 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005042 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005043 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044 case MBEDTLS_MODE_GCM:
5045 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005046 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005048 transform_expansion = transform->minlen;
5049 break;
5050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005052
5053 block_size = mbedtls_cipher_get_block_size(
5054 &transform->cipher_ctx_enc );
5055
Hanno Becker3136ede2018-08-17 15:28:19 +01005056 /* Expansion due to the addition of the MAC. */
5057 transform_expansion += transform->maclen;
5058
5059 /* Expansion due to the addition of CBC padding;
5060 * Theoretically up to 256 bytes, but we never use
5061 * more than the block size of the underlying cipher. */
5062 transform_expansion += block_size;
5063
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005064 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005065 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005067 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005069
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005070 break;
5071
5072 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005073 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005075 }
5076
Hanno Beckera0e20d02019-05-15 14:03:01 +01005077#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005078 if( transform->out_cid_len != 0 )
5079 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005080#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005081
Hanno Becker5903de42019-05-03 14:46:38 +01005082 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005083}
5084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005085#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005086/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005087 * Check record counters and renegotiate if they're above the limit.
5088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005089static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005090{
Hanno Beckerdd772292020-02-05 10:38:31 +00005091 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005092 int in_ctr_cmp;
5093 int out_ctr_cmp;
5094
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5096 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005097 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005098 {
5099 return( 0 );
5100 }
5101
Andres AG2196c7f2016-12-15 17:01:16 +00005102 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005103 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005104 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005105 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5106 &ssl->conf->renego_period[ep_len],
5107 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005108
5109 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005110 {
5111 return( 0 );
5112 }
5113
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005116}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005118
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005119/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005120 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005121 * may only be sent for the purpose of initiating renegotiations.
5122 *
5123 * This function is introduced as a separate helper since the handling
5124 * of post-handshake handshake messages changes significantly in TLS 1.3,
5125 * and having a helper function allows to distinguish between TLS <= 1.2 and
5126 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5127 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005128static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005129{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005130 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005131
5132 /*
5133 * - For client-side, expect SERVER_HELLO_REQUEST.
5134 * - For server-side, expect CLIENT_HELLO.
5135 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5136 */
5137
5138#if defined(MBEDTLS_SSL_CLI_C)
5139 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5140 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5141 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5142 {
5143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5144
5145 /* With DTLS, drop the packet (probably from last handshake) */
5146#if defined(MBEDTLS_SSL_PROTO_DTLS)
5147 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5148 {
5149 return( 0 );
5150 }
5151#endif
5152 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5153 }
5154#endif /* MBEDTLS_SSL_CLI_C */
5155
5156#if defined(MBEDTLS_SSL_SRV_C)
5157 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5158 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5159 {
5160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5161
5162 /* With DTLS, drop the packet (probably from last handshake) */
5163#if defined(MBEDTLS_SSL_PROTO_DTLS)
5164 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5165 {
5166 return( 0 );
5167 }
5168#endif
5169 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5170 }
5171#endif /* MBEDTLS_SSL_SRV_C */
5172
5173#if defined(MBEDTLS_SSL_RENEGOTIATION)
5174 /* Determine whether renegotiation attempt should be accepted */
5175 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5176 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5177 ssl->conf->allow_legacy_renegotiation ==
5178 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5179 {
5180 /*
5181 * Accept renegotiation request
5182 */
5183
5184 /* DTLS clients need to know renego is server-initiated */
5185#if defined(MBEDTLS_SSL_PROTO_DTLS)
5186 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5187 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5188 {
5189 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5190 }
5191#endif
5192 ret = mbedtls_ssl_start_renegotiation( ssl );
5193 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5194 ret != 0 )
5195 {
5196 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5197 ret );
5198 return( ret );
5199 }
5200 }
5201 else
5202#endif /* MBEDTLS_SSL_RENEGOTIATION */
5203 {
5204 /*
5205 * Refuse renegotiation
5206 */
5207
5208 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5209
TRodziewicz0f82ec62021-05-12 17:49:18 +02005210#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005211 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5212 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5213 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005214 {
TRodziewicz345165c2021-07-06 13:42:11 +02005215 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005216 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005217#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005218 }
5219
5220 return( 0 );
5221}
5222
Paul Bakker48916f92012-09-16 19:57:18 +00005223/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005224 * Receive application data decrypted from the SSL layer
5225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005226int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005227{
Janos Follath865b3eb2019-12-16 11:46:15 +00005228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005229 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005230
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005231 if( ssl == NULL || ssl->conf == NULL )
5232 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005236#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005237 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005238 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005239 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005240 return( ret );
5241
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005242 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005244 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005245 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005246 return( ret );
5247 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005248 }
5249#endif
5250
Hanno Becker4a810fb2017-05-24 16:27:30 +01005251 /*
5252 * Check if renegotiation is necessary and/or handshake is
5253 * in process. If yes, perform/continue, and fall through
5254 * if an unexpected packet is received while the client
5255 * is waiting for the ServerHello.
5256 *
5257 * (There is no equivalent to the last condition on
5258 * the server-side as it is not treated as within
5259 * a handshake while waiting for the ClientHello
5260 * after a renegotiation request.)
5261 */
5262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005264 ret = ssl_check_ctr_renegotiate( ssl );
5265 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5266 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005267 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005269 return( ret );
5270 }
5271#endif
5272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005273 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005274 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005276 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5277 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005278 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 return( ret );
5281 }
5282 }
5283
Hanno Beckere41158b2017-10-23 13:30:32 +01005284 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005285 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005286 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005287 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005288 if( ssl->f_get_timer != NULL &&
5289 ssl->f_get_timer( ssl->p_timer ) == -1 )
5290 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005291 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005292 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005293
Hanno Becker327c93b2018-08-15 13:56:18 +01005294 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005295 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005296 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5297 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005298
Hanno Becker4a810fb2017-05-24 16:27:30 +01005299 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5300 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005301 }
5302
5303 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005304 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005305 {
5306 /*
5307 * OpenSSL sends empty messages to randomize the IV
5308 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005309 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005312 return( 0 );
5313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005314 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005315 return( ret );
5316 }
5317 }
5318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005319 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005320 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005321 ret = ssl_handle_hs_message_post_handshake( ssl );
5322 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005323 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005324 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5325 ret );
5326 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005327 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005328
Hanno Beckerf26cc722021-04-21 07:30:13 +01005329 /* At this point, we don't know whether the renegotiation triggered
5330 * by the post-handshake message has been completed or not. The cases
5331 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005332 * 1) The renegotiation is complete. In this case, no new record
5333 * has been read yet.
5334 * 2) The renegotiation is incomplete because the client received
5335 * an application data record while awaiting the ServerHello.
5336 * 3) The renegotiation is incomplete because the client received
5337 * a non-handshake, non-application data message while awaiting
5338 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005339 *
5340 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005341 * - For 1), the next iteration will read a new record and check
5342 * if it's application data.
5343 * - For 2), the loop condition isn't satisfied as application data
5344 * is present, hence continue is the same as break
5345 * - For 3), the loop condition is satisfied and read_record
5346 * will re-deliver the message that was held back by the client
5347 * when expecting the ServerHello.
5348 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005349
Hanno Becker90333da2017-10-10 11:27:13 +01005350 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005351 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005352#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005354 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005355 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005356 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005357 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005358 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005359 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005360 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005362 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005363 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005364 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005365#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5368 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005369 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005371 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005372 }
5373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005374 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005375 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5377 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005378 }
5379
5380 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005381
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005382 /* We're going to return something now, cancel timer,
5383 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005384 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005385 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005386
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005387#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005388 /* If we requested renego but received AppData, resend HelloRequest.
5389 * Do it now, after setting in_offt, to avoid taking this branch
5390 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005392 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005394 {
Hanno Becker786300f2020-02-05 10:46:40 +00005395 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005396 {
Hanno Becker786300f2020-02-05 10:46:40 +00005397 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5398 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005399 return( ret );
5400 }
5401 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005403#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005404 }
5405
5406 n = ( len < ssl->in_msglen )
5407 ? len : ssl->in_msglen;
5408
5409 memcpy( buf, ssl->in_offt, n );
5410 ssl->in_msglen -= n;
5411
gabor-mezei-arma3214132020-07-15 10:55:00 +02005412 /* Zeroising the plaintext buffer to erase unused application data
5413 from the memory. */
5414 mbedtls_platform_zeroize( ssl->in_offt, n );
5415
Paul Bakker5121ce52009-01-03 21:22:43 +00005416 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005417 {
5418 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005419 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005420 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005421 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005422 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005423 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005424 /* more data available */
5425 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005426 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005429
Paul Bakker23986e52011-04-24 08:57:21 +00005430 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005431}
5432
5433/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005434 * Send application data to be encrypted by the SSL layer, taking care of max
5435 * fragment length and buffer size.
5436 *
5437 * According to RFC 5246 Section 6.2.1:
5438 *
5439 * Zero-length fragments of Application data MAY be sent as they are
5440 * potentially useful as a traffic analysis countermeasure.
5441 *
5442 * Therefore, it is possible that the input message length is 0 and the
5443 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005444 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005445static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005446 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005447{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005448 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5449 const size_t max_len = (size_t) ret;
5450
5451 if( ret < 0 )
5452 {
5453 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5454 return( ret );
5455 }
5456
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005457 if( len > max_len )
5458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005460 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005463 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5464 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005465 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005467 }
5468 else
5469#endif
5470 len = max_len;
5471 }
Paul Bakker887bd502011-06-08 13:10:54 +00005472
Paul Bakker5121ce52009-01-03 21:22:43 +00005473 if( ssl->out_left != 0 )
5474 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005475 /*
5476 * The user has previously tried to send the data and
5477 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5478 * written. In this case, we expect the high-level write function
5479 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005482 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005484 return( ret );
5485 }
5486 }
Paul Bakker887bd502011-06-08 13:10:54 +00005487 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005488 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005489 /*
5490 * The user is trying to send a message the first time, so we need to
5491 * copy the data into the internal buffers and setup the data structure
5492 * to keep track of partial writes
5493 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005494 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005495 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005496 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005497
Hanno Becker67bc7c32018-08-06 11:33:50 +01005498 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005499 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005501 return( ret );
5502 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005503 }
5504
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005505 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005506}
5507
5508/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005509 * Write application data (public-facing wrapper)
5510 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005511int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005512{
Janos Follath865b3eb2019-12-16 11:46:15 +00005513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005514
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005515 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005516
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005517 if( ssl == NULL || ssl->conf == NULL )
5518 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5519
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005520#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005521 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5522 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005523 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005524 return( ret );
5525 }
5526#endif
5527
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005528 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005529 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005530 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005531 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005533 return( ret );
5534 }
5535 }
5536
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005537 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005538
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005540
5541 return( ret );
5542}
5543
5544/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005545 * Notify the peer that the connection is being closed
5546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005548{
Janos Follath865b3eb2019-12-16 11:46:15 +00005549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005550
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005551 if( ssl == NULL || ssl->conf == NULL )
5552 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005555
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005556 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005559 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005560 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005561 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5562 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5563 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005564 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005565 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005566 return( ret );
5567 }
5568 }
5569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005571
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005572 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005573}
5574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005575void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005576{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005577 if( transform == NULL )
5578 return;
5579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005580 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5581 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005582
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005583#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005584 psa_destroy_key( transform->psa_key_enc );
5585 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005586#endif
5587
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005588#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005589 mbedtls_md_free( &transform->md_ctx_enc );
5590 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005591#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005592
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005593 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005594}
5595
Jerry Yuc7875b52021-09-05 21:05:50 +08005596void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5597 mbedtls_ssl_transform *transform )
5598{
Jerry Yuc7875b52021-09-05 21:05:50 +08005599 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005600 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005601}
5602
5603void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5604 mbedtls_ssl_transform *transform )
5605{
5606 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005607 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005608}
5609
Hanno Becker0271f962018-08-16 13:23:47 +01005610#if defined(MBEDTLS_SSL_PROTO_DTLS)
5611
Hanno Becker533ab5f2020-02-05 10:49:13 +00005612void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005613{
5614 unsigned offset;
5615 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5616
5617 if( hs == NULL )
5618 return;
5619
Hanno Becker283f5ef2018-08-24 09:34:47 +01005620 ssl_free_buffered_record( ssl );
5621
Hanno Becker0271f962018-08-16 13:23:47 +01005622 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005623 ssl_buffering_free_slot( ssl, offset );
5624}
5625
5626static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5627 uint8_t slot )
5628{
5629 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5630 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005631
5632 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5633 return;
5634
Hanno Beckere605b192018-08-21 15:59:07 +01005635 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005636 {
Hanno Beckere605b192018-08-21 15:59:07 +01005637 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005638 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005639 mbedtls_free( hs_buf->data );
5640 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005641 }
5642}
5643
5644#endif /* MBEDTLS_SSL_PROTO_DTLS */
5645
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005646/*
5647 * Convert version numbers to/from wire format
5648 * and, for DTLS, to/from TLS equivalent.
5649 *
5650 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005651 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005652 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005654void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005655 unsigned char ver[2] )
5656{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005657#if defined(MBEDTLS_SSL_PROTO_DTLS)
5658 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005659 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005660 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005661 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5662
5663 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5664 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5665 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005666 else
5667#else
5668 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005669#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005670 {
5671 ver[0] = (unsigned char) major;
5672 ver[1] = (unsigned char) minor;
5673 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005674}
5675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005676void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005677 const unsigned char ver[2] )
5678{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679#if defined(MBEDTLS_SSL_PROTO_DTLS)
5680 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005681 {
5682 *major = 255 - ver[0] + 2;
5683 *minor = 255 - ver[1] + 1;
5684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005686 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5687 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005688 else
5689#else
5690 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005691#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005692 {
5693 *major = ver[0];
5694 *minor = ver[1];
5695 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005696}
5697
Jerry Yue7047812021-09-13 19:26:39 +08005698/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005699 * Send pending fatal alert.
5700 * 0, No alert message.
5701 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5702 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005703 */
5704int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5705{
5706 int ret;
5707
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005708 /* No pending alert, return success*/
5709 if( ssl->send_alert == 0 )
5710 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005711
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005712 ret = mbedtls_ssl_send_alert_message( ssl,
5713 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5714 ssl->alert_type );
5715
Jerry Yu3bf1f972021-09-22 21:37:18 +08005716 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5717 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005718 */
5719 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5720 {
5721 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005722 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005723
5724 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005725 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005726
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005727 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005728}
5729
Jerry Yu394ece62021-09-14 22:17:21 +08005730/*
5731 * Set pending fatal alert flag.
5732 */
5733void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5734 unsigned char alert_type,
5735 int alert_reason )
5736{
5737 ssl->send_alert = 1;
5738 ssl->alert_type = alert_type;
5739 ssl->alert_reason = alert_reason;
5740}
5741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005742#endif /* MBEDTLS_SSL_TLS_C */