blob: 701f7146fe8521abde56614b3e76a6d39ef3915b [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{
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100525#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 mbedtls_cipher_mode_t mode;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100527#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100528 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000529 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100530 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100531 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532 size_t post_avail;
533
534 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000535#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200536 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000537 ((void) ssl);
538#endif
539
540 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200541 * for CBC transformations in TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200542#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200543 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000544 ((void) f_rng);
545 ((void) p_rng);
546#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000547
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000550 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100551 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
554 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100555 if( rec == NULL
556 || rec->buf == NULL
557 || rec->buf_len < rec->data_offset
558 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100559#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100560 || rec->cid_len != 0
561#endif
562 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000563 {
564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100566 }
567
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000568 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000571 data, rec->data_len );
572
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100573#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000574 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100575#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576
577 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
578 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
580 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000581 rec->data_len,
582 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000583 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
584 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100585
Hanno Becker92313402020-05-20 13:58:58 +0100586 /* The following two code paths implement the (D)TLSInnerPlaintext
587 * structure present in TLS 1.3 and DTLS 1.2 + CID.
588 *
589 * See ssl_build_inner_plaintext() for more information.
590 *
591 * Note that this changes `rec->data_len`, and hence
592 * `post_avail` needs to be recalculated afterwards.
593 *
594 * Note also that the two code paths cannot occur simultaneously
595 * since they apply to different versions of the protocol. There
596 * is hence no risk of double-addition of the inner plaintext.
597 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +0100599 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
600 {
Hanno Becker13996922020-05-28 16:15:19 +0100601 size_t padding =
602 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200603 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100604 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100605 &rec->data_len,
606 post_avail,
607 rec->type,
608 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100609 {
610 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
611 }
612
613 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
614 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100615#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100616
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100618 /*
619 * Add CID information
620 */
621 rec->cid_len = transform->out_cid_len;
622 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
623 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624
625 if( rec->cid_len != 0 )
626 {
Hanno Becker13996922020-05-28 16:15:19 +0100627 size_t padding =
628 ssl_compute_padding_length( rec->data_len,
TRodziewicze8dd7092021-05-12 14:19:11 +0200629 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100630 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100631 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100632 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100634 * Note that this changes `rec->data_len`, and hence
635 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100636 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100637 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100638 &rec->data_len,
639 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100640 rec->type,
641 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100642 {
643 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
644 }
645
646 rec->type = MBEDTLS_SSL_MSG_CID;
647 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100648#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100649
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
651
Paul Bakker5121ce52009-01-03 21:22:43 +0000652 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100653 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000655#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100656#if defined(MBEDTLS_USE_PSA_CRYPTO)
657 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER ||
658 ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING
659#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 if( mode == MBEDTLS_MODE_STREAM ||
661 ( mode == MBEDTLS_MODE_CBC
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100662#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100665#endif
666 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000667 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000668 if( post_avail < transform->maclen )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200673#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200674 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100676#if defined(MBEDTLS_USE_PSA_CRYPTO)
677 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
679 size_t sign_mac_length = 0;
680#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000681
TRodziewicz345165c2021-07-06 13:42:11 +0200682 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000683 transform->minor_ver,
684 transform->taglen );
Hanno Becker992b6872017-11-09 18:57:39 +0000685
Neil Armstrong26e6d672022-02-23 09:30:33 +0100686#if defined(MBEDTLS_USE_PSA_CRYPTO)
687 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
688 transform->psa_mac_alg );
689 if( status != PSA_SUCCESS )
690 goto hmac_failed_etm_disabled;
691
692 status = psa_mac_update( &operation, add_data, add_data_len );
693 if( status != PSA_SUCCESS )
694 goto hmac_failed_etm_disabled;
695
696 status = psa_mac_update( &operation, data, rec->data_len );
697 if( status != PSA_SUCCESS )
698 goto hmac_failed_etm_disabled;
699
700 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
701 &sign_mac_length );
702 if( status != PSA_SUCCESS )
703 goto hmac_failed_etm_disabled;
704#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100705 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
706 add_data_len );
707 if( ret != 0 )
708 goto hmac_failed_etm_disabled;
709 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, data, rec->data_len );
710 if( ret != 0 )
711 goto hmac_failed_etm_disabled;
712 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
713 if( ret != 0 )
714 goto hmac_failed_etm_disabled;
715 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
716 if( ret != 0 )
717 goto hmac_failed_etm_disabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100718#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719
TRodziewicz345165c2021-07-06 13:42:11 +0200720 memcpy( data + rec->data_len, mac, transform->maclen );
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200721#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000723 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
724 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200725
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 rec->data_len += transform->maclen;
727 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100728 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100729
730 hmac_failed_etm_disabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +0100731 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +0100732#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +0100733 ret = psa_ssl_status_to_mbedtls( status );
734 status = psa_mac_abort( &operation );
735 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +0100736 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +0100737#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100738 if( ret != 0 )
739 {
740 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
741 return( ret );
742 }
Paul Bakker577e0062013-08-28 11:57:20 +0200743 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000744#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000745
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200746 /*
747 * Encrypt
748 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000749#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100750#if defined(MBEDTLS_USE_PSA_CRYPTO)
751 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
752#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100754#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000755 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000756 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757 "including %d bytes of padding",
758 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000759
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100760 /* The only supported stream cipher is "NULL",
761 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000762 }
Paul Bakker68884e32013-01-07 18:20:04 +0100763 else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000764#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000765
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200766#if defined(MBEDTLS_GCM_C) || \
767 defined(MBEDTLS_CCM_C) || \
768 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100769#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +0100770 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100771#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200773 mode == MBEDTLS_MODE_CCM ||
774 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100775#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000776 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200777 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100778 unsigned char *dynamic_iv;
779 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100780 int dynamic_iv_is_explicit =
781 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100782#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100784#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000786
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100787 /* Check that there's space for the authentication tag. */
788 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 {
790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
791 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
792 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000793
Paul Bakker68884e32013-01-07 18:20:04 +0100794 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100795 * Build nonce for AEAD encryption.
796 *
797 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
798 * part of the IV is prepended to the ciphertext and
799 * can be chosen freely - in particular, it need not
800 * agree with the record sequence number.
801 * However, since ChaChaPoly as well as all AEAD modes
802 * in TLS 1.3 use the record sequence number as the
803 * dynamic part of the nonce, we uniformly use the
804 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100805 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100806 dynamic_iv = rec->ctr;
807 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200808
Hanno Becker17263802020-05-28 07:05:48 +0100809 ssl_build_record_nonce( iv, sizeof( iv ),
810 transform->iv_enc,
811 transform->fixed_ivlen,
812 dynamic_iv,
813 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100814
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100815 /*
816 * Build additional data for AEAD encryption.
817 * This depends on the TLS version.
818 */
819 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000820 transform->minor_ver,
821 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +0100822
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200823 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100824 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200825 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100826 dynamic_iv,
827 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100829 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000830 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200831 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000833
Paul Bakker68884e32013-01-07 18:20:04 +0100834 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200835 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200836 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100837#if defined(MBEDTLS_USE_PSA_CRYPTO)
838 status = psa_aead_encrypt( transform->psa_key_enc,
839 transform->psa_alg,
840 iv, transform->ivlen,
841 add_data, add_data_len,
842 data, rec->data_len,
843 data, rec->buf_len - (data - rec->buf),
844 &rec->data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000845
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100846 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100847 {
848 ret = psa_ssl_status_to_mbedtls( status );
849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_encrypt_buf", ret );
850 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100851 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100852#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100853 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000854 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100855 add_data, add_data_len,
856 data, rec->data_len, /* src */
857 data, rec->buf_len - (data - rec->buf), /* dst */
858 &rec->data_len,
859 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200860 {
TRodziewicz18efb732021-04-29 23:12:19 +0200861 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt_ext", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200862 return( ret );
863 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100864#endif /* MBEDTLS_USE_PSA_CRYPTO */
865
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000866 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100867 data + rec->data_len - transform->taglen,
868 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100869 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100871
872 /*
873 * Prefix record content with dynamic IV in case it is explicit.
874 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100875 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100876 {
877 if( rec->data_offset < dynamic_iv_len )
878 {
879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
880 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
881 }
882
883 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
884 rec->data_offset -= dynamic_iv_len;
885 rec->data_len += dynamic_iv_len;
886 }
887
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100888 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000889 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000890 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100891#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200892#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100893#if defined(MBEDTLS_USE_PSA_CRYPTO)
894 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
895#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100897#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +0000898 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000899 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000900 size_t padlen, i;
901 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100902#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100903 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100904 size_t part_len;
905 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
906#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000907
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000908 /* Currently we're always using minimal padding
909 * (up to 255 bytes would be allowed). */
910 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
911 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000912 padlen = 0;
913
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000914 /* Check there's enough space in the buffer for the padding. */
915 if( post_avail < padlen + 1 )
916 {
917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
918 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
919 }
920
Paul Bakker5121ce52009-01-03 21:22:43 +0000921 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000923
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000924 rec->data_len += padlen + 1;
925 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000926
TRodziewicz0f82ec62021-05-12 17:49:18 +0200927#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000928 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +0200929 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +0000930 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000931 */
TRodziewicz345165c2021-07-06 13:42:11 +0200932 if( f_rng == NULL )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000933 {
TRodziewicz345165c2021-07-06 13:42:11 +0200934 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
935 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000936 }
TRodziewicz345165c2021-07-06 13:42:11 +0200937
938 if( rec->data_offset < transform->ivlen )
939 {
940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
941 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
942 }
943
944 /*
945 * Generate IV
946 */
947 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
948 if( ret != 0 )
949 return( ret );
950
951 memcpy( data - transform->ivlen, transform->iv_enc, transform->ivlen );
TRodziewicz0f82ec62021-05-12 17:49:18 +0200952#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000953
Paul Elliottd48d5c62021-01-07 14:47:05 +0000954 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
955 "including %" MBEDTLS_PRINTF_SIZET
956 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000957 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200958 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000959
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100960#if defined(MBEDTLS_USE_PSA_CRYPTO)
961 status = psa_cipher_encrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +0100962 transform->psa_key_enc, transform->psa_alg );
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100963
964 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100965 {
966 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100967 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_encrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100968 return( ret );
969 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100970
971 status = psa_cipher_set_iv( &cipher_op, transform->iv_enc, transform->ivlen );
972
973 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100974 {
975 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100976 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100977 return( ret );
978
979 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100980
981 status = psa_cipher_update( &cipher_op,
982 data, rec->data_len,
983 data, rec->data_len, &olen );
984
985 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100986 {
987 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +0100988 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100989 return( ret );
990
991 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100992
993 status = psa_cipher_finish( &cipher_op,
994 data + olen, rec->data_len - olen,
995 &part_len );
996
997 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100998 {
999 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001000 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001001 return( ret );
1002
1003 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001004
1005 olen += part_len;
1006#else
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001007 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1008 transform->iv_enc,
1009 transform->ivlen,
1010 data, rec->data_len,
1011 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001012 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001014 return( ret );
1015 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001016#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001017
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001018 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001019 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1021 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001022 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001023
TRodziewicz0f82ec62021-05-12 17:49:18 +02001024 data -= transform->ivlen;
1025 rec->data_offset -= transform->ivlen;
1026 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001029 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001030 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001031 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001032#if defined(MBEDTLS_USE_PSA_CRYPTO)
1033 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1034 size_t sign_mac_length = 0;
1035#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001036
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001037 /*
1038 * MAC(MAC_write_key, seq_num +
1039 * TLSCipherText.type +
1040 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001041 * length_of( (IV +) ENC(...) ) +
TRodziewicz2abf03c2021-06-25 14:40:09 +02001042 * IV +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001043 * ENC(content + padding + padding_length));
1044 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001045
1046 if( post_avail < transform->maclen)
1047 {
1048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1049 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1050 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001051
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001052 ssl_extract_add_data_from_record( add_data, &add_data_len,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001053 rec, transform->minor_ver,
1054 transform->taglen );
Hanno Becker1f10d762019-04-26 13:34:37 +01001055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001057 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001058 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001059#if defined(MBEDTLS_USE_PSA_CRYPTO)
1060 status = psa_mac_sign_setup( &operation, transform->psa_mac_enc,
1061 transform->psa_mac_alg );
1062 if( status != PSA_SUCCESS )
1063 goto hmac_failed_etm_enabled;
1064
1065 status = psa_mac_update( &operation, add_data, add_data_len );
1066 if( status != PSA_SUCCESS )
1067 goto hmac_failed_etm_enabled;
1068
1069 status = psa_mac_update( &operation, data, rec->data_len );
1070 if( status != PSA_SUCCESS )
1071 goto hmac_failed_etm_enabled;
1072
1073 status = psa_mac_sign_finish( &operation, mac, MBEDTLS_SSL_MAC_ADD,
1074 &sign_mac_length );
1075 if( status != PSA_SUCCESS )
1076 goto hmac_failed_etm_enabled;
1077#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001078
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001079 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1080 add_data_len );
1081 if( ret != 0 )
1082 goto hmac_failed_etm_enabled;
1083 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1084 data, rec->data_len );
1085 if( ret != 0 )
1086 goto hmac_failed_etm_enabled;
1087 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1088 if( ret != 0 )
1089 goto hmac_failed_etm_enabled;
1090 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1091 if( ret != 0 )
1092 goto hmac_failed_etm_enabled;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001093#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001094
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001095 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001096
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001097 rec->data_len += transform->maclen;
1098 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001099 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001100
1101 hmac_failed_etm_enabled:
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001102 mbedtls_platform_zeroize( mac, transform->maclen );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001104 ret = psa_ssl_status_to_mbedtls( status );
1105 status = psa_mac_abort( &operation );
1106 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107 ret = psa_ssl_status_to_mbedtls( status );
Neil Armstrong4313f552022-03-02 15:14:07 +01001108#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001109 if( ret != 0 )
1110 {
1111 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1112 return( ret );
1113 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001114 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001116 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001117 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001118#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1121 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001122 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001123
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001124 /* Make extra sure authentication was performed, exactly once */
1125 if( auth_done != 1 )
1126 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1128 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001129 }
1130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001132
1133 return( 0 );
1134}
1135
Hanno Becker605949f2019-07-12 08:23:59 +01001136int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001137 mbedtls_ssl_transform *transform,
1138 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001139{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001140 size_t olen;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001141#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001142 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001143
1144#else
1145 mbedtls_cipher_mode_t mode;
1146 int ret;
1147#endif /* MBEDTLS_USE_PSA_CRYPTO */
1148
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001149 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001150#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001151 size_t padlen = 0, correct = 1;
1152#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001153 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001154 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001155 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001156
Hanno Beckera18d1322018-01-03 14:27:32 +00001157#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001158 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001159 ((void) ssl);
1160#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001163 if( rec == NULL ||
1164 rec->buf == NULL ||
1165 rec->buf_len < rec->data_offset ||
1166 rec->buf_len - rec->data_offset < rec->data_len )
1167 {
1168 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001170 }
1171
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001172 data = rec->buf + rec->data_offset;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001173#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001174 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001175#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001176
Hanno Beckera0e20d02019-05-15 14:03:01 +01001177#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001178 /*
1179 * Match record's CID with incoming CID.
1180 */
Hanno Becker938489a2019-05-08 13:02:22 +01001181 if( rec->cid_len != transform->in_cid_len ||
1182 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1183 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001184 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001185 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001186#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001187
Hanno Beckerd086bf02021-03-22 13:01:27 +00001188#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001189#if defined(MBEDTLS_USE_PSA_CRYPTO)
1190 if ( transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
1191#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 if( mode == MBEDTLS_MODE_STREAM )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001193#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker68884e32013-01-07 18:20:04 +01001194 {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001195 /* The only supported stream cipher is "NULL",
1196 * so there's nothing to do here.*/
Paul Bakker5121ce52009-01-03 21:22:43 +00001197 }
Paul Bakker68884e32013-01-07 18:20:04 +01001198 else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001199#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001200#if defined(MBEDTLS_GCM_C) || \
1201 defined(MBEDTLS_CCM_C) || \
1202 defined(MBEDTLS_CHACHAPOLY_C)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001203#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekiele8847782022-01-24 23:19:21 +01001204 if ( PSA_ALG_IS_AEAD( transform->psa_alg ) )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001205#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001207 mode == MBEDTLS_MODE_CCM ||
1208 mode == MBEDTLS_MODE_CHACHAPOLY )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001209#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001210 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001211 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001212 unsigned char *dynamic_iv;
1213 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001214#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001216#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001217
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001218 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001219 * Extract dynamic part of nonce for AEAD decryption.
1220 *
1221 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1222 * part of the IV is prepended to the ciphertext and
1223 * can be chosen freely - in particular, it need not
1224 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001225 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001226 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001227 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001228 {
1229 if( rec->data_len < dynamic_iv_len )
1230 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1232 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001233 rec->data_len,
1234 dynamic_iv_len ) );
1235 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1236 }
1237 dynamic_iv = data;
1238
1239 data += dynamic_iv_len;
1240 rec->data_offset += dynamic_iv_len;
1241 rec->data_len -= dynamic_iv_len;
1242 }
Hanno Becker17263802020-05-28 07:05:48 +01001243 else
1244 {
1245 dynamic_iv = rec->ctr;
1246 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001247
1248 /* Check that there's space for the authentication tag. */
1249 if( rec->data_len < transform->taglen )
1250 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1252 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001253 rec->data_len,
1254 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001256 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001257 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001258
Hanno Beckerdf8be222020-05-21 15:30:57 +01001259 /*
1260 * Prepare nonce from dynamic and static parts.
1261 */
Hanno Becker17263802020-05-28 07:05:48 +01001262 ssl_build_record_nonce( iv, sizeof( iv ),
1263 transform->iv_dec,
1264 transform->fixed_ivlen,
1265 dynamic_iv,
1266 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001267
Hanno Beckerdf8be222020-05-21 15:30:57 +01001268 /*
1269 * Build additional data for AEAD encryption.
1270 * This depends on the TLS version.
1271 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001272 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001273 transform->minor_ver,
1274 transform->taglen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001276 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001277
Hanno Beckerd96a6522019-07-10 13:55:25 +01001278 /* Because of the check above, we know that there are
1279 * explicit_iv_len Bytes preceeding data, and taglen
1280 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001281 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001282 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001283
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001284 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001286 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001287
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001288 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001289 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001290 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001291#if defined(MBEDTLS_USE_PSA_CRYPTO)
1292 status = psa_aead_decrypt( transform->psa_key_dec,
1293 transform->psa_alg,
1294 iv, transform->ivlen,
1295 add_data, add_data_len,
1296 data, rec->data_len + transform->taglen,
1297 data, rec->buf_len - (data - rec->buf),
Przemyslaw Stekiel221b5272022-01-20 09:18:44 +01001298 &olen );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001299
1300 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001301 {
1302 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001303 MBEDTLS_SSL_DEBUG_RET( 1, "psa_aead_decrypt", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001304 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001305 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001306#else
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001307 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001308 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001309 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001310 data, rec->data_len + transform->taglen, /* src */
1311 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001312 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001313 {
TRodziewicz18efb732021-04-29 23:12:19 +02001314 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt_ext", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1317 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001318
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001319 return( ret );
1320 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001321#endif /* MBEDTLS_USE_PSA_CRYPTO */
1322
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001323 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001324
Hanno Beckerd96a6522019-07-10 13:55:25 +01001325 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001326 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1329 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001330 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001331 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001332 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001334#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001335#if defined(MBEDTLS_USE_PSA_CRYPTO)
1336 if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
1337#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 if( mode == MBEDTLS_MODE_CBC )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001339#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker5121ce52009-01-03 21:22:43 +00001340 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001341 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001342#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001344 size_t part_len;
1345 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1346#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001347
Paul Bakker5121ce52009-01-03 21:22:43 +00001348 /*
Paul Bakker45829992013-01-03 14:52:21 +01001349 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001350 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001351#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001352 /* The ciphertext is prefixed with the CBC IV. */
1353 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001354#endif
Paul Bakker45829992013-01-03 14:52:21 +01001355
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001356 /* Size considerations:
1357 *
1358 * - The CBC cipher text must not be empty and hence
1359 * at least of size transform->ivlen.
1360 *
1361 * Together with the potential IV-prefix, this explains
1362 * the first of the two checks below.
1363 *
1364 * - The record must contain a MAC, either in plain or
1365 * encrypted, depending on whether Encrypt-then-MAC
1366 * is used or not.
1367 * - If it is, the message contains the IV-prefix,
1368 * the CBC ciphertext, and the MAC.
1369 * - If it is not, the padded plaintext, and hence
1370 * the CBC ciphertext, has at least length maclen + 1
1371 * because there is at least the padding length byte.
1372 *
1373 * As the CBC ciphertext is not empty, both cases give the
1374 * lower bound minlen + maclen + 1 on the record size, which
1375 * we test for in the second check below.
1376 */
1377 if( rec->data_len < minlen + transform->ivlen ||
1378 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001379 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1381 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1382 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001383 "+ 1 ) ( + expl IV )", rec->data_len,
1384 transform->ivlen,
1385 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001387 }
1388
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001389 /*
1390 * Authenticate before decrypt if enabled
1391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001393 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001394 {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001395#if defined(MBEDTLS_USE_PSA_CRYPTO)
1396 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1397#else
Hanno Becker992b6872017-11-09 18:57:39 +00001398 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001399#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001402
Hanno Beckerd96a6522019-07-10 13:55:25 +01001403 /* Update data_len in tandem with add_data.
1404 *
1405 * The subtraction is safe because of the previous check
1406 * data_len >= minlen + maclen + 1.
1407 *
1408 * Afterwards, we know that data + data_len is followed by at
1409 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001410 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001411 *
1412 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001414 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001415 transform->minor_ver,
1416 transform->taglen );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001417
Hanno Beckerd96a6522019-07-10 13:55:25 +01001418 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001419 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1420 add_data_len );
Neil Armstrong26e6d672022-02-23 09:30:33 +01001421#if defined(MBEDTLS_USE_PSA_CRYPTO)
1422 status = psa_mac_verify_setup( &operation, transform->psa_mac_dec,
1423 transform->psa_mac_alg );
1424 if( status != PSA_SUCCESS )
1425 goto hmac_failed_etm_enabled;
1426
1427 status = psa_mac_update( &operation, add_data, add_data_len );
1428 if( status != PSA_SUCCESS )
1429 goto hmac_failed_etm_enabled;
1430
1431 status = psa_mac_update( &operation, data, rec->data_len );
1432 if( status != PSA_SUCCESS )
1433 goto hmac_failed_etm_enabled;
1434
1435 /* Compare expected MAC with MAC at the end of the record. */
1436 status = psa_mac_verify_finish( &operation, data + rec->data_len,
1437 transform->maclen );
1438 if( status != PSA_SUCCESS )
1439 goto hmac_failed_etm_enabled;
1440#else
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001441 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1442 add_data_len );
1443 if( ret != 0 )
1444 goto hmac_failed_etm_enabled;
1445 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001446 data, rec->data_len );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001447 if( ret != 0 )
1448 goto hmac_failed_etm_enabled;
1449 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1450 if( ret != 0 )
1451 goto hmac_failed_etm_enabled;
1452 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1453 if( ret != 0 )
1454 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001455
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001456 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1457 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001458 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001460
Hanno Beckerd96a6522019-07-10 13:55:25 +01001461 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei90437e32021-10-20 11:59:27 +02001462 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001463 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001464 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001466 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1467 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001468 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001469#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001470 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001471
1472 hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001473#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstrong4313f552022-03-02 15:14:07 +01001474 ret = psa_ssl_status_to_mbedtls( status );
1475 status = psa_mac_abort( &operation );
1476 if( ret == 0 && status != PSA_SUCCESS )
Neil Armstrong26e6d672022-02-23 09:30:33 +01001477 ret = psa_ssl_status_to_mbedtls( status );
1478#else
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001479 mbedtls_platform_zeroize( mac_expect, transform->maclen );
Neil Armstrong4313f552022-03-02 15:14:07 +01001480#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001481 if( ret != 0 )
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001482 {
1483 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1484 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001485 return( ret );
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001486 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001487 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001489
1490 /*
1491 * Check length sanity
1492 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001493
1494 /* We know from above that data_len > minlen >= 0,
1495 * so the following check in particular implies that
1496 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001497 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001498 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1500 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001501 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001502 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001503 }
1504
TRodziewicz0f82ec62021-05-12 17:49:18 +02001505#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001506 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001507 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001508 */
TRodziewicz345165c2021-07-06 13:42:11 +02001509 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
1510 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001511
TRodziewicz345165c2021-07-06 13:42:11 +02001512 data += transform->ivlen;
1513 rec->data_offset += transform->ivlen;
1514 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001515#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001516
Hanno Beckerd96a6522019-07-10 13:55:25 +01001517 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1518
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001519#if defined(MBEDTLS_USE_PSA_CRYPTO)
1520 status = psa_cipher_decrypt_setup( &cipher_op,
Przemyslaw Stekield4eab572022-01-17 16:20:10 +01001521 transform->psa_key_dec, transform->psa_alg );
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001522
1523 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001524 {
1525 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001526 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_decrypt_setup", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001527 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001528 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001529
1530 status = psa_cipher_set_iv( &cipher_op, transform->iv_dec, transform->ivlen );
1531
1532 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001533 {
1534 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001535 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_set_iv", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001536 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001537 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001538
1539 status = psa_cipher_update( &cipher_op,
1540 data, rec->data_len,
1541 data, rec->data_len, &olen );
1542
1543 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001544 {
1545 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001546 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_update", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001547 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001548 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001549
1550 status = psa_cipher_finish( &cipher_op,
1551 data + olen, rec->data_len - olen,
1552 &part_len );
1553
1554 if( status != PSA_SUCCESS )
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001555 {
1556 ret = psa_ssl_status_to_mbedtls( status );
Przemyslaw Stekielc499e332022-02-07 15:12:05 +01001557 MBEDTLS_SSL_DEBUG_RET( 1, "psa_cipher_finish", ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001558 return( ret );
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001559 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001560
1561 olen += part_len;
1562#else
1563
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1565 transform->iv_dec, transform->ivlen,
1566 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001567 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001569 return( ret );
1570 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001571#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001572
Hanno Beckerd96a6522019-07-10 13:55:25 +01001573 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001574 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1577 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001578 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001579
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001580 /* Safe since data_len >= minlen + maclen + 1, so after having
1581 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001582 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1583 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001584 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001585
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 if( auth_done == 1 )
1587 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001588 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001589 rec->data_len,
1590 padlen + 1 );
1591 correct &= mask;
1592 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593 }
1594 else
Paul Bakker45829992013-01-03 14:52:21 +01001595 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001597 if( rec->data_len < transform->maclen + padlen + 1 )
1598 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1600 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1601 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001602 rec->data_len,
1603 transform->maclen,
1604 padlen + 1 ) );
1605 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001606#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001607
Gabor Mezei90437e32021-10-20 11:59:27 +02001608 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001609 rec->data_len,
1610 transform->maclen + padlen + 1 );
1611 correct &= mask;
1612 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001613 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001614
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001615 padlen++;
1616
1617 /* Regardless of the validity of the padding,
1618 * we have data_len >= padlen here. */
1619
TRodziewicz0f82ec62021-05-12 17:49:18 +02001620#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001621 /* The padding check involves a series of up to 256
1622 * consecutive memory reads at the end of the record
1623 * plaintext buffer. In order to hide the length and
1624 * validity of the padding, always perform exactly
1625 * `min(256,plaintext_len)` reads (but take into account
1626 * only the last `padlen` bytes for the padding check). */
1627 size_t pad_count = 0;
1628 volatile unsigned char* const check = data;
1629
1630 /* Index of first padding byte; it has been ensured above
1631 * that the subtraction is safe. */
1632 size_t const padding_idx = rec->data_len - padlen;
1633 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1634 size_t const start_idx = rec->data_len - num_checks;
1635 size_t idx;
1636
1637 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakker5121ce52009-01-03 21:22:43 +00001638 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001639 /* pad_count += (idx >= padding_idx) &&
1640 * (check[idx] == padlen - 1);
1641 */
Gabor Mezei90437e32021-10-20 11:59:27 +02001642 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1643 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001644 padlen - 1 );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001645 pad_count += mask & equal;
1646 }
Gabor Mezei90437e32021-10-20 11:59:27 +02001647 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#if defined(MBEDTLS_SSL_DEBUG_ALL)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001650 if( padlen > 0 && correct == 0 )
1651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001652#endif
Gabor Mezei90437e32021-10-20 11:59:27 +02001653 padlen &= mbedtls_ct_size_mask( correct );
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001654
TRodziewicz0f82ec62021-05-12 17:49:18 +02001655#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001656
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001657 /* If the padding was found to be invalid, padlen == 0
1658 * and the subtraction is safe. If the padding was found valid,
1659 * padlen hasn't been changed and the previous assertion
1660 * data_len >= padlen still holds. */
1661 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001662 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001663 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001664#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1667 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001668 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001669
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001670#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001672 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001673#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
1675 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001676 * Authenticate if not done yet.
1677 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001678 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001679#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001680 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001681 {
Hanno Becker992b6872017-11-09 18:57:39 +00001682 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001683 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001684
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001685 /* If the initial value of padlen was such that
1686 * data_len < maclen + padlen + 1, then padlen
1687 * got reset to 1, and the initial check
1688 * data_len >= minlen + maclen + 1
1689 * guarantees that at this point we still
1690 * have at least data_len >= maclen.
1691 *
1692 * If the initial value of padlen was such that
1693 * data_len >= maclen + padlen + 1, then we have
1694 * subtracted either padlen + 1 (if the padding was correct)
1695 * or 0 (if the padding was incorrect) since then,
1696 * hence data_len >= maclen in any case.
1697 */
1698 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001699 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
Hanno Becker79e2d1b2021-03-22 11:42:19 +00001700 transform->minor_ver,
1701 transform->taglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001702
TRodziewicz0f82ec62021-05-12 17:49:18 +02001703#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001704 /*
1705 * The next two sizes are the minimum and maximum values of
1706 * data_len over all padlen values.
1707 *
1708 * They're independent of padlen, since we previously did
1709 * data_len -= padlen.
1710 *
1711 * Note that max_len + maclen is never more than the buffer
1712 * length, as we previously did in_msglen -= maclen too.
1713 */
1714 const size_t max_len = rec->data_len + padlen;
1715 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1716
Neil Armstronge8589962022-02-25 15:14:29 +01001717#if defined(MBEDTLS_USE_PSA_CRYPTO)
1718 ret = mbedtls_ct_hmac( transform->psa_mac_dec,
1719 transform->psa_mac_alg,
1720 add_data, add_data_len,
1721 data, rec->data_len, min_len, max_len,
1722 mac_expect );
1723#else
Gabor Mezei90437e32021-10-20 11:59:27 +02001724 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001725 add_data, add_data_len,
1726 data, rec->data_len, min_len, max_len,
1727 mac_expect );
Neil Armstronge8589962022-02-25 15:14:29 +01001728#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001729 if( ret != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001730 {
Gabor Mezei90437e32021-10-20 11:59:27 +02001731 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001732 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001733 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001734
Gabor Mezei90437e32021-10-20 11:59:27 +02001735 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arm9fa43ce2021-09-28 16:14:47 +02001736 rec->data_len,
1737 min_len, max_len,
1738 transform->maclen );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001739#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001740
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001741#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001742 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001743 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001744#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001745
Gabor Mezei90437e32021-10-20 11:59:27 +02001746 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm46025642021-07-19 15:19:19 +02001747 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749#if defined(MBEDTLS_SSL_DEBUG_ALL)
1750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001751#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001752 correct = 0;
1753 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001754 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001755
1756 hmac_failed_etm_disabled:
1757 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1758 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1759 if( ret != 0 )
1760 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001761 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001762
1763 /*
1764 * Finally check the correct flag
1765 */
1766 if( correct == 0 )
1767 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001768#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001769
1770 /* Make extra sure authentication was performed, exactly once */
1771 if( auth_done != 1 )
1772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1774 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001775 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001776
Ronald Cron6f135e12021-12-08 16:57:54 +01001777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckerccc13d02020-05-04 12:30:04 +01001778 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1779 {
1780 /* Remove inner padding and infer true content type. */
1781 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1782 &rec->type );
1783
1784 if( ret != 0 )
1785 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1786 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001787#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001788
Hanno Beckera0e20d02019-05-15 14:03:01 +01001789#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001790 if( rec->cid_len != 0 )
1791 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001792 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1793 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001794 if( ret != 0 )
1795 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1796 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001800
1801 return( 0 );
1802}
1803
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001804#undef MAC_NONE
1805#undef MAC_PLAINTEXT
1806#undef MAC_CIPHERTEXT
1807
Paul Bakker5121ce52009-01-03 21:22:43 +00001808/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001809 * Fill the input message buffer by appending data to it.
1810 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001811 *
1812 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1813 * available (from this read and/or a previous one). Otherwise, an error code
1814 * is returned (possibly EOF or WANT_READ).
1815 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001816 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1817 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1818 * since we always read a whole datagram at once.
1819 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001820 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001821 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001824{
Janos Follath865b3eb2019-12-16 11:46:15 +00001825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001826 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001827#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1828 size_t in_buf_len = ssl->in_buf_len;
1829#else
1830 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1831#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001834
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001835 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1836 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001838 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001840 }
1841
Darryl Greenb33cc762019-11-28 14:29:44 +00001842 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001843 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1845 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001846 }
1847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001849 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001850 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001851 uint32_t timeout;
1852
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001853 /*
1854 * The point is, we need to always read a full datagram at once, so we
1855 * sometimes read more then requested, and handle the additional data.
1856 * It could be the rest of the current record (while fetching the
1857 * header) and/or some other records in the same datagram.
1858 */
1859
1860 /*
1861 * Move to the next record in the already read datagram if applicable
1862 */
1863 if( ssl->next_record_offset != 0 )
1864 {
1865 if( ssl->in_left < ssl->next_record_offset )
1866 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1868 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001869 }
1870
1871 ssl->in_left -= ssl->next_record_offset;
1872
1873 if( ssl->in_left != 0 )
1874 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001875 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1876 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001877 ssl->next_record_offset ) );
1878 memmove( ssl->in_hdr,
1879 ssl->in_hdr + ssl->next_record_offset,
1880 ssl->in_left );
1881 }
1882
1883 ssl->next_record_offset = 0;
1884 }
1885
Paul Elliottd48d5c62021-01-07 14:47:05 +00001886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1887 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001888 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001889
1890 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001891 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001892 */
1893 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001894 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001896 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001897 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898
1899 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001900 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001901 * are not at the beginning of a new record, the caller did something
1902 * wrong.
1903 */
1904 if( ssl->in_left != 0 )
1905 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1907 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001908 }
1909
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001910 /*
1911 * Don't even try to read if time's out already.
1912 * This avoids by-passing the timer when repeatedly receiving messages
1913 * that will end up being dropped.
1914 */
Hanno Becker7876d122020-02-05 10:39:31 +00001915 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001916 {
1917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001918 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001919 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001920 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001921 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001922 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001925 timeout = ssl->handshake->retransmit_timeout;
1926 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001927 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001928
Paul Elliott9f352112020-12-09 14:55:45 +00001929 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001930
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001931 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001932 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1933 timeout );
1934 else
1935 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001938
1939 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001941 }
1942
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001943 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001944 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001946 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001949 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001950 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1951 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001953 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001954 }
1955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001959 return( ret );
1960 }
1961
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001962 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001963 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001965 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001967 {
Hanno Becker786300f2020-02-05 10:46:40 +00001968 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001969 {
Hanno Becker786300f2020-02-05 10:46:40 +00001970 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1971 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001972 return( ret );
1973 }
1974
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001975 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001976 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001978 }
1979
Paul Bakker5121ce52009-01-03 21:22:43 +00001980 if( ret < 0 )
1981 return( ret );
1982
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001983 ssl->in_left = ret;
1984 }
1985 else
1986#endif
1987 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1989 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001990 ssl->in_left, nb_want ) );
1991
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001992 while( ssl->in_left < nb_want )
1993 {
1994 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001995
Hanno Becker7876d122020-02-05 10:39:31 +00001996 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001997 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1998 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001999 {
2000 if( ssl->f_recv_timeout != NULL )
2001 {
2002 ret = ssl->f_recv_timeout( ssl->p_bio,
2003 ssl->in_hdr + ssl->in_left, len,
2004 ssl->conf->read_timeout );
2005 }
2006 else
2007 {
2008 ret = ssl->f_recv( ssl->p_bio,
2009 ssl->in_hdr + ssl->in_left, len );
2010 }
2011 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002012
Paul Elliottd48d5c62021-01-07 14:47:05 +00002013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2014 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002015 ssl->in_left, nb_want ) );
2016 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002017
2018 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002020
2021 if( ret < 0 )
2022 return( ret );
2023
makise-homuraaf9513b2020-08-24 18:26:27 +03002024 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002025 {
Darryl Green11999bb2018-03-13 15:22:58 +00002026 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002027 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002028 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002029 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2030 }
2031
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002032 ssl->in_left += ret;
2033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002034 }
2035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002037
2038 return( 0 );
2039}
2040
2041/*
2042 * Flush any data not yet written
2043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002044int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002045{
Janos Follath865b3eb2019-12-16 11:46:15 +00002046 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002047 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002050
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002051 if( ssl->f_send == NULL )
2052 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002054 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002056 }
2057
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002058 /* Avoid incrementing counter if data is flushed */
2059 if( ssl->out_left == 0 )
2060 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002062 return( 0 );
2063 }
2064
Paul Bakker5121ce52009-01-03 21:22:43 +00002065 while( ssl->out_left > 0 )
2066 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002067 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2068 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002069 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002070
Hanno Becker2b1e3542018-08-06 11:19:13 +01002071 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002072 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002075
2076 if( ret <= 0 )
2077 return( ret );
2078
makise-homuraaf9513b2020-08-24 18:26:27 +03002079 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002080 {
Darryl Green11999bb2018-03-13 15:22:58 +00002081 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002082 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002083 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002084 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2085 }
2086
Paul Bakker5121ce52009-01-03 21:22:43 +00002087 ssl->out_left -= ret;
2088 }
2089
Hanno Becker2b1e3542018-08-06 11:19:13 +01002090#if defined(MBEDTLS_SSL_PROTO_DTLS)
2091 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002092 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002093 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002094 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002095 else
2096#endif
2097 {
2098 ssl->out_hdr = ssl->out_buf + 8;
2099 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002100 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
2104 return( 0 );
2105}
2106
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002107/*
2108 * Functions to handle the DTLS retransmission state machine
2109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002111/*
2112 * Append current handshake message to current outgoing flight
2113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002115{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2118 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2119 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002120
2121 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002122 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002123 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002124 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002126 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002127 }
2128
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002129 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002130 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002131 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2132 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002134 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002135 }
2136
2137 /* Copy current handshake message with headers */
2138 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2139 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002140 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002141 msg->next = NULL;
2142
2143 /* Append to the current flight */
2144 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002145 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146 else
2147 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149 while( cur->next != NULL )
2150 cur = cur->next;
2151 cur->next = msg;
2152 }
2153
Hanno Becker3b235902018-08-06 09:54:53 +01002154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002155 return( 0 );
2156}
2157
2158/*
2159 * Free the current flight of handshake messages
2160 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002161void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 mbedtls_ssl_flight_item *cur = flight;
2164 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165
2166 while( cur != NULL )
2167 {
2168 next = cur->next;
2169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 mbedtls_free( cur->p );
2171 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002172
2173 cur = next;
2174 }
2175}
2176
2177/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002178 * Swap transform_out and out_ctr with the alternative ones
2179 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002180static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002181{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002183 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002184
2185 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2186 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002188 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002189 }
2190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002192
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002193 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002194 tmp_transform = ssl->transform_out;
2195 ssl->transform_out = ssl->handshake->alt_transform_out;
2196 ssl->handshake->alt_transform_out = tmp_transform;
2197
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002198 /* Swap epoch + sequence_number */
Jerry Yud96a5c22021-09-29 17:46:51 +08002199 memcpy( tmp_out_ctr, ssl->cur_out_ctr, sizeof( tmp_out_ctr ) );
2200 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2201 sizeof( ssl->cur_out_ctr ) );
2202 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr,
2203 sizeof( ssl->handshake->alt_out_ctr ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002204
2205 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002206 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002207
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002208 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209}
2210
2211/*
2212 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002213 */
2214int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2215{
2216 int ret = 0;
2217
2218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2219
2220 ret = mbedtls_ssl_flight_transmit( ssl );
2221
2222 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2223
2224 return( ret );
2225}
2226
2227/*
2228 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002229 *
2230 * Need to remember the current message in case flush_output returns
2231 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002232 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002233 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002234int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235{
Janos Follath865b3eb2019-12-16 11:46:15 +00002236 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002237 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002240 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002242
2243 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002244 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002245 ret = ssl_swap_epochs( ssl );
2246 if( ret != 0 )
2247 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002250 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002251
2252 while( ssl->handshake->cur_msg != NULL )
2253 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002254 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002255 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002256
Hanno Beckere1dcb032018-08-17 16:47:58 +01002257 int const is_finished =
2258 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2259 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2260
Hanno Becker04da1892018-08-14 13:22:10 +01002261 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2262 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2263
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002264 /* Swap epochs before sending Finished: we can't do it after
2265 * sending ChangeCipherSpec, in case write returns WANT_READ.
2266 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002267 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002268 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002269 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002270 ret = ssl_swap_epochs( ssl );
2271 if( ret != 0 )
2272 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002273 }
2274
Hanno Becker67bc7c32018-08-06 11:33:50 +01002275 ret = ssl_get_remaining_payload_in_datagram( ssl );
2276 if( ret < 0 )
2277 return( ret );
2278 max_frag_len = (size_t) ret;
2279
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002280 /* CCS is copied as is, while HS messages may need fragmentation */
2281 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2282 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002283 if( max_frag_len == 0 )
2284 {
2285 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2286 return( ret );
2287
2288 continue;
2289 }
2290
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002291 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002292 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002293 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002294
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002295 /* Update position inside current message */
2296 ssl->handshake->cur_msg_p += cur->len;
2297 }
2298 else
2299 {
2300 const unsigned char * const p = ssl->handshake->cur_msg_p;
2301 const size_t hs_len = cur->len - 12;
2302 const size_t frag_off = p - ( cur->p + 12 );
2303 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002304 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002305
Hanno Beckere1dcb032018-08-17 16:47:58 +01002306 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002307 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002308 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002309 {
2310 ret = ssl_swap_epochs( ssl );
2311 if( ret != 0 )
2312 return( ret );
2313 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002314
Hanno Becker67bc7c32018-08-06 11:33:50 +01002315 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2316 return( ret );
2317
2318 continue;
2319 }
2320 max_hs_frag_len = max_frag_len - 12;
2321
2322 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2323 max_hs_frag_len : rem_len;
2324
2325 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002326 {
2327 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002328 (unsigned) cur_hs_frag_len,
2329 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002330 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002331
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002332 /* Messages are stored with handshake headers as if not fragmented,
2333 * copy beginning of headers then fill fragmentation fields.
2334 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2335 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002336
Joe Subbiani5ecac212021-06-24 13:00:03 +01002337 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2338 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2339 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002340
Joe Subbiani5ecac212021-06-24 13:00:03 +01002341 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2342 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2343 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002344
2345 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2346
Hanno Becker3f7b9732018-08-28 09:53:25 +01002347 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002348 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2349 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002350 ssl->out_msgtype = cur->type;
2351
2352 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002353 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002354 }
2355
2356 /* If done with the current message move to the next one if any */
2357 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2358 {
2359 if( cur->next != NULL )
2360 {
2361 ssl->handshake->cur_msg = cur->next;
2362 ssl->handshake->cur_msg_p = cur->next->p + 12;
2363 }
2364 else
2365 {
2366 ssl->handshake->cur_msg = NULL;
2367 ssl->handshake->cur_msg_p = NULL;
2368 }
2369 }
2370
2371 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002372 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002375 return( ret );
2376 }
2377 }
2378
Hanno Becker67bc7c32018-08-06 11:33:50 +01002379 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2380 return( ret );
2381
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002382 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2384 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002385 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002386 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002388 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002389 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002390
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002391 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002392
2393 return( 0 );
2394}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002395
2396/*
2397 * To be called when the last message of an incoming flight is received.
2398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002400{
2401 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002402 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002403 ssl->handshake->flight = NULL;
2404 ssl->handshake->cur_msg = NULL;
2405
2406 /* The next incoming flight will start with this msg_seq */
2407 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2408
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002409 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002410 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002411
Hanno Becker0271f962018-08-16 13:23:47 +01002412 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002413 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002414
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002415 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002416 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002417
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2419 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002420 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422 }
2423 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002425}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002426
2427/*
2428 * To be called when the last message of an outgoing flight is send.
2429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002431{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002432 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002433 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002434
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2436 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002437 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002439 }
2440 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002442}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002444
Paul Bakker5121ce52009-01-03 21:22:43 +00002445/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002446 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002447 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448
2449/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002450 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002451 *
2452 * - fill in handshake headers
2453 * - update handshake checksum
2454 * - DTLS: save message for resending
2455 * - then pass to the record layer
2456 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002457 * DTLS: except for HelloRequest, messages are only queued, and will only be
2458 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002459 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002460 * Inputs:
2461 * - ssl->out_msglen: 4 + actual handshake message len
2462 * (4 is the size of handshake headers for TLS)
2463 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2464 * - ssl->out_msg + 4: the handshake message body
2465 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002466 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002467 * - ssl->out_msglen: the length of the record contents
2468 * (including handshake headers but excluding record headers)
2469 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002470 */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002471int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
2472 int update_checksum )
Paul Bakker5121ce52009-01-03 21:22:43 +00002473{
Janos Follath865b3eb2019-12-16 11:46:15 +00002474 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002475 const size_t hs_len = ssl->out_msglen - 4;
2476 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002477
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2479
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002480 /*
2481 * Sanity checks
2482 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002483 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002484 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2485 {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2487 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002488 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002489
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002490 /* Whenever we send anything different from a
2491 * HelloRequest we should be in a handshake - double check. */
2492 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2493 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002494 ssl->handshake == NULL )
2495 {
2496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2497 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2498 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002501 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002502 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002504 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2506 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002507 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002509
Hanno Beckerb50a2532018-08-06 11:52:54 +01002510 /* Double-check that we did not exceed the bounds
2511 * of the outgoing record buffer.
2512 * This should never fail as the various message
2513 * writing functions must obey the bounds of the
2514 * outgoing record buffer, but better be safe.
2515 *
2516 * Note: We deliberately do not check for the MTU or MFL here.
2517 */
2518 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2519 {
2520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002521 "size %" MBEDTLS_PRINTF_SIZET
2522 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002523 ssl->out_msglen,
2524 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002525 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2526 }
2527
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002528 /*
2529 * Fill handshake headers
2530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002532 {
Joe Subbianifbeb6922021-07-16 14:27:50 +01002533 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2534 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2535 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002536
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002537 /*
2538 * DTLS has additional fields in the Handshake layer,
2539 * between the length field and the actual payload:
2540 * uint16 message_seq;
2541 * uint24 fragment_offset;
2542 * uint24 fragment_length;
2543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002545 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002546 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002547 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002548 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002549 {
2550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002551 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002552 hs_len,
2553 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002554 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2555 }
2556
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002557 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002558 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002559
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002560 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002561 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002562 {
Joe Subbiani6dd73642021-07-19 11:56:54 +01002563 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002564 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002565 }
2566 else
2567 {
2568 ssl->out_msg[4] = 0;
2569 ssl->out_msg[5] = 0;
2570 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002571
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002572 /* Handshake hashes are computed without fragmentation,
2573 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002574 memset( ssl->out_msg + 6, 0x00, 3 );
2575 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002576 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002578
Hanno Becker0207e532018-08-28 10:28:28 +01002579 /* Update running hashes of handshake messages seen */
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01002580 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0 )
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002581 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002582 }
2583
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002584 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002586 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002587 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2588 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002589 {
2590 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2591 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002593 return( ret );
2594 }
2595 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002596 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002597#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002598 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002599 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002600 {
2601 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2602 return( ret );
2603 }
2604 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002605
2606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2607
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002608 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002609}
2610
2611/*
2612 * Record layer functions
2613 */
2614
2615/*
2616 * Write current record.
2617 *
2618 * Uses:
2619 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2620 * - ssl->out_msglen: length of the record content (excl headers)
2621 * - ssl->out_msg: record content
2622 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002623int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002624{
2625 int ret, done = 0;
2626 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002627 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002628
2629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002630
Paul Bakker05ef8352012-05-08 09:17:57 +00002631 if( !done )
2632 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002633 unsigned i;
2634 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002635#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2636 size_t out_buf_len = ssl->out_buf_len;
2637#else
2638 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2639#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002640 /* Skip writing the record content type to after the encryption,
2641 * as it may change when using the CID extension. */
Jerry Yu47413c22021-10-29 17:19:41 +08002642 int minor_ver = ssl->minor_ver;
Ronald Cron6f135e12021-12-08 16:57:54 +01002643#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002644 /* TLS 1.3 still uses the TLS 1.2 version identifier
2645 * for backwards compatibility. */
Jerry Yu47413c22021-10-29 17:19:41 +08002646 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
2647 minor_ver = MBEDTLS_SSL_MINOR_VERSION_3;
Ronald Cron6f135e12021-12-08 16:57:54 +01002648#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu47413c22021-10-29 17:19:41 +08002649 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
2650 ssl->conf->transport, ssl->out_hdr + 1 );
Hanno Becker6430faf2019-05-08 11:57:13 +01002651
Jerry Yuae0b2e22021-10-08 15:21:19 +08002652 memcpy( ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Joe Subbiani6dd73642021-07-19 11:56:54 +01002653 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002654
Paul Bakker48916f92012-09-16 19:57:18 +00002655 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002656 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002657 mbedtls_record rec;
2658
2659 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002660 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002661 rec.data_len = ssl->out_msglen;
2662 rec.data_offset = ssl->out_msg - rec.buf;
2663
Jerry Yud96a5c22021-09-29 17:46:51 +08002664 memcpy( &rec.ctr[0], ssl->out_ctr, sizeof( rec.ctr ) );
Jerry Yu47413c22021-10-29 17:19:41 +08002665 mbedtls_ssl_write_version( ssl->major_ver, minor_ver,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002666 ssl->conf->transport, rec.ver );
2667 rec.type = ssl->out_msgtype;
2668
Hanno Beckera0e20d02019-05-15 14:03:01 +01002669#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002670 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002671 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002672#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002673
Hanno Beckera18d1322018-01-03 14:27:32 +00002674 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002675 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002678 return( ret );
2679 }
2680
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002681 if( rec.data_offset != 0 )
2682 {
2683 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2684 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2685 }
2686
Hanno Becker6430faf2019-05-08 11:57:13 +01002687 /* Update the record content type and CID. */
2688 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002689#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002690 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002691#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002692 ssl->out_msglen = len = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01002693 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002694 }
2695
Hanno Becker5903de42019-05-03 14:46:38 +01002696 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002697
2698#if defined(MBEDTLS_SSL_PROTO_DTLS)
2699 /* In case of DTLS, double-check that we don't exceed
2700 * the remaining space in the datagram. */
2701 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2702 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002703 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002704 if( ret < 0 )
2705 return( ret );
2706
2707 if( protected_record_size > (size_t) ret )
2708 {
2709 /* Should never happen */
2710 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2711 }
2712 }
2713#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002714
Hanno Becker6430faf2019-05-08 11:57:13 +01002715 /* Now write the potentially updated record content type. */
2716 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2717
Paul Elliott9f352112020-12-09 14:55:45 +00002718 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002719 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002720 ssl->out_hdr[0], ssl->out_hdr[1],
2721 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002724 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002725
2726 ssl->out_left += protected_record_size;
2727 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002728 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002729
Hanno Beckerdd772292020-02-05 10:38:31 +00002730 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002731 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2732 break;
2733
2734 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002735 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002736 {
2737 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2738 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2739 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002740 }
2741
Hanno Becker67bc7c32018-08-06 11:33:50 +01002742#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002743 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2744 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002745 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002746 size_t remaining;
2747 ret = ssl_get_remaining_payload_in_datagram( ssl );
2748 if( ret < 0 )
2749 {
2750 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2751 ret );
2752 return( ret );
2753 }
2754
2755 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002756 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002757 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002758 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002759 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002760 else
2761 {
Hanno Becker513815a2018-08-20 11:56:09 +01002762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002763 }
2764 }
2765#endif /* MBEDTLS_SSL_PROTO_DTLS */
2766
2767 if( ( flush == SSL_FORCE_FLUSH ) &&
2768 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002769 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002771 return( ret );
2772 }
2773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002775
2776 return( 0 );
2777}
2778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002780
2781static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2782{
2783 if( ssl->in_msglen < ssl->in_hslen ||
2784 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2785 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2786 {
2787 return( 1 );
2788 }
2789 return( 0 );
2790}
Hanno Becker44650b72018-08-16 12:51:11 +01002791
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002792static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002793{
2794 return( ( ssl->in_msg[9] << 16 ) |
2795 ( ssl->in_msg[10] << 8 ) |
2796 ssl->in_msg[11] );
2797}
2798
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002799static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002800{
2801 return( ( ssl->in_msg[6] << 16 ) |
2802 ( ssl->in_msg[7] << 8 ) |
2803 ssl->in_msg[8] );
2804}
2805
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002806static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002807{
2808 uint32_t msg_len, frag_off, frag_len;
2809
2810 msg_len = ssl_get_hs_total_len( ssl );
2811 frag_off = ssl_get_hs_frag_off( ssl );
2812 frag_len = ssl_get_hs_frag_len( ssl );
2813
2814 if( frag_off > msg_len )
2815 return( -1 );
2816
2817 if( frag_len > msg_len - frag_off )
2818 return( -1 );
2819
2820 if( frag_len + 12 > ssl->in_msglen )
2821 return( -1 );
2822
2823 return( 0 );
2824}
2825
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002826/*
2827 * Mark bits in bitmask (used for DTLS HS reassembly)
2828 */
2829static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2830{
2831 unsigned int start_bits, end_bits;
2832
2833 start_bits = 8 - ( offset % 8 );
2834 if( start_bits != 8 )
2835 {
2836 size_t first_byte_idx = offset / 8;
2837
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002838 /* Special case */
2839 if( len <= start_bits )
2840 {
2841 for( ; len != 0; len-- )
2842 mask[first_byte_idx] |= 1 << ( start_bits - len );
2843
2844 /* Avoid potential issues with offset or len becoming invalid */
2845 return;
2846 }
2847
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002848 offset += start_bits; /* Now offset % 8 == 0 */
2849 len -= start_bits;
2850
2851 for( ; start_bits != 0; start_bits-- )
2852 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2853 }
2854
2855 end_bits = len % 8;
2856 if( end_bits != 0 )
2857 {
2858 size_t last_byte_idx = ( offset + len ) / 8;
2859
2860 len -= end_bits; /* Now len % 8 == 0 */
2861
2862 for( ; end_bits != 0; end_bits-- )
2863 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2864 }
2865
2866 memset( mask + offset / 8, 0xFF, len / 8 );
2867}
2868
2869/*
2870 * Check that bitmask is full
2871 */
2872static int ssl_bitmask_check( unsigned char *mask, size_t len )
2873{
2874 size_t i;
2875
2876 for( i = 0; i < len / 8; i++ )
2877 if( mask[i] != 0xFF )
2878 return( -1 );
2879
2880 for( i = 0; i < len % 8; i++ )
2881 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2882 return( -1 );
2883
2884 return( 0 );
2885}
2886
Hanno Becker56e205e2018-08-16 09:06:12 +01002887/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002888static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002889 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002890{
Hanno Becker56e205e2018-08-16 09:06:12 +01002891 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002892
Hanno Becker56e205e2018-08-16 09:06:12 +01002893 alloc_len = 12; /* Handshake header */
2894 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002895
Hanno Beckerd07df862018-08-16 09:14:58 +01002896 if( add_bitmap )
2897 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002898
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002899 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002900}
Hanno Becker56e205e2018-08-16 09:06:12 +01002901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002903
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002904static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002905{
2906 return( ( ssl->in_msg[1] << 16 ) |
2907 ( ssl->in_msg[2] << 8 ) |
2908 ssl->in_msg[3] );
2909}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002910
Simon Butcher99000142016-10-13 17:21:01 +01002911int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002912{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002914 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002916 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002918 }
2919
Hanno Becker12555c62018-08-16 12:47:53 +01002920 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002923 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002924 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002927 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002928 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002929 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002930 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002931
Hanno Becker44650b72018-08-16 12:51:11 +01002932 if( ssl_check_hs_header( ssl ) != 0 )
2933 {
2934 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2935 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2936 }
2937
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002938 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002939 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2940 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2941 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2942 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002943 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002944 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2945 {
2946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2947 recv_msg_seq,
2948 ssl->handshake->in_msg_seq ) );
2949 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2950 }
2951
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002952 /* Retransmit only on last message from previous flight, to avoid
2953 * too many retransmissions.
2954 * Besides, No sane server ever retransmits HelloVerifyRequest */
2955 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00002959 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002960 recv_msg_seq,
2961 ssl->handshake->in_flight_start_seq ) );
2962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002966 return( ret );
2967 }
2968 }
2969 else
2970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00002972 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002973 recv_msg_seq,
2974 ssl->handshake->in_msg_seq ) );
2975 }
2976
Hanno Becker90333da2017-10-10 11:27:13 +01002977 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002978 }
2979 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002980
Hanno Becker6d97ef52018-08-16 13:09:04 +01002981 /* Message reassembly is handled alongside buffering of future
2982 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002983 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002984 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002985 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002988 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002989 }
2990 }
2991 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002993 /* With TLS we don't handle fragmentation (for now) */
2994 if( ssl->in_msglen < ssl->in_hslen )
2995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2997 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002998 }
2999
Simon Butcher99000142016-10-13 17:21:01 +01003000 return( 0 );
3001}
3002
3003void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3004{
Hanno Becker0271f962018-08-16 13:23:47 +01003005 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003006
Hanno Becker0271f962018-08-16 13:23:47 +01003007 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003008 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003009 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003010 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003011
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003012 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003014 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003015 ssl->handshake != NULL )
3016 {
Hanno Becker0271f962018-08-16 13:23:47 +01003017 unsigned offset;
3018 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003019
Hanno Becker0271f962018-08-16 13:23:47 +01003020 /* Increment handshake sequence number */
3021 hs->in_msg_seq++;
3022
3023 /*
3024 * Clear up handshake buffering and reassembly structure.
3025 */
3026
3027 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003028 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003029
3030 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003031 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3032 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003033 offset++, hs_buf++ )
3034 {
3035 *hs_buf = *(hs_buf + 1);
3036 }
3037
3038 /* Create a fresh last entry */
3039 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003040 }
3041#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003042}
3043
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003044/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003045 * DTLS anti-replay: RFC 6347 4.1.2.6
3046 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003047 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3048 * Bit n is set iff record number in_window_top - n has been seen.
3049 *
3050 * Usually, in_window_top is the last record number seen and the lsb of
3051 * in_window is set. The only exception is the initial state (record number 0
3052 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003055void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003056{
3057 ssl->in_window_top = 0;
3058 ssl->in_window = 0;
3059}
3060
3061static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3062{
3063 return( ( (uint64_t) buf[0] << 40 ) |
3064 ( (uint64_t) buf[1] << 32 ) |
3065 ( (uint64_t) buf[2] << 24 ) |
3066 ( (uint64_t) buf[3] << 16 ) |
3067 ( (uint64_t) buf[4] << 8 ) |
3068 ( (uint64_t) buf[5] ) );
3069}
3070
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003071static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3072{
Janos Follath865b3eb2019-12-16 11:46:15 +00003073 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003074 unsigned char *original_in_ctr;
3075
3076 // save original in_ctr
3077 original_in_ctr = ssl->in_ctr;
3078
3079 // use counter from record
3080 ssl->in_ctr = record_in_ctr;
3081
3082 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3083
3084 // restore the counter
3085 ssl->in_ctr = original_in_ctr;
3086
3087 return ret;
3088}
3089
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003090/*
3091 * Return 0 if sequence number is acceptable, -1 otherwise
3092 */
Hanno Becker0183d692019-07-12 08:50:37 +01003093int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003094{
3095 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3096 uint64_t bit;
3097
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003098 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003099 return( 0 );
3100
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003101 if( rec_seqnum > ssl->in_window_top )
3102 return( 0 );
3103
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003104 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003105
3106 if( bit >= 64 )
3107 return( -1 );
3108
3109 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3110 return( -1 );
3111
3112 return( 0 );
3113}
3114
3115/*
3116 * Update replay window on new validated record
3117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003119{
3120 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3121
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003122 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003123 return;
3124
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003125 if( rec_seqnum > ssl->in_window_top )
3126 {
3127 /* Update window_top and the contents of the window */
3128 uint64_t shift = rec_seqnum - ssl->in_window_top;
3129
3130 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003131 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003132 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003133 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003134 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003135 ssl->in_window |= 1;
3136 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003137
3138 ssl->in_window_top = rec_seqnum;
3139 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003140 else
3141 {
3142 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003143 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003144
3145 if( bit < 64 ) /* Always true, but be extra sure */
3146 ssl->in_window |= (uint64_t) 1 << bit;
3147 }
3148}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003150
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003151#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003152/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003153 * Without any SSL context, check if a datagram looks like a ClientHello with
3154 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003155 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003156 *
3157 * - if cookie is valid, return 0
3158 * - if ClientHello looks superficially valid but cookie is not,
3159 * fill obuf and set olen, then
3160 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3161 * - otherwise return a specific error code
3162 */
3163static int ssl_check_dtls_clihlo_cookie(
3164 mbedtls_ssl_cookie_write_t *f_cookie_write,
3165 mbedtls_ssl_cookie_check_t *f_cookie_check,
3166 void *p_cookie,
3167 const unsigned char *cli_id, size_t cli_id_len,
3168 const unsigned char *in, size_t in_len,
3169 unsigned char *obuf, size_t buf_len, size_t *olen )
3170{
3171 size_t sid_len, cookie_len;
3172 unsigned char *p;
3173
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003174 /*
3175 * Structure of ClientHello with record and handshake headers,
3176 * and expected values. We don't need to check a lot, more checks will be
3177 * done when actually parsing the ClientHello - skipping those checks
3178 * avoids code duplication and does not make cookie forging any easier.
3179 *
3180 * 0-0 ContentType type; copied, must be handshake
3181 * 1-2 ProtocolVersion version; copied
3182 * 3-4 uint16 epoch; copied, must be 0
3183 * 5-10 uint48 sequence_number; copied
3184 * 11-12 uint16 length; (ignored)
3185 *
3186 * 13-13 HandshakeType msg_type; (ignored)
3187 * 14-16 uint24 length; (ignored)
3188 * 17-18 uint16 message_seq; copied
3189 * 19-21 uint24 fragment_offset; copied, must be 0
3190 * 22-24 uint24 fragment_length; (ignored)
3191 *
3192 * 25-26 ProtocolVersion client_version; (ignored)
3193 * 27-58 Random random; (ignored)
3194 * 59-xx SessionID session_id; 1 byte len + sid_len content
3195 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3196 * ...
3197 *
3198 * Minimum length is 61 bytes.
3199 */
3200 if( in_len < 61 ||
3201 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3202 in[3] != 0 || in[4] != 0 ||
3203 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3204 {
Hanno Becker90d59dd2021-06-24 11:17:13 +01003205 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003206 }
3207
3208 sid_len = in[59];
3209 if( sid_len > in_len - 61 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003210 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003211
3212 cookie_len = in[60 + sid_len];
3213 if( cookie_len > in_len - 60 )
Hanno Becker90d59dd2021-06-24 11:17:13 +01003214 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003215
3216 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3217 cli_id, cli_id_len ) == 0 )
3218 {
3219 /* Valid cookie */
3220 return( 0 );
3221 }
3222
3223 /*
3224 * If we get here, we've got an invalid cookie, let's prepare HVR.
3225 *
3226 * 0-0 ContentType type; copied
3227 * 1-2 ProtocolVersion version; copied
3228 * 3-4 uint16 epoch; copied
3229 * 5-10 uint48 sequence_number; copied
3230 * 11-12 uint16 length; olen - 13
3231 *
3232 * 13-13 HandshakeType msg_type; hello_verify_request
3233 * 14-16 uint24 length; olen - 25
3234 * 17-18 uint16 message_seq; copied
3235 * 19-21 uint24 fragment_offset; copied
3236 * 22-24 uint24 fragment_length; olen - 25
3237 *
3238 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3239 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3240 *
3241 * Minimum length is 28.
3242 */
3243 if( buf_len < 28 )
3244 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3245
3246 /* Copy most fields and adapt others */
3247 memcpy( obuf, in, 25 );
3248 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3249 obuf[25] = 0xfe;
3250 obuf[26] = 0xff;
3251
3252 /* Generate and write actual cookie */
3253 p = obuf + 28;
3254 if( f_cookie_write( p_cookie,
3255 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3256 {
3257 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3258 }
3259
3260 *olen = p - obuf;
3261
3262 /* Go back and fill length fields */
3263 obuf[27] = (unsigned char)( *olen - 28 );
3264
Joe Subbianifbeb6922021-07-16 14:27:50 +01003265 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3266 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3267 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003268
Joe Subbiani6dd73642021-07-19 11:56:54 +01003269 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003270
3271 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3272}
3273
3274/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003275 * Handle possible client reconnect with the same UDP quadruplet
3276 * (RFC 6347 Section 4.2.8).
3277 *
3278 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3279 * that looks like a ClientHello.
3280 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003281 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003282 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003283 * - if the input looks like a ClientHello with a valid cookie,
3284 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003285 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003286 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003287 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003288 * This function is called (through ssl_check_client_reconnect()) when an
3289 * unexpected record is found in ssl_get_next_record(), which will discard the
3290 * record if we return 0, and bubble up the return value otherwise (this
3291 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3292 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003293 */
3294static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3295{
Janos Follath865b3eb2019-12-16 11:46:15 +00003296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003297 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003298
Hanno Becker2fddd372019-07-10 14:37:41 +01003299 if( ssl->conf->f_cookie_write == NULL ||
3300 ssl->conf->f_cookie_check == NULL )
3301 {
3302 /* If we can't use cookies to verify reachability of the peer,
3303 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3305 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003306 return( 0 );
3307 }
3308
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003309 ret = ssl_check_dtls_clihlo_cookie(
3310 ssl->conf->f_cookie_write,
3311 ssl->conf->f_cookie_check,
3312 ssl->conf->p_cookie,
3313 ssl->cli_id, ssl->cli_id_len,
3314 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003315 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003316
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003317 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3318
3319 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003320 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003321 int send_ret;
3322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3323 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3324 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003325 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003326 * If the error is permanent we'll catch it later,
3327 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003328 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3329 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3330 (void) send_ret;
3331
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003332 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003333 }
3334
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003335 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003336 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003337 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003338 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003339 {
3340 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3341 return( ret );
3342 }
3343
3344 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003345 }
3346
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003347 return( ret );
3348}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003349#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003350
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003351static int ssl_check_record_type( uint8_t record_type )
3352{
3353 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3354 record_type != MBEDTLS_SSL_MSG_ALERT &&
3355 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3356 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3357 {
3358 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3359 }
3360
3361 return( 0 );
3362}
3363
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003364/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003365 * ContentType type;
3366 * ProtocolVersion version;
3367 * uint16 epoch; // DTLS only
3368 * uint48 sequence_number; // DTLS only
3369 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003370 *
3371 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003372 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003373 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3374 *
3375 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003376 * 1. proceed with the record if this function returns 0
3377 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3378 * 3. return CLIENT_RECONNECT if this function return that value
3379 * 4. drop the whole datagram if this function returns anything else.
3380 * Point 2 is needed when the peer is resending, and we have already received
3381 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003382 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003383static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003384 unsigned char *buf,
3385 size_t len,
3386 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003387{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003388 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003389
Hanno Beckere5e7e782019-07-11 12:29:35 +01003390 size_t const rec_hdr_type_offset = 0;
3391 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003392
Hanno Beckere5e7e782019-07-11 12:29:35 +01003393 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3394 rec_hdr_type_len;
3395 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003396
Hanno Beckere5e7e782019-07-11 12:29:35 +01003397 size_t const rec_hdr_ctr_len = 8;
3398#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003399 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3401 rec_hdr_version_len;
3402
Hanno Beckera0e20d02019-05-15 14:03:01 +01003403#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3405 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003406 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3408#endif /* MBEDTLS_SSL_PROTO_DTLS */
3409
3410 size_t rec_hdr_len_offset; /* To be determined */
3411 size_t const rec_hdr_len_len = 2;
3412
3413 /*
3414 * Check minimum lengths for record header.
3415 */
3416
3417#if defined(MBEDTLS_SSL_PROTO_DTLS)
3418 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3419 {
3420 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3421 }
3422 else
3423#endif /* MBEDTLS_SSL_PROTO_DTLS */
3424 {
3425 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3426 }
3427
3428 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3429 {
3430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3431 (unsigned) len,
3432 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3433 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3434 }
3435
3436 /*
3437 * Parse and validate record content type
3438 */
3439
3440 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003441
3442 /* Check record content type */
3443#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3444 rec->cid_len = 0;
3445
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003446 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003447 ssl->conf->cid_len != 0 &&
3448 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003449 {
3450 /* Shift pointers to account for record header including CID
3451 * struct {
3452 * ContentType special_type = tls12_cid;
3453 * ProtocolVersion version;
3454 * uint16 epoch;
3455 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003456 * opaque cid[cid_length]; // Additional field compared to
3457 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003458 * uint16 length;
3459 * opaque enc_content[DTLSCiphertext.length];
3460 * } DTLSCiphertext;
3461 */
3462
3463 /* So far, we only support static CID lengths
3464 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003465 rec_hdr_cid_len = ssl->conf->cid_len;
3466 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003467
Hanno Beckere5e7e782019-07-11 12:29:35 +01003468 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003469 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3471 (unsigned) len,
3472 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003473 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003474 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003475
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003476 /* configured CID len is guaranteed at most 255, see
3477 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3478 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003479 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003480 }
3481 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003482#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003483 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003484 if( ssl_check_record_type( rec->type ) )
3485 {
Hanno Becker54229812019-07-12 14:40:00 +01003486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3487 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003488 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3489 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003490 }
3491
Hanno Beckere5e7e782019-07-11 12:29:35 +01003492 /*
3493 * Parse and validate record version
3494 */
3495
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003496 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3497 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003498 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3499 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003500 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003501
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003502 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3505 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003506 }
3507
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003508 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3511 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003512 }
3513
Hanno Beckere5e7e782019-07-11 12:29:35 +01003514 /*
3515 * Parse/Copy record sequence number.
3516 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003517
Hanno Beckere5e7e782019-07-11 12:29:35 +01003518#if defined(MBEDTLS_SSL_PROTO_DTLS)
3519 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003520 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 /* Copy explicit record sequence number from input buffer. */
3522 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3523 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003524 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003525 else
3526#endif /* MBEDTLS_SSL_PROTO_DTLS */
3527 {
3528 /* Copy implicit record sequence number from SSL context structure. */
3529 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3530 }
Paul Bakker40e46942009-01-03 21:51:57 +00003531
Hanno Beckere5e7e782019-07-11 12:29:35 +01003532 /*
3533 * Parse record length.
3534 */
3535
Hanno Beckere5e7e782019-07-11 12:29:35 +01003536 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003537 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3538 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003539 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003540
Paul Elliott9f352112020-12-09 14:55:45 +00003541 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003542 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003543 rec->type,
3544 major_ver, minor_ver, rec->data_len ) );
3545
3546 rec->buf = buf;
3547 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003548
Hanno Beckerd417cc92019-07-26 08:20:27 +01003549 if( rec->data_len == 0 )
3550 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003551
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003552 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003553 * DTLS-related tests.
3554 * Check epoch before checking length constraint because
3555 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3556 * message gets duplicated before the corresponding Finished message,
3557 * the second ChangeCipherSpec should be discarded because it belongs
3558 * to an old epoch, but not because its length is shorter than
3559 * the minimum record length for packets using the new record transform.
3560 * Note that these two kinds of failures are handled differently,
3561 * as an unexpected record is silently skipped but an invalid
3562 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003563 */
3564#if defined(MBEDTLS_SSL_PROTO_DTLS)
3565 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3566 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003568
Hanno Becker955a5c92019-07-10 17:12:07 +01003569 /* Check that the datagram is large enough to contain a record
3570 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003572 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3574 (unsigned) len,
3575 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003576 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3577 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003578
Hanno Becker37cfe732019-07-10 17:20:01 +01003579 /* Records from other, non-matching epochs are silently discarded.
3580 * (The case of same-port Client reconnects must be considered in
3581 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003582 if( rec_epoch != ssl->in_epoch )
3583 {
3584 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003585 "expected %u, received %lu",
3586 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003587
Hanno Becker552f7472019-07-19 10:59:12 +01003588 /* Records from the next epoch are considered for buffering
3589 * (concretely: early Finished messages). */
3590 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003591 {
Hanno Becker552f7472019-07-19 10:59:12 +01003592 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3593 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003594 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003595
Hanno Becker2fddd372019-07-10 14:37:41 +01003596 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003597 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003598#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003599 /* For records from the correct epoch, check whether their
3600 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003601 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3602 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003603 {
3604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3605 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3606 }
3607#endif
3608 }
3609#endif /* MBEDTLS_SSL_PROTO_DTLS */
3610
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003611 return( 0 );
3612}
Paul Bakker5121ce52009-01-03 21:22:43 +00003613
Paul Bakker5121ce52009-01-03 21:22:43 +00003614
Hanno Becker2fddd372019-07-10 14:37:41 +01003615#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3616static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3617{
3618 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3619
3620 /*
3621 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3622 * access the first byte of record content (handshake type), as we
3623 * have an active transform (possibly iv_len != 0), so use the
3624 * fact that the record header len is 13 instead.
3625 */
3626 if( rec_epoch == 0 &&
3627 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3628 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3629 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3630 ssl->in_left > 13 &&
3631 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3632 {
3633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3634 "from the same port" ) );
3635 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003636 }
3637
3638 return( 0 );
3639}
Hanno Becker2fddd372019-07-10 14:37:41 +01003640#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003641
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003642/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003643 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003644 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003645static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3646 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003647{
3648 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003650 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003651 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003652
Ronald Cron7e38cba2021-11-24 12:43:39 +01003653 /*
3654 * In TLS 1.3, always treat ChangeCipherSpec records
3655 * as unencrypted. The only thing we do with them is
3656 * check the length and content and ignore them.
3657 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003658#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01003659 if( ssl->transform_in != NULL &&
3660 ssl->transform_in->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
3661 {
3662 if( rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
3663 done = 1;
3664 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003665#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003666
Paul Bakker48916f92012-09-16 19:57:18 +00003667 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003668 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003669 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003670
Hanno Beckera18d1322018-01-03 14:27:32 +00003671 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003672 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003673 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003675
Hanno Beckera0e20d02019-05-15 14:03:01 +01003676#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003677 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3678 ssl->conf->ignore_unexpected_cid
3679 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3680 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003681 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003682 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003683 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003684#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003685
Paul Bakker5121ce52009-01-03 21:22:43 +00003686 return( ret );
3687 }
3688
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003689 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003690 {
3691 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003692 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003693 }
3694
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003695 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003696 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003697
Hanno Beckera0e20d02019-05-15 14:03:01 +01003698#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003699 /* We have already checked the record content type
3700 * in ssl_parse_record_header(), failing or silently
3701 * dropping the record in the case of an unknown type.
3702 *
3703 * Since with the use of CIDs, the record content type
3704 * might change during decryption, re-check the record
3705 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003706 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003707 {
3708 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3709 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3710 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003711#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003712
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003713 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003714 {
3715#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3716 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003717 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003718 {
3719 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3720 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3721 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3722 }
3723#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3724
3725 ssl->nb_zero++;
3726
3727 /*
3728 * Three or more empty messages may be a DoS attack
3729 * (excessive CPU consumption).
3730 */
3731 if( ssl->nb_zero > 3 )
3732 {
3733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003734 "messages, possible DoS attack" ) );
3735 /* Treat the records as if they were not properly authenticated,
3736 * thereby failing the connection if we see more than allowed
3737 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003738 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3739 }
3740 }
3741 else
3742 ssl->nb_zero = 0;
3743
3744#if defined(MBEDTLS_SSL_PROTO_DTLS)
3745 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3746 {
3747 ; /* in_ctr read from peer, not maintained internally */
3748 }
3749 else
3750#endif
3751 {
3752 unsigned i;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003753 for( i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3754 i > mbedtls_ssl_ep_len( ssl ); i-- )
3755 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003756 if( ++ssl->in_ctr[i - 1] != 0 )
3757 break;
Jerry Yuae0b2e22021-10-08 15:21:19 +08003758 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003759
3760 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003761 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003762 {
3763 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3764 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3765 }
3766 }
3767
Paul Bakker5121ce52009-01-03 21:22:43 +00003768 }
3769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003771 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003774 }
3775#endif
3776
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003777 /* Check actual (decrypted) record content length against
3778 * configured maximum. */
3779 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3780 {
3781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3782 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3783 }
3784
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003785 return( 0 );
3786}
3787
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003788/*
3789 * Read a record.
3790 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003791 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3792 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3793 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003794 */
Hanno Becker1097b342018-08-15 14:09:41 +01003795
3796/* Helper functions for mbedtls_ssl_read_record(). */
3797static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003798static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3799static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003800
Hanno Becker327c93b2018-08-15 13:56:18 +01003801int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003802 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003803{
Janos Follath865b3eb2019-12-16 11:46:15 +00003804 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003807
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003808 if( ssl->keep_current_message == 0 )
3809 {
3810 do {
Simon Butcher99000142016-10-13 17:21:01 +01003811
Hanno Becker26994592018-08-15 14:14:59 +01003812 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003813 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003814 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003815
Hanno Beckere74d5562018-08-15 14:26:08 +01003816 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003817 {
Hanno Becker40f50842018-08-15 14:48:01 +01003818#if defined(MBEDTLS_SSL_PROTO_DTLS)
3819 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003820
Hanno Becker40f50842018-08-15 14:48:01 +01003821 /* We only check for buffered messages if the
3822 * current datagram is fully consumed. */
3823 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003824 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003825 {
Hanno Becker40f50842018-08-15 14:48:01 +01003826 if( ssl_load_buffered_message( ssl ) == 0 )
3827 have_buffered = 1;
3828 }
3829
3830 if( have_buffered == 0 )
3831#endif /* MBEDTLS_SSL_PROTO_DTLS */
3832 {
3833 ret = ssl_get_next_record( ssl );
3834 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3835 continue;
3836
3837 if( ret != 0 )
3838 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003839 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003840 return( ret );
3841 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003842 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003843 }
3844
3845 ret = mbedtls_ssl_handle_message_type( ssl );
3846
Hanno Becker40f50842018-08-15 14:48:01 +01003847#if defined(MBEDTLS_SSL_PROTO_DTLS)
3848 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3849 {
3850 /* Buffer future message */
3851 ret = ssl_buffer_message( ssl );
3852 if( ret != 0 )
3853 return( ret );
3854
3855 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3856 }
3857#endif /* MBEDTLS_SSL_PROTO_DTLS */
3858
Hanno Becker90333da2017-10-10 11:27:13 +01003859 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3860 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003861
3862 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003863 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003864 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003865 return( ret );
3866 }
3867
Hanno Becker327c93b2018-08-15 13:56:18 +01003868 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003869 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003870 {
3871 mbedtls_ssl_update_handshake_status( ssl );
3872 }
Simon Butcher99000142016-10-13 17:21:01 +01003873 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003874 else
Simon Butcher99000142016-10-13 17:21:01 +01003875 {
Hanno Becker02f59072018-08-15 14:00:24 +01003876 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003877 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003878 }
3879
3880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3881
3882 return( 0 );
3883}
3884
Hanno Becker40f50842018-08-15 14:48:01 +01003885#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003886static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003887{
Hanno Becker40f50842018-08-15 14:48:01 +01003888 if( ssl->in_left > ssl->next_record_offset )
3889 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003890
Hanno Becker40f50842018-08-15 14:48:01 +01003891 return( 0 );
3892}
3893
3894static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3895{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003896 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003897 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003898 int ret = 0;
3899
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003900 if( hs == NULL )
3901 return( -1 );
3902
Hanno Beckere00ae372018-08-20 09:39:42 +01003903 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3904
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003905 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3906 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3907 {
3908 /* Check if we have seen a ChangeCipherSpec before.
3909 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003910 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003911 {
3912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3913 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003914 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003915 }
3916
Hanno Becker39b8bc92018-08-28 17:17:13 +01003917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003918 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3919 ssl->in_msglen = 1;
3920 ssl->in_msg[0] = 1;
3921
3922 /* As long as they are equal, the exact value doesn't matter. */
3923 ssl->in_left = 0;
3924 ssl->next_record_offset = 0;
3925
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003926 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003927 goto exit;
3928 }
Hanno Becker37f95322018-08-16 13:55:32 +01003929
Hanno Beckerb8f50142018-08-28 10:01:34 +01003930#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003931 /* Debug only */
3932 {
3933 unsigned offset;
3934 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3935 {
3936 hs_buf = &hs->buffering.hs[offset];
3937 if( hs_buf->is_valid == 1 )
3938 {
3939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3940 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003941 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003942 }
3943 }
3944 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003945#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003946
3947 /* Check if we have buffered and/or fully reassembled the
3948 * next handshake message. */
3949 hs_buf = &hs->buffering.hs[0];
3950 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3951 {
3952 /* Synthesize a record containing the buffered HS message. */
3953 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3954 ( hs_buf->data[2] << 8 ) |
3955 hs_buf->data[3];
3956
3957 /* Double-check that we haven't accidentally buffered
3958 * a message that doesn't fit into the input buffer. */
3959 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3960 {
3961 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3962 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3963 }
3964
3965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3966 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3967 hs_buf->data, msg_len + 12 );
3968
3969 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3970 ssl->in_hslen = msg_len + 12;
3971 ssl->in_msglen = msg_len + 12;
3972 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3973
3974 ret = 0;
3975 goto exit;
3976 }
3977 else
3978 {
3979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3980 hs->in_msg_seq ) );
3981 }
3982
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003983 ret = -1;
3984
3985exit:
3986
3987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3988 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003989}
3990
Hanno Beckera02b0b42018-08-21 17:20:27 +01003991static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3992 size_t desired )
3993{
3994 int offset;
3995 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3997 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003998
Hanno Becker01315ea2018-08-21 17:22:17 +01003999 /* Get rid of future records epoch first, if such exist. */
4000 ssl_free_buffered_record( ssl );
4001
4002 /* Check if we have enough space available now. */
4003 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4004 hs->buffering.total_bytes_buffered ) )
4005 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004006 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004007 return( 0 );
4008 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004009
Hanno Becker4f432ad2018-08-28 10:02:32 +01004010 /* We don't have enough space to buffer the next expected handshake
4011 * message. Remove buffers used for future messages to gain space,
4012 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004013 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4014 offset >= 0; offset-- )
4015 {
4016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4017 offset ) );
4018
Hanno Beckerb309b922018-08-23 13:18:05 +01004019 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004020
4021 /* Check if we have enough space available now. */
4022 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4023 hs->buffering.total_bytes_buffered ) )
4024 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004026 return( 0 );
4027 }
4028 }
4029
4030 return( -1 );
4031}
4032
Hanno Becker40f50842018-08-15 14:48:01 +01004033static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4034{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004035 int ret = 0;
4036 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4037
4038 if( hs == NULL )
4039 return( 0 );
4040
4041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4042
4043 switch( ssl->in_msgtype )
4044 {
4045 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004047
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004048 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004049 break;
4050
4051 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004052 {
4053 unsigned recv_msg_seq_offset;
4054 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4055 mbedtls_ssl_hs_buffer *hs_buf;
4056 size_t msg_len = ssl->in_hslen - 12;
4057
4058 /* We should never receive an old handshake
4059 * message - double-check nonetheless. */
4060 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4061 {
4062 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4063 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4064 }
4065
4066 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4067 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4068 {
4069 /* Silently ignore -- message too far in the future */
4070 MBEDTLS_SSL_DEBUG_MSG( 2,
4071 ( "Ignore future HS message with sequence number %u, "
4072 "buffering window %u - %u",
4073 recv_msg_seq, ssl->handshake->in_msg_seq,
4074 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4075
4076 goto exit;
4077 }
4078
4079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4080 recv_msg_seq, recv_msg_seq_offset ) );
4081
4082 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4083
4084 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004085 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004086 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004087 size_t reassembly_buf_sz;
4088
Hanno Becker37f95322018-08-16 13:55:32 +01004089 hs_buf->is_fragmented =
4090 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4091
4092 /* We copy the message back into the input buffer
4093 * after reassembly, so check that it's not too large.
4094 * This is an implementation-specific limitation
4095 * and not one from the standard, hence it is not
4096 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004097 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004098 {
4099 /* Ignore message */
4100 goto exit;
4101 }
4102
Hanno Beckere0b150f2018-08-21 15:51:03 +01004103 /* Check if we have enough space to buffer the message. */
4104 if( hs->buffering.total_bytes_buffered >
4105 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4106 {
4107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4109 }
4110
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004111 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4112 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004113
4114 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4115 hs->buffering.total_bytes_buffered ) )
4116 {
4117 if( recv_msg_seq_offset > 0 )
4118 {
4119 /* If we can't buffer a future message because
4120 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004121 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4122 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4123 " (already %" MBEDTLS_PRINTF_SIZET
4124 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004125 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004126 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004127 goto exit;
4128 }
Hanno Beckere1801392018-08-21 16:51:05 +01004129 else
4130 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4132 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4133 " (already %" MBEDTLS_PRINTF_SIZET
4134 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004135 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004136 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004137 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004138
Hanno Beckera02b0b42018-08-21 17:20:27 +01004139 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004140 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4142 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4143 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4144 " (already %" MBEDTLS_PRINTF_SIZET
4145 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004146 msg_len,
4147 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004148 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004149 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004150 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4151 goto exit;
4152 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004153 }
4154
Paul Elliottd48d5c62021-01-07 14:47:05 +00004155 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004156 msg_len ) );
4157
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004158 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4159 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004160 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004161 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004162 goto exit;
4163 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004164 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004165
4166 /* Prepare final header: copy msg_type, length and message_seq,
4167 * then add standardised fragment_offset and fragment_length */
4168 memcpy( hs_buf->data, ssl->in_msg, 6 );
4169 memset( hs_buf->data + 6, 0, 3 );
4170 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4171
4172 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004173
4174 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004175 }
4176 else
4177 {
4178 /* Make sure msg_type and length are consistent */
4179 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4180 {
4181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4182 /* Ignore */
4183 goto exit;
4184 }
4185 }
4186
Hanno Becker4422bbb2018-08-20 09:40:19 +01004187 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004188 {
4189 size_t frag_len, frag_off;
4190 unsigned char * const msg = hs_buf->data + 12;
4191
4192 /*
4193 * Check and copy current fragment
4194 */
4195
4196 /* Validation of header fields already done in
4197 * mbedtls_ssl_prepare_handshake_record(). */
4198 frag_off = ssl_get_hs_frag_off( ssl );
4199 frag_len = ssl_get_hs_frag_len( ssl );
4200
Paul Elliottd48d5c62021-01-07 14:47:05 +00004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4202 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004203 frag_off, frag_len ) );
4204 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4205
4206 if( hs_buf->is_fragmented )
4207 {
4208 unsigned char * const bitmask = msg + msg_len;
4209 ssl_bitmask_set( bitmask, frag_off, frag_len );
4210 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4211 msg_len ) == 0 );
4212 }
4213 else
4214 {
4215 hs_buf->is_complete = 1;
4216 }
4217
4218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4219 hs_buf->is_complete ? "" : "not yet " ) );
4220 }
4221
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004222 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004223 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224
4225 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004226 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004227 break;
4228 }
4229
4230exit:
4231
4232 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4233 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004234}
4235#endif /* MBEDTLS_SSL_PROTO_DTLS */
4236
Hanno Becker1097b342018-08-15 14:09:41 +01004237static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004238{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004239 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004240 * Consume last content-layer message and potentially
4241 * update in_msglen which keeps track of the contents'
4242 * consumption state.
4243 *
4244 * (1) Handshake messages:
4245 * Remove last handshake message, move content
4246 * and adapt in_msglen.
4247 *
4248 * (2) Alert messages:
4249 * Consume whole record content, in_msglen = 0.
4250 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004251 * (3) Change cipher spec:
4252 * Consume whole record content, in_msglen = 0.
4253 *
4254 * (4) Application data:
4255 * Don't do anything - the record layer provides
4256 * the application data as a stream transport
4257 * and consumes through mbedtls_ssl_read only.
4258 *
4259 */
4260
4261 /* Case (1): Handshake messages */
4262 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004263 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004264 /* Hard assertion to be sure that no application data
4265 * is in flight, as corrupting ssl->in_msglen during
4266 * ssl->in_offt != NULL is fatal. */
4267 if( ssl->in_offt != NULL )
4268 {
4269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4270 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4271 }
4272
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004273 /*
4274 * Get next Handshake message in the current record
4275 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004276
Hanno Becker4a810fb2017-05-24 16:27:30 +01004277 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004278 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004279 * current handshake content: If DTLS handshake
4280 * fragmentation is used, that's the fragment
4281 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004282 * size here is faulty and should be changed at
4283 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004284 * (2) While it doesn't seem to cause problems, one
4285 * has to be very careful not to assume that in_hslen
4286 * is always <= in_msglen in a sensible communication.
4287 * Again, it's wrong for DTLS handshake fragmentation.
4288 * The following check is therefore mandatory, and
4289 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004290 * Additionally, ssl->in_hslen might be arbitrarily out of
4291 * bounds after handling a DTLS message with an unexpected
4292 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004293 */
4294 if( ssl->in_hslen < ssl->in_msglen )
4295 {
4296 ssl->in_msglen -= ssl->in_hslen;
4297 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4298 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004299
Hanno Becker4a810fb2017-05-24 16:27:30 +01004300 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4301 ssl->in_msg, ssl->in_msglen );
4302 }
4303 else
4304 {
4305 ssl->in_msglen = 0;
4306 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004307
Hanno Becker4a810fb2017-05-24 16:27:30 +01004308 ssl->in_hslen = 0;
4309 }
4310 /* Case (4): Application data */
4311 else if( ssl->in_offt != NULL )
4312 {
4313 return( 0 );
4314 }
4315 /* Everything else (CCS & Alerts) */
4316 else
4317 {
4318 ssl->in_msglen = 0;
4319 }
4320
Hanno Becker1097b342018-08-15 14:09:41 +01004321 return( 0 );
4322}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004323
Hanno Beckere74d5562018-08-15 14:26:08 +01004324static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4325{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004326 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004327 return( 1 );
4328
4329 return( 0 );
4330}
4331
Hanno Becker5f066e72018-08-16 14:56:31 +01004332#if defined(MBEDTLS_SSL_PROTO_DTLS)
4333
4334static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4335{
4336 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4337 if( hs == NULL )
4338 return;
4339
Hanno Becker01315ea2018-08-21 17:22:17 +01004340 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004341 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004342 hs->buffering.total_bytes_buffered -=
4343 hs->buffering.future_record.len;
4344
4345 mbedtls_free( hs->buffering.future_record.data );
4346 hs->buffering.future_record.data = NULL;
4347 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004348}
4349
4350static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4351{
4352 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4353 unsigned char * rec;
4354 size_t rec_len;
4355 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004356#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4357 size_t in_buf_len = ssl->in_buf_len;
4358#else
4359 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4360#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004361 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4362 return( 0 );
4363
4364 if( hs == NULL )
4365 return( 0 );
4366
Hanno Becker5f066e72018-08-16 14:56:31 +01004367 rec = hs->buffering.future_record.data;
4368 rec_len = hs->buffering.future_record.len;
4369 rec_epoch = hs->buffering.future_record.epoch;
4370
4371 if( rec == NULL )
4372 return( 0 );
4373
Hanno Becker4cb782d2018-08-20 11:19:05 +01004374 /* Only consider loading future records if the
4375 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004376 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004377 return( 0 );
4378
Hanno Becker5f066e72018-08-16 14:56:31 +01004379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4380
4381 if( rec_epoch != ssl->in_epoch )
4382 {
4383 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4384 goto exit;
4385 }
4386
4387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4388
4389 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004390 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004391 {
4392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4393 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4394 }
4395
4396 memcpy( ssl->in_hdr, rec, rec_len );
4397 ssl->in_left = rec_len;
4398 ssl->next_record_offset = 0;
4399
4400 ssl_free_buffered_record( ssl );
4401
4402exit:
4403 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4404 return( 0 );
4405}
4406
Hanno Becker519f15d2019-07-11 12:43:20 +01004407static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4408 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004409{
4410 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004411
4412 /* Don't buffer future records outside handshakes. */
4413 if( hs == NULL )
4414 return( 0 );
4415
4416 /* Only buffer handshake records (we are only interested
4417 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004418 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004419 return( 0 );
4420
4421 /* Don't buffer more than one future epoch record. */
4422 if( hs->buffering.future_record.data != NULL )
4423 return( 0 );
4424
Hanno Becker01315ea2018-08-21 17:22:17 +01004425 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004426 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004427 hs->buffering.total_bytes_buffered ) )
4428 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004429 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4430 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4431 " (already %" MBEDTLS_PRINTF_SIZET
4432 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004433 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004434 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004435 return( 0 );
4436 }
4437
Hanno Becker5f066e72018-08-16 14:56:31 +01004438 /* Buffer record */
4439 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004440 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004441 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004442
4443 /* ssl_parse_record_header() only considers records
4444 * of the next epoch as candidates for buffering. */
4445 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004446 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004447
4448 hs->buffering.future_record.data =
4449 mbedtls_calloc( 1, hs->buffering.future_record.len );
4450 if( hs->buffering.future_record.data == NULL )
4451 {
4452 /* If we run out of RAM trying to buffer a
4453 * record from the next epoch, just ignore. */
4454 return( 0 );
4455 }
4456
Hanno Becker519f15d2019-07-11 12:43:20 +01004457 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004458
Hanno Becker519f15d2019-07-11 12:43:20 +01004459 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004460 return( 0 );
4461}
4462
4463#endif /* MBEDTLS_SSL_PROTO_DTLS */
4464
Hanno Beckere74d5562018-08-15 14:26:08 +01004465static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004466{
Janos Follath865b3eb2019-12-16 11:46:15 +00004467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004468 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004469
Hanno Becker5f066e72018-08-16 14:56:31 +01004470#if defined(MBEDTLS_SSL_PROTO_DTLS)
4471 /* We might have buffered a future record; if so,
4472 * and if the epoch matches now, load it.
4473 * On success, this call will set ssl->in_left to
4474 * the length of the buffered record, so that
4475 * the calls to ssl_fetch_input() below will
4476 * essentially be no-ops. */
4477 ret = ssl_load_buffered_record( ssl );
4478 if( ret != 0 )
4479 return( ret );
4480#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004481
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004482 /* Ensure that we have enough space available for the default form
4483 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4484 * with no space for CIDs counted in). */
4485 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4486 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004487 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004488 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004489 return( ret );
4490 }
4491
Hanno Beckere5e7e782019-07-11 12:29:35 +01004492 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4493 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004494 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004496 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004497 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004498 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4499 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004500 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004501 if( ret != 0 )
4502 return( ret );
4503
4504 /* Fall through to handling of unexpected records */
4505 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4506 }
4507
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004508 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4509 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004510#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004511 /* Reset in pointers to default state for TLS/DTLS records,
4512 * assuming no CID and no offset between record content and
4513 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004514 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004515
Hanno Becker7ae20e02019-07-12 08:33:49 +01004516 /* Setup internal message pointers from record structure. */
4517 ssl->in_msgtype = rec.type;
4518#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4519 ssl->in_len = ssl->in_cid + rec.cid_len;
4520#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4521 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4522 ssl->in_msglen = rec.data_len;
4523
Hanno Becker2fddd372019-07-10 14:37:41 +01004524 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004525 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004526 if( ret != 0 )
4527 return( ret );
4528#endif
4529
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004530 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004531 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004532
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4534 "(header)" ) );
4535 }
4536 else
4537 {
4538 /* Skip invalid record and the rest of the datagram */
4539 ssl->next_record_offset = 0;
4540 ssl->in_left = 0;
4541
4542 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4543 "(header)" ) );
4544 }
4545
4546 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004547 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004548 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004549 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004550#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004551 {
4552 return( ret );
4553 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004554 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004556#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004557 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004558 {
Hanno Beckera8814792019-07-10 15:01:45 +01004559 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004560 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004561 if( ssl->next_record_offset < ssl->in_left )
4562 {
4563 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4564 }
4565 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004566 else
4567#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004568 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004569 /*
4570 * Fetch record contents from underlying transport.
4571 */
Hanno Beckera3175662019-07-11 12:50:29 +01004572 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004573 if( ret != 0 )
4574 {
4575 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4576 return( ret );
4577 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004578
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004579 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004580 }
4581
4582 /*
4583 * Decrypt record contents.
4584 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004585
Hanno Beckerfdf66042019-07-11 13:07:45 +01004586 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004589 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004590 {
4591 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004592 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004593 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004594 /* Except when waiting for Finished as a bad mac here
4595 * probably means something went wrong in the handshake
4596 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4597 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4598 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4599 {
4600#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4601 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4602 {
4603 mbedtls_ssl_send_alert_message( ssl,
4604 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4605 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4606 }
4607#endif
4608 return( ret );
4609 }
4610
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004611 if( ssl->conf->badmac_limit != 0 &&
4612 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4615 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004616 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004617
Hanno Becker4a810fb2017-05-24 16:27:30 +01004618 /* As above, invalid records cause
4619 * dismissal of the whole datagram. */
4620
4621 ssl->next_record_offset = 0;
4622 ssl->in_left = 0;
4623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004625 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004626 }
4627
4628 return( ret );
4629 }
4630 else
4631#endif
4632 {
4633 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4635 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 mbedtls_ssl_send_alert_message( ssl,
4638 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4639 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004640 }
4641#endif
4642 return( ret );
4643 }
4644 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004645
Hanno Becker44d89b22019-07-12 09:40:44 +01004646
4647 /* Reset in pointers to default state for TLS/DTLS records,
4648 * assuming no CID and no offset between record content and
4649 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004650 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004651#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4652 ssl->in_len = ssl->in_cid + rec.cid_len;
4653#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004654 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004655
Hanno Becker8685c822019-07-12 09:37:30 +01004656 /* The record content type may change during decryption,
4657 * so re-read it. */
4658 ssl->in_msgtype = rec.type;
4659 /* Also update the input buffer, because unfortunately
4660 * the server-side ssl_parse_client_hello() reparses the
4661 * record header when receiving a ClientHello initiating
4662 * a renegotiation. */
4663 ssl->in_hdr[0] = rec.type;
4664 ssl->in_msg = rec.buf + rec.data_offset;
4665 ssl->in_msglen = rec.data_len;
Joe Subbiani6dd73642021-07-19 11:56:54 +01004666 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004667
Simon Butcher99000142016-10-13 17:21:01 +01004668 return( 0 );
4669}
4670
4671int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4672{
Janos Follath865b3eb2019-12-16 11:46:15 +00004673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004674
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004675 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004676 * Handle particular types of records
4677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004679 {
Simon Butcher99000142016-10-13 17:21:01 +01004680 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4681 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004682 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004683 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004684 }
4685
Hanno Beckere678eaa2018-08-21 14:57:46 +01004686 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004687 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004688 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004689 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004691 ssl->in_msglen ) );
4692 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004693 }
4694
Hanno Beckere678eaa2018-08-21 14:57:46 +01004695 if( ssl->in_msg[0] != 1 )
4696 {
4697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4698 ssl->in_msg[0] ) );
4699 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4700 }
4701
4702#if defined(MBEDTLS_SSL_PROTO_DTLS)
4703 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4704 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4705 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4706 {
4707 if( ssl->handshake == NULL )
4708 {
4709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4710 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4711 }
4712
4713 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4714 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4715 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004716#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004717
Ronald Cron6f135e12021-12-08 16:57:54 +01004718#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron7e38cba2021-11-24 12:43:39 +01004719 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
4720 {
4721#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
4722 MBEDTLS_SSL_DEBUG_MSG( 1,
4723 ( "Ignore ChangeCipherSpec in TLS 1.3 compatibility mode" ) );
4724 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
4725#else
4726 MBEDTLS_SSL_DEBUG_MSG( 1,
4727 ( "ChangeCipherSpec invalid in TLS 1.3 without compatibility mode" ) );
4728 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4729#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4730 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004731#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004732 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004735 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004736 if( ssl->in_msglen != 2 )
4737 {
4738 /* Note: Standard allows for more than one 2 byte alert
4739 to be packed in a single message, but Mbed TLS doesn't
4740 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004742 ssl->in_msglen ) );
4743 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4744 }
4745
Paul Elliott9f352112020-12-09 14:55:45 +00004746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004747 ssl->in_msg[0], ssl->in_msg[1] ) );
4748
4749 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004750 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004751 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004753 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004755 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004756 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004757 }
4758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4760 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004761 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4763 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004764 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004765
4766#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4767 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4768 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4769 {
Mateusz Starzykf5c53512021-04-15 13:28:52 +02004770 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004771 /* Will be handled when trying to parse ServerHello */
4772 return( 0 );
4773 }
4774#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004775 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004776 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004777 }
4778
Hanno Beckerc76c6192017-06-06 10:03:17 +01004779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004781 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004782 /* Drop unexpected ApplicationData records,
4783 * except at the beginning of renegotiations */
4784 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4785 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4786#if defined(MBEDTLS_SSL_RENEGOTIATION)
4787 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4788 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004789#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004790 )
4791 {
4792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4793 return( MBEDTLS_ERR_SSL_NON_FATAL );
4794 }
4795
4796 if( ssl->handshake != NULL &&
4797 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4798 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004799 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004800 }
4801 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004802#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004803
Paul Bakker5121ce52009-01-03 21:22:43 +00004804 return( 0 );
4805}
4806
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004808{
irwir6c0da642019-09-26 21:07:41 +03004809 return( mbedtls_ssl_send_alert_message( ssl,
4810 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4811 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004812}
4813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004815 unsigned char level,
4816 unsigned char message )
4817{
Janos Follath865b3eb2019-12-16 11:46:15 +00004818 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004819
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004820 if( ssl == NULL || ssl->conf == NULL )
4821 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004824 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004826 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004827 ssl->out_msglen = 2;
4828 ssl->out_msg[0] = level;
4829 ssl->out_msg[1] = message;
4830
Hanno Becker67bc7c32018-08-06 11:33:50 +01004831 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004832 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004833 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004834 return( ret );
4835 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004837
4838 return( 0 );
4839}
4840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004841int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004842{
Janos Follath865b3eb2019-12-16 11:46:15 +00004843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004848 ssl->out_msglen = 1;
4849 ssl->out_msg[0] = 1;
4850
Paul Bakker5121ce52009-01-03 21:22:43 +00004851 ssl->state++;
4852
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004853 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004854 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004855 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004856 return( ret );
4857 }
4858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004860
4861 return( 0 );
4862}
4863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004865{
Janos Follath865b3eb2019-12-16 11:46:15 +00004866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004869
Hanno Becker327c93b2018-08-15 13:56:18 +01004870 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004873 return( ret );
4874 }
4875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004876 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004877 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004878 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004879 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4880 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004881 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004882 }
4883
Hanno Beckere678eaa2018-08-21 14:57:46 +01004884 /* CCS records are only accepted if they have length 1 and content '1',
4885 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004886
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004887 /*
4888 * Switch to our negotiated transform and session parameters for inbound
4889 * data.
4890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004892 ssl->transform_in = ssl->transform_negotiate;
4893 ssl->session_in = ssl->session_negotiate;
4894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004896 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004897 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004898#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004899 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004900#endif
4901
4902 /* Increment epoch */
4903 if( ++ssl->in_epoch == 0 )
4904 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004906 /* This is highly unlikely to happen for legitimate reasons, so
4907 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004908 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004909 }
4910 }
4911 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004912#endif /* MBEDTLS_SSL_PROTO_DTLS */
Jerry Yufd320e92021-10-08 21:52:41 +08004913 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004914
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004915 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004916
Paul Bakker5121ce52009-01-03 21:22:43 +00004917 ssl->state++;
4918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004919 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004920
4921 return( 0 );
4922}
4923
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004924/* Once ssl->out_hdr as the address of the beginning of the
4925 * next outgoing record is set, deduce the other pointers.
4926 *
4927 * Note: For TLS, we save the implicit record sequence number
4928 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4929 * and the caller has to make sure there's space for this.
4930 */
4931
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004932static size_t ssl_transform_get_explicit_iv_len(
4933 mbedtls_ssl_transform const *transform )
4934{
TRodziewiczef73f012021-05-13 14:53:36 +02004935 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_3 )
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004936 return( 0 );
4937
4938 return( transform->ivlen - transform->fixed_ivlen );
4939}
4940
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004941void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4942 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004943{
4944#if defined(MBEDTLS_SSL_PROTO_DTLS)
4945 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4946 {
4947 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004948#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004949 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004950 ssl->out_len = ssl->out_cid;
4951 if( transform != NULL )
4952 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004953#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004954 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004955#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004956 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004957 }
4958 else
4959#endif
4960 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004961 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004962#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004963 ssl->out_cid = ssl->out_len;
4964#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004965 ssl->out_iv = ssl->out_hdr + 5;
4966 }
4967
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004968 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004969 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004970 if( transform != NULL )
4971 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004972}
4973
4974/* Once ssl->in_hdr as the address of the beginning of the
4975 * next incoming record is set, deduce the other pointers.
4976 *
4977 * Note: For TLS, we save the implicit record sequence number
4978 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4979 * and the caller has to make sure there's space for this.
4980 */
4981
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004982void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004983{
Hanno Becker79594fd2019-05-08 09:38:41 +01004984 /* This function sets the pointers to match the case
4985 * of unprotected TLS/DTLS records, with both ssl->in_iv
4986 * and ssl->in_msg pointing to the beginning of the record
4987 * content.
4988 *
4989 * When decrypting a protected record, ssl->in_msg
4990 * will be shifted to point to the beginning of the
4991 * record plaintext.
4992 */
4993
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004994#if defined(MBEDTLS_SSL_PROTO_DTLS)
4995 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4996 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004997 /* This sets the header pointers to match records
4998 * without CID. When we receive a record containing
4999 * a CID, the fields are shifted accordingly in
5000 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005001 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005002#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005003 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005004 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005005#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005006 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005007#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005008 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005009 }
5010 else
5011#endif
5012 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005013 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005014 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005015#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005016 ssl->in_cid = ssl->in_len;
5017#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005018 ssl->in_iv = ssl->in_hdr + 5;
5019 }
5020
Hanno Becker79594fd2019-05-08 09:38:41 +01005021 /* This will be adjusted at record decryption time. */
5022 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005023}
5024
Paul Bakker5121ce52009-01-03 21:22:43 +00005025/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005026 * Setup an SSL context
5027 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005028
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005029void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005030{
5031 /* Set the incoming and outgoing record pointers. */
5032#if defined(MBEDTLS_SSL_PROTO_DTLS)
5033 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5034 {
5035 ssl->out_hdr = ssl->out_buf;
5036 ssl->in_hdr = ssl->in_buf;
5037 }
5038 else
5039#endif /* MBEDTLS_SSL_PROTO_DTLS */
5040 {
Hanno Becker12078f42021-03-02 15:28:41 +00005041 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005042 ssl->out_hdr = ssl->out_buf + 8;
5043 ssl->in_hdr = ssl->in_buf + 8;
5044 }
5045
5046 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005047 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5048 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005049}
5050
Paul Bakker5121ce52009-01-03 21:22:43 +00005051/*
5052 * SSL get accessors
5053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005054size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005055{
5056 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5057}
5058
Hanno Becker8b170a02017-10-10 11:51:19 +01005059int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5060{
5061 /*
5062 * Case A: We're currently holding back
5063 * a message for further processing.
5064 */
5065
5066 if( ssl->keep_current_message == 1 )
5067 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005068 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005069 return( 1 );
5070 }
5071
5072 /*
5073 * Case B: Further records are pending in the current datagram.
5074 */
5075
5076#if defined(MBEDTLS_SSL_PROTO_DTLS)
5077 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5078 ssl->in_left > ssl->next_record_offset )
5079 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005081 return( 1 );
5082 }
5083#endif /* MBEDTLS_SSL_PROTO_DTLS */
5084
5085 /*
5086 * Case C: A handshake message is being processed.
5087 */
5088
Hanno Becker8b170a02017-10-10 11:51:19 +01005089 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5090 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005091 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005092 return( 1 );
5093 }
5094
5095 /*
5096 * Case D: An application data message is being processed
5097 */
5098 if( ssl->in_offt != NULL )
5099 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005100 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005101 return( 1 );
5102 }
5103
5104 /*
5105 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005106 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005107 * we implement support for multiple alerts in single records.
5108 */
5109
5110 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5111 return( 0 );
5112}
5113
Paul Bakker43ca69c2011-01-15 17:35:19 +00005114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005115int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005116{
Hanno Becker3136ede2018-08-17 15:28:19 +01005117 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005118 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005119 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005120#if defined(MBEDTLS_USE_PSA_CRYPTO)
5121 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5122 psa_key_type_t key_type;
5123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005124
Hanno Becker5903de42019-05-03 14:46:38 +01005125 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5126
Hanno Becker78640902018-08-13 16:35:15 +01005127 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005128 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005129
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005130
5131#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielbe47ecf2022-01-31 13:53:11 +01005132 if ( transform->psa_alg == PSA_ALG_GCM ||
5133 transform->psa_alg == PSA_ALG_CCM ||
5134 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG( PSA_ALG_CCM, 8 ) ||
5135 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005136 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER )
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005137 {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005138 transform_expansion = transform->minlen;
5139 }
Przemyslaw Stekiel399ed512022-01-31 08:38:00 +01005140 else if ( transform->psa_alg == PSA_ALG_CBC_NO_PADDING )
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005141 {
5142 (void) psa_get_key_attributes( transform->psa_key_enc, &attr );
5143 key_type = psa_get_key_type( &attr );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005144
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005145 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH( key_type );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005146
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005147 /* Expansion due to the addition of the MAC. */
5148 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005149
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005150 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005151 * Theoretically up to 256 bytes, but we never use
5152 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005153 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005154
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005155 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005156 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005157#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005158 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005159#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005160 }
5161 else
5162 {
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01005163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()" ) );
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005164 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005165 }
5166#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005167 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005168 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005169 case MBEDTLS_MODE_GCM:
5170 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005171 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005172 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005173 transform_expansion = transform->minlen;
5174 break;
5175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005176 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005177
5178 block_size = mbedtls_cipher_get_block_size(
5179 &transform->cipher_ctx_enc );
5180
Hanno Becker3136ede2018-08-17 15:28:19 +01005181 /* Expansion due to the addition of the MAC. */
5182 transform_expansion += transform->maclen;
5183
5184 /* Expansion due to the addition of CBC padding;
5185 * Theoretically up to 256 bytes, but we never use
5186 * more than the block size of the underlying cipher. */
5187 transform_expansion += block_size;
5188
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005189 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005190 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005191#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005192 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005193#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005194
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005195 break;
5196
5197 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005198 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005200 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005201#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005202
Hanno Beckera0e20d02019-05-15 14:03:01 +01005203#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005204 if( transform->out_cid_len != 0 )
5205 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005206#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005207
Hanno Becker5903de42019-05-03 14:46:38 +01005208 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005209}
5210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005211#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005212/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005213 * Check record counters and renegotiate if they're above the limit.
5214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005215static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005216{
Hanno Beckerdd772292020-02-05 10:38:31 +00005217 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005218 int in_ctr_cmp;
5219 int out_ctr_cmp;
5220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005221 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5222 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005223 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005224 {
5225 return( 0 );
5226 }
5227
Andres AG2196c7f2016-12-15 17:01:16 +00005228 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
Jerry Yud9a94fe2021-09-28 18:58:59 +08005229 &ssl->conf->renego_period[ep_len],
Jerry Yuae0b2e22021-10-08 15:21:19 +08005230 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len );
Jerry Yud9a94fe2021-09-28 18:58:59 +08005231 out_ctr_cmp = memcmp( &ssl->cur_out_ctr[ep_len],
5232 &ssl->conf->renego_period[ep_len],
5233 sizeof( ssl->cur_out_ctr ) - ep_len );
Andres AG2196c7f2016-12-15 17:01:16 +00005234
5235 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005236 {
5237 return( 0 );
5238 }
5239
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005240 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005241 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005242}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005243#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005244
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005245/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005246 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005247 * may only be sent for the purpose of initiating renegotiations.
5248 *
5249 * This function is introduced as a separate helper since the handling
5250 * of post-handshake handshake messages changes significantly in TLS 1.3,
5251 * and having a helper function allows to distinguish between TLS <= 1.2 and
5252 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5253 */
Hanno Beckercad3dba2020-11-24 06:57:13 +00005254static int ssl_handle_hs_message_post_handshake( mbedtls_ssl_context *ssl )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005255{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005257
5258 /*
5259 * - For client-side, expect SERVER_HELLO_REQUEST.
5260 * - For server-side, expect CLIENT_HELLO.
5261 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5262 */
5263
5264#if defined(MBEDTLS_SSL_CLI_C)
5265 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5266 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5267 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
5268 {
5269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
5270
5271 /* With DTLS, drop the packet (probably from last handshake) */
5272#if defined(MBEDTLS_SSL_PROTO_DTLS)
5273 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5274 {
5275 return( 0 );
5276 }
5277#endif
5278 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5279 }
5280#endif /* MBEDTLS_SSL_CLI_C */
5281
5282#if defined(MBEDTLS_SSL_SRV_C)
5283 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5284 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
5285 {
5286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
5287
5288 /* With DTLS, drop the packet (probably from last handshake) */
5289#if defined(MBEDTLS_SSL_PROTO_DTLS)
5290 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5291 {
5292 return( 0 );
5293 }
5294#endif
5295 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
5296 }
5297#endif /* MBEDTLS_SSL_SRV_C */
5298
5299#if defined(MBEDTLS_SSL_RENEGOTIATION)
5300 /* Determine whether renegotiation attempt should be accepted */
5301 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5302 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5303 ssl->conf->allow_legacy_renegotiation ==
5304 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5305 {
5306 /*
5307 * Accept renegotiation request
5308 */
5309
5310 /* DTLS clients need to know renego is server-initiated */
5311#if defined(MBEDTLS_SSL_PROTO_DTLS)
5312 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5313 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5314 {
5315 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5316 }
5317#endif
5318 ret = mbedtls_ssl_start_renegotiation( ssl );
5319 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5320 ret != 0 )
5321 {
5322 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5323 ret );
5324 return( ret );
5325 }
5326 }
5327 else
5328#endif /* MBEDTLS_SSL_RENEGOTIATION */
5329 {
5330 /*
5331 * Refuse renegotiation
5332 */
5333
5334 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
5335
TRodziewicz0f82ec62021-05-12 17:49:18 +02005336#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005337 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5338 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5339 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005340 {
TRodziewicz345165c2021-07-06 13:42:11 +02005341 return( ret );
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005342 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02005343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005344 }
5345
5346 return( 0 );
5347}
5348
Paul Bakker48916f92012-09-16 19:57:18 +00005349/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005350 * Receive application data decrypted from the SSL layer
5351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005352int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005353{
Janos Follath865b3eb2019-12-16 11:46:15 +00005354 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005355 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005356
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005357 if( ssl == NULL || ssl->conf == NULL )
5358 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005363 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005364 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005365 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005366 return( ret );
5367
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005368 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005369 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005370 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005371 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005372 return( ret );
5373 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005374 }
5375#endif
5376
Hanno Becker4a810fb2017-05-24 16:27:30 +01005377 /*
5378 * Check if renegotiation is necessary and/or handshake is
5379 * in process. If yes, perform/continue, and fall through
5380 * if an unexpected packet is received while the client
5381 * is waiting for the ServerHello.
5382 *
5383 * (There is no equivalent to the last condition on
5384 * the server-side as it is not treated as within
5385 * a handshake while waiting for the ClientHello
5386 * after a renegotiation request.)
5387 */
5388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005389#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005390 ret = ssl_check_ctr_renegotiate( ssl );
5391 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5392 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005393 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005394 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005395 return( ret );
5396 }
5397#endif
5398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005400 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005402 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5403 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005404 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005405 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005406 return( ret );
5407 }
5408 }
5409
Hanno Beckere41158b2017-10-23 13:30:32 +01005410 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005411 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005412 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005413 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005414 if( ssl->f_get_timer != NULL &&
5415 ssl->f_get_timer( ssl->p_timer ) == -1 )
5416 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005417 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005418 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005419
Hanno Becker327c93b2018-08-15 13:56:18 +01005420 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005421 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005422 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5423 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005424
Hanno Becker4a810fb2017-05-24 16:27:30 +01005425 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5426 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005427 }
5428
5429 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005431 {
5432 /*
5433 * OpenSSL sends empty messages to randomize the IV
5434 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005435 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005438 return( 0 );
5439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005441 return( ret );
5442 }
5443 }
5444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005446 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005447 ret = ssl_handle_hs_message_post_handshake( ssl );
5448 if( ret != 0)
Paul Bakker48916f92012-09-16 19:57:18 +00005449 {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005450 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_handle_hs_message_post_handshake",
5451 ret );
5452 return( ret );
Paul Bakker48916f92012-09-16 19:57:18 +00005453 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005454
Hanno Beckerf26cc722021-04-21 07:30:13 +01005455 /* At this point, we don't know whether the renegotiation triggered
5456 * by the post-handshake message has been completed or not. The cases
5457 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005458 * 1) The renegotiation is complete. In this case, no new record
5459 * has been read yet.
5460 * 2) The renegotiation is incomplete because the client received
5461 * an application data record while awaiting the ServerHello.
5462 * 3) The renegotiation is incomplete because the client received
5463 * a non-handshake, non-application data message while awaiting
5464 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005465 *
5466 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005467 * - For 1), the next iteration will read a new record and check
5468 * if it's application data.
5469 * - For 2), the loop condition isn't satisfied as application data
5470 * is present, hence continue is the same as break
5471 * - For 3), the loop condition is satisfied and read_record
5472 * will re-deliver the message that was held back by the client
5473 * when expecting the ServerHello.
5474 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005475
Hanno Becker90333da2017-10-10 11:27:13 +01005476 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005477 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005478#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005480 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005481 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005482 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005483 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005484 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005486 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005488 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005489 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005490 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5494 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005495 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005497 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005498 }
5499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005501 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5503 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005504 }
5505
5506 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005507
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005508 /* We're going to return something now, cancel timer,
5509 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005511 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005512
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005513#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005514 /* If we requested renego but received AppData, resend HelloRequest.
5515 * Do it now, after setting in_offt, to avoid taking this branch
5516 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005518 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005520 {
Hanno Becker786300f2020-02-05 10:46:40 +00005521 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005522 {
Hanno Becker786300f2020-02-05 10:46:40 +00005523 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5524 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005525 return( ret );
5526 }
5527 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005529#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005530 }
5531
5532 n = ( len < ssl->in_msglen )
5533 ? len : ssl->in_msglen;
5534
5535 memcpy( buf, ssl->in_offt, n );
5536 ssl->in_msglen -= n;
5537
gabor-mezei-arma3214132020-07-15 10:55:00 +02005538 /* Zeroising the plaintext buffer to erase unused application data
5539 from the memory. */
5540 mbedtls_platform_zeroize( ssl->in_offt, n );
5541
Paul Bakker5121ce52009-01-03 21:22:43 +00005542 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005543 {
5544 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005545 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005546 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005547 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005548 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005549 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005550 /* more data available */
5551 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005552 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005554 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005555
Paul Bakker23986e52011-04-24 08:57:21 +00005556 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005557}
5558
5559/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005560 * Send application data to be encrypted by the SSL layer, taking care of max
5561 * fragment length and buffer size.
5562 *
5563 * According to RFC 5246 Section 6.2.1:
5564 *
5565 * Zero-length fragments of Application data MAY be sent as they are
5566 * potentially useful as a traffic analysis countermeasure.
5567 *
5568 * Therefore, it is possible that the input message length is 0 and the
5569 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005570 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005571static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005572 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005573{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005574 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5575 const size_t max_len = (size_t) ret;
5576
5577 if( ret < 0 )
5578 {
5579 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5580 return( ret );
5581 }
5582
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005583 if( len > max_len )
5584 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005585#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005586 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005589 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5590 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005591 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005592 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005593 }
5594 else
5595#endif
5596 len = max_len;
5597 }
Paul Bakker887bd502011-06-08 13:10:54 +00005598
Paul Bakker5121ce52009-01-03 21:22:43 +00005599 if( ssl->out_left != 0 )
5600 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005601 /*
5602 * The user has previously tried to send the data and
5603 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5604 * written. In this case, we expect the high-level write function
5605 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005608 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005609 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005610 return( ret );
5611 }
5612 }
Paul Bakker887bd502011-06-08 13:10:54 +00005613 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005614 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005615 /*
5616 * The user is trying to send a message the first time, so we need to
5617 * copy the data into the internal buffers and setup the data structure
5618 * to keep track of partial writes
5619 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005620 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005621 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005622 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005623
Hanno Becker67bc7c32018-08-06 11:33:50 +01005624 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005625 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005626 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005627 return( ret );
5628 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005629 }
5630
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005631 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005632}
5633
5634/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005635 * Write application data (public-facing wrapper)
5636 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005637int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005638{
Janos Follath865b3eb2019-12-16 11:46:15 +00005639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005640
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005642
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005643 if( ssl == NULL || ssl->conf == NULL )
5644 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5645
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005646#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005647 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5648 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005649 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005650 return( ret );
5651 }
5652#endif
5653
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005654 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005655 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005656 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005657 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005658 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005659 return( ret );
5660 }
5661 }
5662
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005663 ret = ssl_write_real( ssl, buf, len );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005664
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005665 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005666
5667 return( ret );
5668}
5669
5670/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005671 * Notify the peer that the connection is being closed
5672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005674{
Janos Follath865b3eb2019-12-16 11:46:15 +00005675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005676
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005677 if( ssl == NULL || ssl->conf == NULL )
5678 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005681
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005682 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5688 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5689 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005690 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005691 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005692 return( ret );
5693 }
5694 }
5695
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005697
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005698 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005699}
5700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005702{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005703 if( transform == NULL )
5704 return;
5705
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005706#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekielce37d112022-01-13 14:53:52 +01005707 psa_destroy_key( transform->psa_key_enc );
5708 psa_destroy_key( transform->psa_key_dec );
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005709#else
5710 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5711 mbedtls_cipher_free( &transform->cipher_ctx_dec );
5712#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005713
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005714#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005715#if defined(MBEDTLS_USE_PSA_CRYPTO)
5716 psa_destroy_key( transform->psa_mac_enc );
5717 psa_destroy_key( transform->psa_mac_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005718#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719 mbedtls_md_free( &transform->md_ctx_enc );
5720 mbedtls_md_free( &transform->md_ctx_dec );
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005721#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005722#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005723
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005724 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005725}
5726
Jerry Yuc7875b52021-09-05 21:05:50 +08005727void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
5728 mbedtls_ssl_transform *transform )
5729{
Jerry Yuc7875b52021-09-05 21:05:50 +08005730 ssl->transform_in = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005731 memset( ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN );
Jerry Yuc7875b52021-09-05 21:05:50 +08005732}
5733
5734void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
5735 mbedtls_ssl_transform *transform )
5736{
5737 ssl->transform_out = transform;
Jerry Yufd320e92021-10-08 21:52:41 +08005738 memset( ssl->cur_out_ctr, 0, sizeof( ssl->cur_out_ctr ) );
Jerry Yuc7875b52021-09-05 21:05:50 +08005739}
5740
Hanno Becker0271f962018-08-16 13:23:47 +01005741#if defined(MBEDTLS_SSL_PROTO_DTLS)
5742
Hanno Becker533ab5f2020-02-05 10:49:13 +00005743void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005744{
5745 unsigned offset;
5746 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5747
5748 if( hs == NULL )
5749 return;
5750
Hanno Becker283f5ef2018-08-24 09:34:47 +01005751 ssl_free_buffered_record( ssl );
5752
Hanno Becker0271f962018-08-16 13:23:47 +01005753 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005754 ssl_buffering_free_slot( ssl, offset );
5755}
5756
5757static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5758 uint8_t slot )
5759{
5760 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5761 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005762
5763 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5764 return;
5765
Hanno Beckere605b192018-08-21 15:59:07 +01005766 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005767 {
Hanno Beckere605b192018-08-21 15:59:07 +01005768 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005769 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005770 mbedtls_free( hs_buf->data );
5771 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005772 }
5773}
5774
5775#endif /* MBEDTLS_SSL_PROTO_DTLS */
5776
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005777/*
5778 * Convert version numbers to/from wire format
5779 * and, for DTLS, to/from TLS equivalent.
5780 *
5781 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005782 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005783 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005785void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005786 unsigned char ver[2] )
5787{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788#if defined(MBEDTLS_SSL_PROTO_DTLS)
5789 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005790 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005792 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5793
5794 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5795 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5796 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005797 else
5798#else
5799 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005800#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005801 {
5802 ver[0] = (unsigned char) major;
5803 ver[1] = (unsigned char) minor;
5804 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005805}
5806
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005807void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005808 const unsigned char ver[2] )
5809{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005810#if defined(MBEDTLS_SSL_PROTO_DTLS)
5811 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005812 {
5813 *major = 255 - ver[0] + 2;
5814 *minor = 255 - ver[1] + 1;
5815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005816 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005817 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5818 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005819 else
5820#else
5821 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005822#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005823 {
5824 *major = ver[0];
5825 *minor = ver[1];
5826 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005827}
5828
Jerry Yue7047812021-09-13 19:26:39 +08005829/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005830 * Send pending fatal alert.
5831 * 0, No alert message.
5832 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5833 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005834 */
5835int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl )
5836{
5837 int ret;
5838
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005839 /* No pending alert, return success*/
5840 if( ssl->send_alert == 0 )
5841 return( 0 );
Jerry Yu394ece62021-09-14 22:17:21 +08005842
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005843 ret = mbedtls_ssl_send_alert_message( ssl,
5844 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5845 ssl->alert_type );
5846
Jerry Yu3bf1f972021-09-22 21:37:18 +08005847 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5848 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005849 */
5850 if( ret != MBEDTLS_ERR_SSL_WANT_WRITE )
5851 {
5852 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005853 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005854
5855 if( ret != 0 )
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005856 return( ret );
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005857
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005858 return( ssl->alert_reason );
Jerry Yue7047812021-09-13 19:26:39 +08005859}
5860
Jerry Yu394ece62021-09-14 22:17:21 +08005861/*
5862 * Set pending fatal alert flag.
5863 */
5864void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
5865 unsigned char alert_type,
5866 int alert_reason )
5867{
5868 ssl->send_alert = 1;
5869 ssl->alert_type = alert_type;
5870 ssl->alert_reason = alert_reason;
5871}
5872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005873#endif /* MBEDTLS_SSL_TLS_C */