blob: d7bebe04d656e354edf7c7106185919365d68845 [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/*
21 * The SSL 3.0 specification was drafted by Netscape in 1996,
22 * and became an IETF standard in 1999.
23 *
24 * http://wp.netscape.com/eng/ssl3/
25 * http://www.ietf.org/rfc/rfc2246.txt
26 * http://www.ietf.org/rfc/rfc4346.txt
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000032
SimonBd5800b72016-04-26 07:43:27 +010033#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010034
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000035#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020036#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000037#include "mbedtls/debug.h"
38#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050039#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010040#include "mbedtls/version.h"
Gabor Mezeic0ae1cf2021-10-20 12:09:35 +020041#include "constant_time_internal.h"
Gabor Mezeie24dea82021-10-19 12:22:25 +020042#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020043
Rich Evans00ab4702015-02-06 13:43:58 +000044#include <string.h>
45
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050046#if defined(MBEDTLS_USE_PSA_CRYPTO)
47#include "mbedtls/psa_util.h"
48#include "psa/crypto.h"
49#endif
50
Janos Follath23bdca02016-10-07 14:47:14 +010051#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000052#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020053#endif
54
Hanno Beckercd9dcda2018-08-28 17:18:56 +010055static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010056
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020057/*
58 * Start a timer.
59 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020060 */
Hanno Becker0f57a652020-02-05 10:37:26 +000061void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020062{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020063 if( ssl->f_set_timer == NULL )
64 return;
65
66 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
67 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068}
69
70/*
71 * Return -1 is timer is expired, 0 if it isn't.
72 */
Hanno Becker7876d122020-02-05 10:39:31 +000073int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020074{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020075 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020076 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020077
78 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020079 {
80 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020081 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020082 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083
84 return( 0 );
85}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020086
Hanno Beckercfe45792019-07-03 16:13:00 +010087#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +020088MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker54229812019-07-12 14:40:00 +010089static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
90 unsigned char *buf,
91 size_t len,
92 mbedtls_record *rec );
93
Hanno Beckercfe45792019-07-03 16:13:00 +010094int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t buflen )
97{
Hanno Becker54229812019-07-12 14:40:00 +010098 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +010099 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
100 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
101
102 /* We don't support record checking in TLS because
103 * (a) there doesn't seem to be a usecase for it, and
104 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
105 * and we'd need to backup the transform here.
106 */
107 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
108 {
109 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
110 goto exit;
111 }
112#if defined(MBEDTLS_SSL_PROTO_DTLS)
113 else
114 {
irwir734f0cf2019-09-26 21:03:24 +0300115 mbedtls_record rec;
116
Hanno Becker54229812019-07-12 14:40:00 +0100117 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
118 if( ret != 0 )
119 {
120 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
121 goto exit;
122 }
123
124 if( ssl->transform_in != NULL )
125 {
126 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
127 if( ret != 0 )
128 {
129 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
130 goto exit;
131 }
132 }
133 }
134#endif /* MBEDTLS_SSL_PROTO_DTLS */
135
136exit:
137 /* On success, we have decrypted the buffer in-place, so make
138 * sure we don't leak any plaintext data. */
139 mbedtls_platform_zeroize( buf, buflen );
140
141 /* For the purpose of this API, treat messages with unexpected CID
142 * as well as such from future epochs as unexpected. */
143 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
144 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
145 {
146 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
147 }
148
149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
150 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100151}
152#endif /* MBEDTLS_SSL_RECORD_CHECKING */
153
Hanno Becker67bc7c32018-08-06 11:33:50 +0100154#define SSL_DONT_FORCE_FLUSH 0
155#define SSL_FORCE_FLUSH 1
156
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200157#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100158
Hanno Beckerd5847772018-08-28 10:09:23 +0100159/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100160static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
161 uint8_t slot );
162static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200163MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100164static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200165MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100166static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200167MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerd5847772018-08-28 10:09:23 +0100168static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200169MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +0100170static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
171 mbedtls_record const *rec );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200172MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100173static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100174
Hanno Becker11682cc2018-08-22 14:41:02 +0100175static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176{
Hanno Becker89490712020-02-05 10:50:12 +0000177 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000178#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
179 size_t out_buf_len = ssl->out_buf_len;
180#else
181 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
182#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183
Darryl Greenb33cc762019-11-28 14:29:44 +0000184 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186
Darryl Greenb33cc762019-11-28 14:29:44 +0000187 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188}
189
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200190MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
192{
Hanno Becker11682cc2018-08-22 14:41:02 +0100193 size_t const bytes_written = ssl->out_left;
194 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100195
196 /* Double-check that the write-index hasn't gone
197 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100198 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100199 {
200 /* Should never happen... */
201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
202 }
203
204 return( (int) ( mtu - bytes_written ) );
205}
206
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200207MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker67bc7c32018-08-06 11:33:50 +0100208static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
209{
Janos Follath865b3eb2019-12-16 11:46:15 +0000210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400212 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100213
214#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400215 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100216
217 if( max_len > mfl )
218 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100219
220 /* By the standard (RFC 6066 Sect. 4), the MFL extension
221 * only limits the maximum record payload size, so in theory
222 * we would be allowed to pack multiple records of payload size
223 * MFL into a single datagram. However, this would mean that there's
224 * no way to explicitly communicate MTU restrictions to the peer.
225 *
226 * The following reduction of max_len makes sure that we never
227 * write datagrams larger than MFL + Record Expansion Overhead.
228 */
229 if( max_len <= ssl->out_left )
230 return( 0 );
231
232 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100233#endif
234
235 ret = ssl_get_remaining_space_in_datagram( ssl );
236 if( ret < 0 )
237 return( ret );
238 remaining = (size_t) ret;
239
240 ret = mbedtls_ssl_get_record_expansion( ssl );
241 if( ret < 0 )
242 return( ret );
243 expansion = (size_t) ret;
244
245 if( remaining <= expansion )
246 return( 0 );
247
248 remaining -= expansion;
249 if( remaining >= max_len )
250 remaining = max_len;
251
252 return( (int) remaining );
253}
254
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200255/*
256 * Double the retransmit timeout value, within the allowed range,
257 * returning -1 if the maximum value has already been reached.
258 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200259MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200261{
262 uint32_t new_timeout;
263
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200264 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200265 return( -1 );
266
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200267 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
268 * in the following way: after the initial transmission and a first
269 * retransmission, back off to a temporary estimated MTU of 508 bytes.
270 * This value is guaranteed to be deliverable (if not guaranteed to be
271 * delivered) of any compliant IPv4 (and IPv6) network, and should work
272 * on most non-IP stacks too. */
273 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400274 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200275 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400276 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
277 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200278
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200279 new_timeout = 2 * ssl->handshake->retransmit_timeout;
280
281 /* Avoid arithmetic overflow and range overflow */
282 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200283 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200284 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200285 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200286 }
287
288 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000289 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
290 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291
292 return( 0 );
293}
294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200296{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200297 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000298 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
299 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200300}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
304int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200305 const unsigned char *key_enc, const unsigned char *key_dec,
306 size_t keylen,
307 const unsigned char *iv_enc, const unsigned char *iv_dec,
308 size_t ivlen,
309 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200310 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
312int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
313int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
314int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
315int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
316#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000317
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100318/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000319 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200320 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000321
Hanno Beckerccc13d02020-05-04 12:30:04 +0100322#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
323 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100324
325static size_t ssl_compute_padding_length( size_t len,
326 size_t granularity )
327{
328 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
329}
330
Hanno Becker581bc1b2020-05-04 12:20:03 +0100331/* This functions transforms a (D)TLS plaintext fragment and a record content
332 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
333 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
334 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100335 *
336 * struct {
337 * opaque content[DTLSPlaintext.length];
338 * ContentType real_type;
339 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100340 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341 *
342 * Input:
343 * - `content`: The beginning of the buffer holding the
344 * plaintext to be wrapped.
345 * - `*content_size`: The length of the plaintext in Bytes.
346 * - `max_len`: The number of Bytes available starting from
347 * `content`. This must be `>= *content_size`.
348 * - `rec_type`: The desired record content type.
349 *
350 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100351 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
352 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100353 *
354 * Returns:
355 * - `0` on success.
356 * - A negative error code if `max_len` didn't offer enough space
357 * for the expansion.
358 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200359MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100360static int ssl_build_inner_plaintext( unsigned char *content,
361 size_t *content_size,
362 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100363 uint8_t rec_type,
364 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100365{
366 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100367
368 /* Write real content type */
369 if( remaining == 0 )
370 return( -1 );
371 content[ len ] = rec_type;
372 len++;
373 remaining--;
374
375 if( remaining < pad )
376 return( -1 );
377 memset( content + len, 0, pad );
378 len += pad;
379 remaining -= pad;
380
381 *content_size = len;
382 return( 0 );
383}
384
Hanno Becker581bc1b2020-05-04 12:20:03 +0100385/* This function parses a (D)TLSInnerPlaintext structure.
386 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200387MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker581bc1b2020-05-04 12:20:03 +0100388static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100389 size_t *content_size,
390 uint8_t *rec_type )
391{
392 size_t remaining = *content_size;
393
394 /* Determine length of padding by skipping zeroes from the back. */
395 do
396 {
397 if( remaining == 0 )
398 return( -1 );
399 remaining--;
400 } while( content[ remaining ] == 0 );
401
402 *content_size = remaining;
403 *rec_type = content[ remaining ];
404
405 return( 0 );
406}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100407#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
408 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100409
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100410/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100411 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000412static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100414 mbedtls_record *rec,
415 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000416{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100417 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100418 *
419 * additional_data = seq_num + TLSCompressed.type +
420 * TLSCompressed.version + TLSCompressed.length;
421 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100422 * For the CID extension, this is extended as follows
423 * (quoting draft-ietf-tls-dtls-connection-id-05,
424 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100425 *
426 * additional_data = seq_num + DTLSPlaintext.type +
427 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100428 * cid +
429 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100431 *
432 * For TLS 1.3, the record sequence number is dropped from the AAD
433 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100434 */
435
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100436 unsigned char *cur = add_data;
437
David Horstmann197b2402022-10-26 18:06:31 +0100438 int is_tls13 = 0;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100439#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
David Horstmann197b2402022-10-26 18:06:31 +0100440 if( minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
441 is_tls13 = 1;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100442#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
David Horstmann197b2402022-10-26 18:06:31 +0100443 if( !is_tls13 )
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100444 {
445 ((void) minor_ver);
446 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
447 cur += sizeof( rec->ctr );
448 }
449
450 *cur = rec->type;
451 cur++;
452
453 memcpy( cur, rec->ver, sizeof( rec->ver ) );
454 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100455
Hanno Beckera0e20d02019-05-15 14:03:01 +0100456#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100457 if( rec->cid_len != 0 )
458 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 memcpy( cur, rec->cid, rec->cid_len );
460 cur += rec->cid_len;
461
462 *cur = rec->cid_len;
463 cur++;
464
Joe Subbianic54e9082021-07-19 11:56:54 +0100465 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
468 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100469#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100470 {
Joe Subbianic54e9082021-07-19 11:56:54 +0100471 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100472 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100473 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100474
475 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000476}
477
Hanno Becker9d062f92020-02-07 10:26:36 +0000478#if defined(MBEDTLS_SSL_PROTO_SSL3)
479
480#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
481
482/*
483 * SSLv3.0 MAC functions
484 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200485MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100486static int ssl_mac( mbedtls_md_context_t *md_ctx,
487 const unsigned char *secret,
488 const unsigned char *buf, size_t len,
489 const unsigned char *ctr, int type,
490 unsigned char out[SSL3_MAC_MAX_BYTES] )
Hanno Becker9d062f92020-02-07 10:26:36 +0000491{
492 unsigned char header[11];
493 unsigned char padding[48];
494 int padlen;
495 int md_size = mbedtls_md_get_size( md_ctx->md_info );
496 int md_type = mbedtls_md_get_type( md_ctx->md_info );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9d062f92020-02-07 10:26:36 +0000498
499 /* Only MD5 and SHA-1 supported */
500 if( md_type == MBEDTLS_MD_MD5 )
501 padlen = 48;
502 else
503 padlen = 40;
504
505 memcpy( header, ctr, 8 );
Joe Subbiania651e6f2021-08-23 11:35:25 +0100506 header[8] = (unsigned char) type;
Joe Subbiani11b71312021-08-23 12:49:14 +0100507 MBEDTLS_PUT_UINT16_BE( len, header, 9);
Hanno Becker9d062f92020-02-07 10:26:36 +0000508
509 memset( padding, 0x36, padlen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100510 ret = mbedtls_md_starts( md_ctx );
511 if( ret != 0 )
512 return( ret );
513 ret = mbedtls_md_update( md_ctx, secret, md_size );
514 if( ret != 0 )
515 return( ret );
516 ret = mbedtls_md_update( md_ctx, padding, padlen );
517 if( ret != 0 )
518 return( ret );
519 ret = mbedtls_md_update( md_ctx, header, 11 );
520 if( ret != 0 )
521 return( ret );
522 ret = mbedtls_md_update( md_ctx, buf, len );
523 if( ret != 0 )
524 return( ret );
525 ret = mbedtls_md_finish( md_ctx, out );
526 if( ret != 0 )
527 return( ret );
Hanno Becker9d062f92020-02-07 10:26:36 +0000528
529 memset( padding, 0x5C, padlen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100530 ret = mbedtls_md_starts( md_ctx );
531 if( ret != 0 )
532 return( ret );
533 ret = mbedtls_md_update( md_ctx, secret, md_size );
534 if( ret != 0 )
535 return( ret );
536 ret = mbedtls_md_update( md_ctx, padding, padlen );
537 if( ret != 0 )
538 return( ret );
539 ret = mbedtls_md_update( md_ctx, out, md_size );
540 if( ret != 0 )
541 return( ret );
542 ret = mbedtls_md_finish( md_ctx, out );
543 if( ret != 0 )
544 return( ret );
545
546 return( 0 );
Hanno Becker9d062f92020-02-07 10:26:36 +0000547}
548#endif /* MBEDTLS_SSL_PROTO_SSL3 */
549
Hanno Becker67a37db2020-05-28 16:27:07 +0100550#if defined(MBEDTLS_GCM_C) || \
551 defined(MBEDTLS_CCM_C) || \
552 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +0200553MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100554static int ssl_transform_aead_dynamic_iv_is_explicit(
555 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100556{
Hanno Becker17263802020-05-28 07:05:48 +0100557 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100558}
559
Hanno Becker17263802020-05-28 07:05:48 +0100560/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
561 *
562 * Concretely, this occurs in two variants:
563 *
564 * a) Fixed and dynamic IV lengths add up to total IV length, giving
565 * IV = fixed_iv || dynamic_iv
566 *
Hanno Becker15952812020-06-04 13:31:46 +0100567 * This variant is used in TLS 1.2 when used with GCM or CCM.
568 *
Hanno Becker17263802020-05-28 07:05:48 +0100569 * b) Fixed IV lengths matches total IV length, giving
570 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100571 *
572 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
573 *
574 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100575 *
576 * This function has the precondition that
577 *
578 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
579 *
580 * which has to be ensured by the caller. If this precondition
581 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100582 */
583static void ssl_build_record_nonce( unsigned char *dst_iv,
584 size_t dst_iv_len,
585 unsigned char const *fixed_iv,
586 size_t fixed_iv_len,
587 unsigned char const *dynamic_iv,
588 size_t dynamic_iv_len )
589{
590 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100591
592 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100593 memset( dst_iv, 0, dst_iv_len );
594 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100595
Hanno Becker17263802020-05-28 07:05:48 +0100596 dst_iv += dst_iv_len - dynamic_iv_len;
597 for( i = 0; i < dynamic_iv_len; i++ )
598 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100599}
Hanno Becker67a37db2020-05-28 16:27:07 +0100600#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100601
Hanno Beckera18d1322018-01-03 14:27:32 +0000602int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
603 mbedtls_ssl_transform *transform,
604 mbedtls_record *rec,
605 int (*f_rng)(void *, unsigned char *, size_t),
606 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000607{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100609 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000610 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100611 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100612 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000613 size_t post_avail;
614
615 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000616#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200617 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000618 ((void) ssl);
619#endif
620
621 /* The PRNG is used for dynamic IV generation that's used
622 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200623#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000624 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
625 ((void) f_rng);
626 ((void) p_rng);
627#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000630
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000631 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100632 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
634 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
635 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100636 if( rec == NULL
637 || rec->buf == NULL
638 || rec->buf_len < rec->data_offset
639 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100640#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100641 || rec->cid_len != 0
642#endif
643 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000644 {
645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200646 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100647 }
648
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000649 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100650 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000652 data, rec->data_len );
653
654 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
655
656 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
657 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000658 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
659 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000660 rec->data_len,
661 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000662 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
663 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100664
Hanno Becker92313402020-05-20 13:58:58 +0100665 /* The following two code paths implement the (D)TLSInnerPlaintext
666 * structure present in TLS 1.3 and DTLS 1.2 + CID.
667 *
668 * See ssl_build_inner_plaintext() for more information.
669 *
670 * Note that this changes `rec->data_len`, and hence
671 * `post_avail` needs to be recalculated afterwards.
672 *
673 * Note also that the two code paths cannot occur simultaneously
674 * since they apply to different versions of the protocol. There
675 * is hence no risk of double-addition of the inner plaintext.
676 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100677#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
678 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
679 {
Hanno Becker13996922020-05-28 16:15:19 +0100680 size_t padding =
681 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100682 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100683 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100684 &rec->data_len,
685 post_avail,
686 rec->type,
687 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100688 {
689 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
690 }
691
692 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
693 }
694#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
695
Hanno Beckera0e20d02019-05-15 14:03:01 +0100696#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100697 /*
698 * Add CID information
699 */
700 rec->cid_len = transform->out_cid_len;
701 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
702 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100703
704 if( rec->cid_len != 0 )
705 {
Hanno Becker13996922020-05-28 16:15:19 +0100706 size_t padding =
707 ssl_compute_padding_length( rec->data_len,
708 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100709 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100710 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100711 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100712 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100713 * Note that this changes `rec->data_len`, and hence
714 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100715 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100716 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100717 &rec->data_len,
718 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100719 rec->type,
720 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100721 {
722 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
723 }
724
725 rec->type = MBEDTLS_SSL_MSG_CID;
726 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100727#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100728
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100729 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
730
Paul Bakker5121ce52009-01-03 21:22:43 +0000731 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100732 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000733 */
Hanno Becker52344c22018-01-03 15:24:20 +0000734#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735 if( mode == MBEDTLS_MODE_STREAM ||
736 ( mode == MBEDTLS_MODE_CBC
737#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000738 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100739#endif
740 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000741 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000742 if( post_avail < transform->maclen )
743 {
744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
745 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
746 }
747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200750 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000751 unsigned char mac[SSL3_MAC_MAX_BYTES];
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100752 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
753 ret = ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
754 data, rec->data_len, rec->ctr, rec->type, mac );
755 if( ret == 0 )
756 memcpy( data + rec->data_len, mac, transform->maclen );
Gilles Peskined8e2e832021-12-10 21:33:21 +0100757 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100758 if( ret != 0 )
759 {
760 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_mac", ret );
761 return( ret );
762 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200763 }
764 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200765#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
767 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200769 {
Hanno Becker992b6872017-11-09 18:57:39 +0000770 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100771 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000772
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100773 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
774 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000775
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100776 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
777 add_data, add_data_len );
778 if( ret != 0 )
779 goto hmac_failed_etm_disabled;
780 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
781 data, rec->data_len );
782 if( ret != 0 )
783 goto hmac_failed_etm_disabled;
784 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
785 if( ret != 0 )
786 goto hmac_failed_etm_disabled;
787 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
788 if( ret != 0 )
789 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000790
791 memcpy( data + rec->data_len, mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100792
793 hmac_failed_etm_disabled:
Gilles Peskined8e2e832021-12-10 21:33:21 +0100794 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100795 if( ret != 0 )
796 {
797 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
798 return( ret );
799 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200800 }
801 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200802#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
805 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200806 }
807
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000808 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
809 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200810
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000811 rec->data_len += transform->maclen;
812 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100813 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200814 }
Hanno Becker52344c22018-01-03 15:24:20 +0000815#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000816
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200817 /*
818 * Encrypt
819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
821 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000822 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000823 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000824 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000825 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000826 "including %d bytes of padding",
827 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000828
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000829 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
830 transform->iv_enc, transform->ivlen,
831 data, rec->data_len,
832 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200835 return( ret );
836 }
837
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000838 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200839 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
841 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200842 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000843 }
Paul Bakker68884e32013-01-07 18:20:04 +0100844 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000846
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200847#if defined(MBEDTLS_GCM_C) || \
848 defined(MBEDTLS_CCM_C) || \
849 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200851 mode == MBEDTLS_MODE_CCM ||
852 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000853 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200855 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100856 unsigned char *dynamic_iv;
857 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100858 int dynamic_iv_is_explicit =
859 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000860
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100861 /* Check that there's space for the authentication tag. */
862 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 {
864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
865 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
866 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000867
Paul Bakker68884e32013-01-07 18:20:04 +0100868 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100869 * Build nonce for AEAD encryption.
870 *
871 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
872 * part of the IV is prepended to the ciphertext and
873 * can be chosen freely - in particular, it need not
874 * agree with the record sequence number.
875 * However, since ChaChaPoly as well as all AEAD modes
876 * in TLS 1.3 use the record sequence number as the
877 * dynamic part of the nonce, we uniformly use the
878 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100879 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100880 dynamic_iv = rec->ctr;
881 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200882
Hanno Becker17263802020-05-28 07:05:48 +0100883 ssl_build_record_nonce( iv, sizeof( iv ),
884 transform->iv_enc,
885 transform->fixed_ivlen,
886 dynamic_iv,
887 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100888
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100889 /*
890 * Build additional data for AEAD encryption.
891 * This depends on the TLS version.
892 */
893 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
894 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100895
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200896 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100897 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200898 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100899 dynamic_iv,
900 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000901 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100902 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200904 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000905 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000906
Paul Bakker68884e32013-01-07 18:20:04 +0100907 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200908 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200909 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100911 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100913 add_data, add_data_len,
914 data, rec->data_len, /* src */
915 data, rec->buf_len - (data - rec->buf), /* dst */
916 &rec->data_len,
917 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200918 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200920 return( ret );
921 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100923 data + rec->data_len - transform->taglen,
924 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100925 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000926 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100927
928 /*
929 * Prefix record content with dynamic IV in case it is explicit.
930 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100931 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100932 {
933 if( rec->data_offset < dynamic_iv_len )
934 {
935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
936 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
937 }
938
939 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
940 rec->data_offset -= dynamic_iv_len;
941 rec->data_len += dynamic_iv_len;
942 }
943
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100944 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000945 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000946 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100947#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200948#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000950 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000951 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 size_t padlen, i;
953 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000954
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000955 /* Currently we're always using minimal padding
956 * (up to 255 bytes would be allowed). */
957 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
958 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000959 padlen = 0;
960
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000961 /* Check there's enough space in the buffer for the padding. */
962 if( post_avail < padlen + 1 )
963 {
964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
965 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
966 }
967
Paul Bakker5121ce52009-01-03 21:22:43 +0000968 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000970
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000971 rec->data_len += padlen + 1;
972 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000975 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000976 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
977 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000978 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000979 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000980 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000981 if( f_rng == NULL )
982 {
983 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
984 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
985 }
986
987 if( rec->data_offset < transform->ivlen )
988 {
989 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
990 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
991 }
992
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000993 /*
994 * Generate IV
995 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000996 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000997 if( ret != 0 )
998 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000999
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001000 memcpy( data - transform->ivlen, transform->iv_enc,
1001 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001002
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001003 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001005
Paul Elliottd48d5c62021-01-07 14:47:05 +00001006 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1007 "including %" MBEDTLS_PRINTF_SIZET
1008 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001009 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001010 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001011
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1013 transform->iv_enc,
1014 transform->ivlen,
1015 data, rec->data_len,
1016 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001017 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001019 return( ret );
1020 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001021
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001023 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1025 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001026 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001029 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001030 {
1031 /*
1032 * Save IV in SSL3 and TLS1
1033 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001034 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
1035 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001036 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001037 else
Paul Bakkercca5b812013-08-31 17:40:26 +02001038#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001039 {
1040 data -= transform->ivlen;
1041 rec->data_offset -= transform->ivlen;
1042 rec->data_len += transform->ivlen;
1043 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001046 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001047 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001048 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1049
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001050 /*
1051 * MAC(MAC_write_key, seq_num +
1052 * TLSCipherText.type +
1053 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001054 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001055 * IV + // except for TLS 1.0
1056 * ENC(content + padding + padding_length));
1057 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001058
1059 if( post_avail < transform->maclen)
1060 {
1061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1062 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1063 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001064
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001065 ssl_extract_add_data_from_record( add_data, &add_data_len,
1066 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001069 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001070 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001071
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001072 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1073 add_data_len );
1074 if( ret != 0 )
1075 goto hmac_failed_etm_enabled;
1076 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1077 data, rec->data_len );
1078 if( ret != 0 )
1079 goto hmac_failed_etm_enabled;
1080 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1081 if( ret != 0 )
1082 goto hmac_failed_etm_enabled;
1083 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1084 if( ret != 0 )
1085 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001086
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001087 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001088
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001089 rec->data_len += transform->maclen;
1090 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001091 auth_done++;
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001092
1093 hmac_failed_etm_enabled:
Gilles Peskined8e2e832021-12-10 21:33:21 +01001094 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001095 if( ret != 0 )
1096 {
1097 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1098 return( ret );
1099 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001100 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001102 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001103 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001104#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001105 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1107 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001108 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001109
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001110 /* Make extra sure authentication was performed, exactly once */
1111 if( auth_done != 1 )
1112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1114 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001115 }
1116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001118
1119 return( 0 );
1120}
1121
Hanno Becker605949f2019-07-12 08:23:59 +01001122int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001123 mbedtls_ssl_transform *transform,
1124 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001125{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001126 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001129#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001130 size_t padlen = 0, correct = 1;
1131#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001132 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001133 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001134 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001135
Hanno Beckera18d1322018-01-03 14:27:32 +00001136#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001137 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001138 ((void) ssl);
1139#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001142 if( rec == NULL ||
1143 rec->buf == NULL ||
1144 rec->buf_len < rec->data_offset ||
1145 rec->buf_len - rec->data_offset < rec->data_len )
1146 {
1147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001149 }
1150
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001151 data = rec->buf + rec->data_offset;
1152 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001153
Hanno Beckera0e20d02019-05-15 14:03:01 +01001154#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001155 /*
1156 * Match record's CID with incoming CID.
1157 */
Hanno Becker938489a2019-05-08 13:02:22 +01001158 if( rec->cid_len != transform->in_cid_len ||
1159 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1160 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001161 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001162 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001163#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1166 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001167 {
1168 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001169 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1170 transform->iv_dec,
1171 transform->ivlen,
1172 data, rec->data_len,
1173 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001174 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001176 return( ret );
1177 }
1178
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001179 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001180 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1182 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001183 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001184 }
Paul Bakker68884e32013-01-07 18:20:04 +01001185 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001186#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001187#if defined(MBEDTLS_GCM_C) || \
1188 defined(MBEDTLS_CCM_C) || \
1189 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001191 mode == MBEDTLS_MODE_CCM ||
1192 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001193 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001194 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001195 unsigned char *dynamic_iv;
1196 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001197
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001198 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001199 * Extract dynamic part of nonce for AEAD decryption.
1200 *
1201 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1202 * part of the IV is prepended to the ciphertext and
1203 * can be chosen freely - in particular, it need not
1204 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001205 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001206 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001207 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001208 {
1209 if( rec->data_len < dynamic_iv_len )
1210 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001211 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1212 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001213 rec->data_len,
1214 dynamic_iv_len ) );
1215 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1216 }
1217 dynamic_iv = data;
1218
1219 data += dynamic_iv_len;
1220 rec->data_offset += dynamic_iv_len;
1221 rec->data_len -= dynamic_iv_len;
1222 }
Hanno Becker17263802020-05-28 07:05:48 +01001223 else
1224 {
1225 dynamic_iv = rec->ctr;
1226 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001227
1228 /* Check that there's space for the authentication tag. */
1229 if( rec->data_len < transform->taglen )
1230 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1232 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001233 rec->data_len,
1234 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001236 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001237 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001238
Hanno Beckerdf8be222020-05-21 15:30:57 +01001239 /*
1240 * Prepare nonce from dynamic and static parts.
1241 */
Hanno Becker17263802020-05-28 07:05:48 +01001242 ssl_build_record_nonce( iv, sizeof( iv ),
1243 transform->iv_dec,
1244 transform->fixed_ivlen,
1245 dynamic_iv,
1246 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001247
Hanno Beckerdf8be222020-05-21 15:30:57 +01001248 /*
1249 * Build additional data for AEAD encryption.
1250 * This depends on the TLS version.
1251 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001252 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1253 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001254 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001255 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001256
Hanno Beckerd96a6522019-07-10 13:55:25 +01001257 /* Because of the check above, we know that there are
Shaun Case0e7791f2021-12-20 21:14:10 -08001258 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001259 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001260 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001261 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001262
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001263 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001265 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001266
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001267 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001268 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001269 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001270 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001272 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001273 data, rec->data_len + transform->taglen, /* src */
1274 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1280 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001281
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001282 return( ret );
1283 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001284 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001285
Hanno Beckerd96a6522019-07-10 13:55:25 +01001286 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001288 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1290 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001291 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001292 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001293 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001295#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001297 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001298 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001299
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 /*
Paul Bakker45829992013-01-03 14:52:21 +01001301 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001304 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1305 {
1306 /* The ciphertext is prefixed with the CBC IV. */
1307 minlen += transform->ivlen;
1308 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001309#endif
Paul Bakker45829992013-01-03 14:52:21 +01001310
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001311 /* Size considerations:
1312 *
1313 * - The CBC cipher text must not be empty and hence
1314 * at least of size transform->ivlen.
1315 *
1316 * Together with the potential IV-prefix, this explains
1317 * the first of the two checks below.
1318 *
1319 * - The record must contain a MAC, either in plain or
1320 * encrypted, depending on whether Encrypt-then-MAC
1321 * is used or not.
1322 * - If it is, the message contains the IV-prefix,
1323 * the CBC ciphertext, and the MAC.
1324 * - If it is not, the padded plaintext, and hence
1325 * the CBC ciphertext, has at least length maclen + 1
1326 * because there is at least the padding length byte.
1327 *
1328 * As the CBC ciphertext is not empty, both cases give the
1329 * lower bound minlen + maclen + 1 on the record size, which
1330 * we test for in the second check below.
1331 */
1332 if( rec->data_len < minlen + transform->ivlen ||
1333 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001334 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001335 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1336 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1337 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 "+ 1 ) ( + expl IV )", rec->data_len,
1339 transform->ivlen,
1340 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001342 }
1343
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001344 /*
1345 * Authenticate before decrypt if enabled
1346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001348 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001349 {
Hanno Becker992b6872017-11-09 18:57:39 +00001350 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001353
Hanno Beckerd96a6522019-07-10 13:55:25 +01001354 /* Update data_len in tandem with add_data.
1355 *
1356 * The subtraction is safe because of the previous check
1357 * data_len >= minlen + maclen + 1.
1358 *
1359 * Afterwards, we know that data + data_len is followed by at
1360 * least maclen Bytes, which justifies the call to
Gabor Mezei18a44942021-10-20 11:59:27 +02001361 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001362 *
1363 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001364 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001365 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1366 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001367
Hanno Beckerd96a6522019-07-10 13:55:25 +01001368 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001369 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1370 add_data_len );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001371 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1372 add_data_len );
1373 if( ret != 0 )
1374 goto hmac_failed_etm_enabled;
1375 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001376 data, rec->data_len );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001377 if( ret != 0 )
1378 goto hmac_failed_etm_enabled;
1379 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1380 if( ret != 0 )
1381 goto hmac_failed_etm_enabled;
1382 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1383 if( ret != 0 )
1384 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001385
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001386 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1387 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001388 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001390
Hanno Beckerd96a6522019-07-10 13:55:25 +01001391 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei18a44942021-10-20 11:59:27 +02001392 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +02001393 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001394 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001396 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1397 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001399 auth_done++;
Gilles Peskined8e2e832021-12-10 21:33:21 +01001400
1401 hmac_failed_etm_enabled:
1402 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1403 if( ret != 0 )
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001404 {
1405 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1406 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001407 return( ret );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001408 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001409 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001411
1412 /*
1413 * Check length sanity
1414 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001415
1416 /* We know from above that data_len > minlen >= 0,
1417 * so the following check in particular implies that
1418 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001419 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001420 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1422 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001423 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001424 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001425 }
1426
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001428 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001429 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001430 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001431 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001432 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001433 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001434 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001435
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436 data += transform->ivlen;
1437 rec->data_offset += transform->ivlen;
1438 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001439 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001440#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001441
Hanno Beckerd96a6522019-07-10 13:55:25 +01001442 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1443
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001444 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1445 transform->iv_dec, transform->ivlen,
1446 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001447 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001449 return( ret );
1450 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001451
Hanno Beckerd96a6522019-07-10 13:55:25 +01001452 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001453 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1456 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001457 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001460 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001461 {
1462 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001463 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1464 * records is equivalent to CBC decryption of the concatenation
1465 * of the records; in other words, IVs are maintained across
1466 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001467 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001468 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1469 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001470 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001471#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001472
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001473 /* Safe since data_len >= minlen + maclen + 1, so after having
1474 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001475 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1476 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001477 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001478
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001479 if( auth_done == 1 )
1480 {
Gabor Mezei18a44942021-10-20 11:59:27 +02001481 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001482 rec->data_len,
1483 padlen + 1 );
1484 correct &= mask;
1485 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001486 }
1487 else
Paul Bakker45829992013-01-03 14:52:21 +01001488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001490 if( rec->data_len < transform->maclen + padlen + 1 )
1491 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1493 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1494 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001495 rec->data_len,
1496 transform->maclen,
1497 padlen + 1 ) );
1498 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001499#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500
Gabor Mezei18a44942021-10-20 11:59:27 +02001501 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001502 rec->data_len,
1503 transform->maclen + padlen + 1 );
1504 correct &= mask;
1505 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001506 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001507
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 padlen++;
1509
1510 /* Regardless of the validity of the padding,
1511 * we have data_len >= padlen here. */
1512
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001515 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001516 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1517 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001518 * the protocol (known as part of POODLE), so we don't care if the
1519 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1524 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001525 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001526#endif
Paul Bakker45829992013-01-03 14:52:21 +01001527 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001528 }
1529 }
1530 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1532#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1533 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001535 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001536 /* The padding check involves a series of up to 256
1537 * consecutive memory reads at the end of the record
1538 * plaintext buffer. In order to hide the length and
1539 * validity of the padding, always perform exactly
1540 * `min(256,plaintext_len)` reads (but take into account
1541 * only the last `padlen` bytes for the padding check). */
1542 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001543 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001544
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001545 /* Index of first padding byte; it has been ensured above
1546 * that the subtraction is safe. */
1547 size_t const padding_idx = rec->data_len - padlen;
1548 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1549 size_t const start_idx = rec->data_len - num_checks;
1550 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001551
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001552 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001553 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001554 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001555 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001556 */
Gabor Mezei18a44942021-10-20 11:59:27 +02001557 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1558 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001559 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001560 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001561 }
Gabor Mezei18a44942021-10-20 11:59:27 +02001562 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001565 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001567#endif
Gabor Mezei18a44942021-10-20 11:59:27 +02001568 padlen &= mbedtls_ct_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001569 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001570 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1572 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001573 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1575 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001576 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001577
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001578 /* If the padding was found to be invalid, padlen == 0
1579 * and the subtraction is safe. If the padding was found valid,
1580 * padlen hasn't been changed and the previous assertion
1581 * data_len >= padlen still holds. */
1582 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001583 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001584 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001585#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1588 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001589 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001590
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001591#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001594#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001595
1596 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001597 * Authenticate if not done yet.
1598 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001599 */
Hanno Becker52344c22018-01-03 15:24:20 +00001600#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001601 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001602 {
Paul Elliottb8300282022-05-19 18:31:35 +01001603 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1604 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001605
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001606 /* If the initial value of padlen was such that
1607 * data_len < maclen + padlen + 1, then padlen
1608 * got reset to 1, and the initial check
1609 * data_len >= minlen + maclen + 1
1610 * guarantees that at this point we still
1611 * have at least data_len >= maclen.
1612 *
1613 * If the initial value of padlen was such that
1614 * data_len >= maclen + padlen + 1, then we have
1615 * subtracted either padlen + 1 (if the padding was correct)
1616 * or 0 (if the padding was incorrect) since then,
1617 * hence data_len >= maclen in any case.
1618 */
1619 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001620 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1621 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001623#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001624 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001625 {
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001626 ret = ssl_mac( &transform->md_ctx_dec,
1627 transform->mac_dec,
1628 data, rec->data_len,
1629 rec->ctr, rec->type,
1630 mac_expect );
1631 if( ret != 0 )
1632 {
1633 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_mac", ret );
1634 goto hmac_failed_etm_disabled;
1635 }
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001636 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001637 }
1638 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1640#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1641 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001642 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001643 {
1644 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001645 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001646 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001647 *
1648 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001649 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001650 *
1651 * Note that max_len + maclen is never more than the buffer
1652 * length, as we previously did in_msglen -= maclen too.
1653 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001654 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001655 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1656
Gabor Mezei18a44942021-10-20 11:59:27 +02001657 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001658 add_data, add_data_len,
1659 data, rec->data_len, min_len, max_len,
1660 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001661 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001662 {
Gabor Mezei2dcccbf2021-11-16 13:34:05 +01001663 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001664 goto hmac_failed_etm_disabled;
Gilles Peskine20b44082018-05-29 14:06:49 +02001665 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001666
Gabor Mezei18a44942021-10-20 11:59:27 +02001667 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001668 rec->data_len,
1669 min_len, max_len,
1670 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001671 }
1672 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1674 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001675 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1677 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001678 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001679
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001680#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001681 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001682 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001683#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001684
Gabor Mezei18a44942021-10-20 11:59:27 +02001685 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +02001686 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001688#if defined(MBEDTLS_SSL_DEBUG_ALL)
1689 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001690#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001691 correct = 0;
1692 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001693 auth_done++;
Gilles Peskined8e2e832021-12-10 21:33:21 +01001694
1695 hmac_failed_etm_disabled:
1696 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1697 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1698 if( ret != 0 )
1699 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001700 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001701
1702 /*
1703 * Finally check the correct flag
1704 */
1705 if( correct == 0 )
1706 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001707#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001708
1709 /* Make extra sure authentication was performed, exactly once */
1710 if( auth_done != 1 )
1711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1713 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001714 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001715
Hanno Beckerccc13d02020-05-04 12:30:04 +01001716#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1717 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1718 {
1719 /* Remove inner padding and infer true content type. */
1720 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1721 &rec->type );
1722
1723 if( ret != 0 )
1724 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1725 }
1726#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1727
Hanno Beckera0e20d02019-05-15 14:03:01 +01001728#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001729 if( rec->cid_len != 0 )
1730 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001731 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1732 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001733 if( ret != 0 )
1734 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1735 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001736#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001739
1740 return( 0 );
1741}
1742
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001743#undef MAC_NONE
1744#undef MAC_PLAINTEXT
1745#undef MAC_CIPHERTEXT
1746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001747#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001748/*
1749 * Compression/decompression functions
1750 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02001751MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001753{
Janos Follath865b3eb2019-12-16 11:46:15 +00001754 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001755 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001756 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001757 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001758 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001759#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1760 size_t out_buf_len = ssl->out_buf_len;
1761#else
1762 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1763#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001766
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001767 if( len_pre == 0 )
1768 return( 0 );
1769
Paul Bakker2770fbd2012-07-03 13:30:23 +00001770 memcpy( msg_pre, ssl->out_msg, len_pre );
1771
Paul Elliottd48d5c62021-01-07 14:47:05 +00001772 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001773 ssl->out_msglen ) );
1774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001776 ssl->out_msg, ssl->out_msglen );
1777
Paul Bakker48916f92012-09-16 19:57:18 +00001778 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1779 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1780 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001781 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001782
Paul Bakker48916f92012-09-16 19:57:18 +00001783 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001784 if( ret != Z_OK )
1785 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1787 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001788 }
1789
Darryl Greenb33cc762019-11-28 14:29:44 +00001790 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001791 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001792
Paul Elliottd48d5c62021-01-07 14:47:05 +00001793 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794 ssl->out_msglen ) );
1795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001797 ssl->out_msg, ssl->out_msglen );
1798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001800
1801 return( 0 );
1802}
1803
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02001804MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001806{
Janos Follath865b3eb2019-12-16 11:46:15 +00001807 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001808 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001809 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001810 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001811 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001812#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1813 size_t in_buf_len = ssl->in_buf_len;
1814#else
1815 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1816#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001819
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001820 if( len_pre == 0 )
1821 return( 0 );
1822
Paul Bakker2770fbd2012-07-03 13:30:23 +00001823 memcpy( msg_pre, ssl->in_msg, len_pre );
1824
Paul Elliottd48d5c62021-01-07 14:47:05 +00001825 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001826 ssl->in_msglen ) );
1827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829 ssl->in_msg, ssl->in_msglen );
1830
Paul Bakker48916f92012-09-16 19:57:18 +00001831 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1832 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1833 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001834 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835
Paul Bakker48916f92012-09-16 19:57:18 +00001836 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001837 if( ret != Z_OK )
1838 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1840 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001841 }
1842
Darryl Greenb33cc762019-11-28 14:29:44 +00001843 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001844 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001845
Paul Elliottd48d5c62021-01-07 14:47:05 +00001846 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001847 ssl->in_msglen ) );
1848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001850 ssl->in_msg, ssl->in_msglen );
1851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001853
1854 return( 0 );
1855}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001857
Paul Bakker5121ce52009-01-03 21:22:43 +00001858/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001859 * Fill the input message buffer by appending data to it.
1860 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001861 *
1862 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1863 * available (from this read and/or a previous one). Otherwise, an error code
1864 * is returned (possibly EOF or WANT_READ).
1865 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001866 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1867 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1868 * since we always read a whole datagram at once.
1869 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001870 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001871 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001874{
Janos Follath865b3eb2019-12-16 11:46:15 +00001875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001876 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001877#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1878 size_t in_buf_len = ssl->in_buf_len;
1879#else
1880 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1881#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001884
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001885 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1886 {
Jan Brucknera084c932022-11-07 15:28:49 +01001887 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001889 }
1890
Darryl Greenb33cc762019-11-28 14:29:44 +00001891 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001892 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1894 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001895 }
1896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001899 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001900 uint32_t timeout;
1901
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001902 /*
1903 * The point is, we need to always read a full datagram at once, so we
1904 * sometimes read more then requested, and handle the additional data.
1905 * It could be the rest of the current record (while fetching the
1906 * header) and/or some other records in the same datagram.
1907 */
1908
1909 /*
1910 * Move to the next record in the already read datagram if applicable
1911 */
1912 if( ssl->next_record_offset != 0 )
1913 {
1914 if( ssl->in_left < ssl->next_record_offset )
1915 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1917 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001918 }
1919
1920 ssl->in_left -= ssl->next_record_offset;
1921
1922 if( ssl->in_left != 0 )
1923 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1925 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001926 ssl->next_record_offset ) );
1927 memmove( ssl->in_hdr,
1928 ssl->in_hdr + ssl->next_record_offset,
1929 ssl->in_left );
1930 }
1931
1932 ssl->next_record_offset = 0;
1933 }
1934
Paul Elliottd48d5c62021-01-07 14:47:05 +00001935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1936 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001937 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938
1939 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001940 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941 */
1942 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001943 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001945 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001946 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001947
1948 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001949 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001950 * are not at the beginning of a new record, the caller did something
1951 * wrong.
1952 */
1953 if( ssl->in_left != 0 )
1954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1956 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001957 }
1958
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001959 /*
1960 * Don't even try to read if time's out already.
1961 * This avoids by-passing the timer when repeatedly receiving messages
1962 * that will end up being dropped.
1963 */
Hanno Becker7876d122020-02-05 10:39:31 +00001964 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001965 {
1966 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001967 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001968 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001969 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001970 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001971 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001974 timeout = ssl->handshake->retransmit_timeout;
1975 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001976 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001977
Paul Elliott9f352112020-12-09 14:55:45 +00001978 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001979
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001980 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001981 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1982 timeout );
1983 else
1984 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001987
1988 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001990 }
1991
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001992 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001993 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001995 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001998 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001999 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002002 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002003 }
2004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002008 return( ret );
2009 }
2010
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002011 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002012 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002014 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002016 {
Hanno Becker786300f2020-02-05 10:46:40 +00002017 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002018 {
Hanno Becker786300f2020-02-05 10:46:40 +00002019 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2020 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002021 return( ret );
2022 }
2023
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002024 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002027 }
2028
Paul Bakker5121ce52009-01-03 21:22:43 +00002029 if( ret < 0 )
2030 return( ret );
2031
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002032 ssl->in_left = ret;
2033 }
2034 else
2035#endif
2036 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2038 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002039 ssl->in_left, nb_want ) );
2040
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002041 while( ssl->in_left < nb_want )
2042 {
2043 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002044
Hanno Becker7876d122020-02-05 10:39:31 +00002045 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002046 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2047 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002048 {
2049 if( ssl->f_recv_timeout != NULL )
2050 {
2051 ret = ssl->f_recv_timeout( ssl->p_bio,
2052 ssl->in_hdr + ssl->in_left, len,
2053 ssl->conf->read_timeout );
2054 }
2055 else
2056 {
2057 ret = ssl->f_recv( ssl->p_bio,
2058 ssl->in_hdr + ssl->in_left, len );
2059 }
2060 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002061
Paul Elliottd48d5c62021-01-07 14:47:05 +00002062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2063 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002064 ssl->in_left, nb_want ) );
2065 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002066
2067 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002069
2070 if( ret < 0 )
2071 return( ret );
2072
makise-homuraaf9513b2020-08-24 18:26:27 +03002073 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002074 {
Darryl Green11999bb2018-03-13 15:22:58 +00002075 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002076 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002077 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002078 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2079 }
2080
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002081 ssl->in_left += ret;
2082 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002083 }
2084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002086
2087 return( 0 );
2088}
2089
2090/*
2091 * Flush any data not yet written
2092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002094{
Janos Follath865b3eb2019-12-16 11:46:15 +00002095 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002096 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002099
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002100 if( ssl->f_send == NULL )
2101 {
Jan Brucknera084c932022-11-07 15:28:49 +01002102 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002104 }
2105
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002106 /* Avoid incrementing counter if data is flushed */
2107 if( ssl->out_left == 0 )
2108 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002110 return( 0 );
2111 }
2112
Paul Bakker5121ce52009-01-03 21:22:43 +00002113 while( ssl->out_left > 0 )
2114 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2116 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002117 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002118
Hanno Becker2b1e3542018-08-06 11:19:13 +01002119 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002120 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
2124 if( ret <= 0 )
2125 return( ret );
2126
makise-homuraaf9513b2020-08-24 18:26:27 +03002127 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002128 {
Darryl Green11999bb2018-03-13 15:22:58 +00002129 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002130 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002131 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002132 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2133 }
2134
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 ssl->out_left -= ret;
2136 }
2137
Hanno Becker2b1e3542018-08-06 11:19:13 +01002138#if defined(MBEDTLS_SSL_PROTO_DTLS)
2139 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002140 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002141 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002142 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002143 else
2144#endif
2145 {
2146 ssl->out_hdr = ssl->out_buf + 8;
2147 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002148 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002151
2152 return( 0 );
2153}
2154
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002155/*
2156 * Functions to handle the DTLS retransmission state machine
2157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159/*
2160 * Append current handshake message to current outgoing flight
2161 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02002162MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002164{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002166 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2167 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2168 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002169
2170 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002171 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002172 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002173 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002175 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002176 }
2177
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002178 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002179 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002180 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2181 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002183 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184 }
2185
2186 /* Copy current handshake message with headers */
2187 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2188 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002189 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190 msg->next = NULL;
2191
2192 /* Append to the current flight */
2193 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002194 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002195 else
2196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002198 while( cur->next != NULL )
2199 cur = cur->next;
2200 cur->next = msg;
2201 }
2202
Hanno Becker3b235902018-08-06 09:54:53 +01002203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204 return( 0 );
2205}
2206
2207/*
2208 * Free the current flight of handshake messages
2209 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002210void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002211{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212 mbedtls_ssl_flight_item *cur = flight;
2213 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002214
2215 while( cur != NULL )
2216 {
2217 next = cur->next;
2218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219 mbedtls_free( cur->p );
2220 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002221
2222 cur = next;
2223 }
2224}
2225
2226/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227 * Swap transform_out and out_ctr with the alternative ones
2228 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02002229MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002230static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002231{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002233 unsigned char tmp_out_ctr[8];
2234
2235 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2236 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002238 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002239 }
2240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002242
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002243 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002244 tmp_transform = ssl->transform_out;
2245 ssl->transform_out = ssl->handshake->alt_transform_out;
2246 ssl->handshake->alt_transform_out = tmp_transform;
2247
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002248 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002249 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2250 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002251 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002252
2253 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002254 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002256#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2257 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002258 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002259 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2260 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002261 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2263 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002264 }
2265 }
2266#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002267
2268 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002269}
2270
2271/*
2272 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002273 */
2274int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2275{
2276 int ret = 0;
2277
2278 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2279
2280 ret = mbedtls_ssl_flight_transmit( ssl );
2281
2282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2283
2284 return( ret );
2285}
2286
2287/*
2288 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002289 *
2290 * Need to remember the current message in case flush_output returns
2291 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002292 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002293 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002294int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002295{
Janos Follath865b3eb2019-12-16 11:46:15 +00002296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002297 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002300 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002301 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002302
2303 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002304 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002305 ret = ssl_swap_epochs( ssl );
2306 if( ret != 0 )
2307 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002310 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002311
2312 while( ssl->handshake->cur_msg != NULL )
2313 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002314 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002315 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002316
Hanno Beckere1dcb032018-08-17 16:47:58 +01002317 int const is_finished =
2318 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2319 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2320
Hanno Becker04da1892018-08-14 13:22:10 +01002321 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2322 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2323
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002324 /* Swap epochs before sending Finished: we can't do it after
2325 * sending ChangeCipherSpec, in case write returns WANT_READ.
2326 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002327 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002328 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002329 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002330 ret = ssl_swap_epochs( ssl );
2331 if( ret != 0 )
2332 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002333 }
2334
Hanno Becker67bc7c32018-08-06 11:33:50 +01002335 ret = ssl_get_remaining_payload_in_datagram( ssl );
2336 if( ret < 0 )
2337 return( ret );
2338 max_frag_len = (size_t) ret;
2339
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002340 /* CCS is copied as is, while HS messages may need fragmentation */
2341 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2342 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002343 if( max_frag_len == 0 )
2344 {
2345 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2346 return( ret );
2347
2348 continue;
2349 }
2350
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002351 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002352 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002353 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002354
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002355 /* Update position inside current message */
2356 ssl->handshake->cur_msg_p += cur->len;
2357 }
2358 else
2359 {
2360 const unsigned char * const p = ssl->handshake->cur_msg_p;
2361 const size_t hs_len = cur->len - 12;
2362 const size_t frag_off = p - ( cur->p + 12 );
2363 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002364 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002365
Hanno Beckere1dcb032018-08-17 16:47:58 +01002366 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002367 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002368 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002369 {
2370 ret = ssl_swap_epochs( ssl );
2371 if( ret != 0 )
2372 return( ret );
2373 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002374
Hanno Becker67bc7c32018-08-06 11:33:50 +01002375 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2376 return( ret );
2377
2378 continue;
2379 }
2380 max_hs_frag_len = max_frag_len - 12;
2381
2382 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2383 max_hs_frag_len : rem_len;
2384
2385 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002386 {
2387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002388 (unsigned) cur_hs_frag_len,
2389 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002390 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002391
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002392 /* Messages are stored with handshake headers as if not fragmented,
2393 * copy beginning of headers then fill fragmentation fields.
2394 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2395 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002396
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002397 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2398 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2399 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002401 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2402 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2403 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002404
2405 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2406
Hanno Becker3f7b9732018-08-28 09:53:25 +01002407 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002408 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2409 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002410 ssl->out_msgtype = cur->type;
2411
2412 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002413 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002414 }
2415
2416 /* If done with the current message move to the next one if any */
2417 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2418 {
2419 if( cur->next != NULL )
2420 {
2421 ssl->handshake->cur_msg = cur->next;
2422 ssl->handshake->cur_msg_p = cur->next->p + 12;
2423 }
2424 else
2425 {
2426 ssl->handshake->cur_msg = NULL;
2427 ssl->handshake->cur_msg_p = NULL;
2428 }
2429 }
2430
2431 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002432 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002433 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002435 return( ret );
2436 }
2437 }
2438
Hanno Becker67bc7c32018-08-06 11:33:50 +01002439 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2440 return( ret );
2441
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002442 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2444 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002445 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002448 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002449 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002450
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002452
2453 return( 0 );
2454}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002455
2456/*
2457 * To be called when the last message of an incoming flight is received.
2458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002460{
2461 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002462 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002463 ssl->handshake->flight = NULL;
2464 ssl->handshake->cur_msg = NULL;
2465
2466 /* The next incoming flight will start with this msg_seq */
2467 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2468
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002469 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002470 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002471
Hanno Becker0271f962018-08-16 13:23:47 +01002472 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002473 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002474
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002475 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002476 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2479 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002482 }
2483 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002485}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002486
2487/*
2488 * To be called when the last message of an outgoing flight is send.
2489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002491{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002492 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002493 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2496 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002499 }
2500 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002502}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002504
Paul Bakker5121ce52009-01-03 21:22:43 +00002505/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002506 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002507 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508
2509/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002510 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002511 *
2512 * - fill in handshake headers
2513 * - update handshake checksum
2514 * - DTLS: save message for resending
2515 * - then pass to the record layer
2516 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517 * DTLS: except for HelloRequest, messages are only queued, and will only be
2518 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002519 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520 * Inputs:
2521 * - ssl->out_msglen: 4 + actual handshake message len
2522 * (4 is the size of handshake headers for TLS)
2523 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2524 * - ssl->out_msg + 4: the handshake message body
2525 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002526 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002527 * - ssl->out_msglen: the length of the record contents
2528 * (including handshake headers but excluding record headers)
2529 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002530 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002531int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002532{
Janos Follath865b3eb2019-12-16 11:46:15 +00002533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002534 const size_t hs_len = ssl->out_msglen - 4;
2535 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002536
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2538
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002539 /*
2540 * Sanity checks
2541 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002542 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002543 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2544 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002545 /* In SSLv3, the client might send a NoCertificate alert. */
2546#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2547 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2548 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2549 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2550#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2551 {
2552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2553 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2554 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002555 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002556
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002557 /* Whenever we send anything different from a
2558 * HelloRequest we should be in a handshake - double check. */
2559 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2560 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002561 ssl->handshake == NULL )
2562 {
2563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2564 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2565 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002566
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002568 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002569 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002571 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2573 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002574 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002575#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002576
Hanno Beckerb50a2532018-08-06 11:52:54 +01002577 /* Double-check that we did not exceed the bounds
2578 * of the outgoing record buffer.
2579 * This should never fail as the various message
2580 * writing functions must obey the bounds of the
2581 * outgoing record buffer, but better be safe.
2582 *
2583 * Note: We deliberately do not check for the MTU or MFL here.
2584 */
2585 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2586 {
2587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002588 "size %" MBEDTLS_PRINTF_SIZET
2589 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002590 ssl->out_msglen,
2591 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002592 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2593 }
2594
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002595 /*
2596 * Fill handshake headers
2597 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002599 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002600 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2601 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2602 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002603
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002604 /*
2605 * DTLS has additional fields in the Handshake layer,
2606 * between the length field and the actual payload:
2607 * uint16 message_seq;
2608 * uint24 fragment_offset;
2609 * uint24 fragment_length;
2610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002612 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002613 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002614 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002615 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002616 {
2617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002618 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002619 hs_len,
2620 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002621 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2622 }
2623
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002624 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002625 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002626
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002627 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002628 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002629 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002630 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002631 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002632 }
2633 else
2634 {
2635 ssl->out_msg[4] = 0;
2636 ssl->out_msg[5] = 0;
2637 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002638
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002639 /* Handshake hashes are computed without fragmentation,
2640 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002641 memset( ssl->out_msg + 6, 0x00, 3 );
2642 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002643 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002645
Hanno Becker0207e532018-08-28 10:28:28 +01002646 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002647 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2648 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002649 }
2650
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002651 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002653 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002654 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2655 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002656 {
2657 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002660 return( ret );
2661 }
2662 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002663 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002664#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002665 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002666 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002667 {
2668 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2669 return( ret );
2670 }
2671 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002672
2673 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2674
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002675 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002676}
2677
2678/*
2679 * Record layer functions
2680 */
2681
2682/*
2683 * Write current record.
2684 *
2685 * Uses:
2686 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2687 * - ssl->out_msglen: length of the record content (excl headers)
2688 * - ssl->out_msg: record content
2689 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002690int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002691{
2692 int ret, done = 0;
2693 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002694 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002695
2696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002699 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002701 {
2702 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2703 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002705 return( ret );
2706 }
2707
2708 len = ssl->out_msglen;
2709 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2713 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 ret = mbedtls_ssl_hw_record_write( ssl );
2718 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2721 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002722 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002723
2724 if( ret == 0 )
2725 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002726 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002728 if( !done )
2729 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002730 unsigned i;
2731 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002732#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2733 size_t out_buf_len = ssl->out_buf_len;
2734#else
2735 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2736#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002737 /* Skip writing the record content type to after the encryption,
2738 * as it may change when using the CID extension. */
2739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002741 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002742
Hanno Becker19859472018-08-06 09:40:20 +01002743 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002744 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002745
Paul Bakker48916f92012-09-16 19:57:18 +00002746 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002747 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002748 mbedtls_record rec;
2749
2750 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002751 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002752 rec.data_len = ssl->out_msglen;
2753 rec.data_offset = ssl->out_msg - rec.buf;
2754
2755 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2756 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2757 ssl->conf->transport, rec.ver );
2758 rec.type = ssl->out_msgtype;
2759
Hanno Beckera0e20d02019-05-15 14:03:01 +01002760#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002761 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002762 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002763#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002764
Hanno Beckera18d1322018-01-03 14:27:32 +00002765 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002766 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002767 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002769 return( ret );
2770 }
2771
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002772 if( rec.data_offset != 0 )
2773 {
2774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2775 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2776 }
2777
Hanno Becker6430faf2019-05-08 11:57:13 +01002778 /* Update the record content type and CID. */
2779 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002780#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002781 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002782#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002783 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002784 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002785 }
2786
Hanno Becker5903de42019-05-03 14:46:38 +01002787 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002788
2789#if defined(MBEDTLS_SSL_PROTO_DTLS)
2790 /* In case of DTLS, double-check that we don't exceed
2791 * the remaining space in the datagram. */
2792 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2793 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002794 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002795 if( ret < 0 )
2796 return( ret );
2797
2798 if( protected_record_size > (size_t) ret )
2799 {
2800 /* Should never happen */
2801 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2802 }
2803 }
2804#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002805
Hanno Becker6430faf2019-05-08 11:57:13 +01002806 /* Now write the potentially updated record content type. */
2807 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2808
Paul Elliott9f352112020-12-09 14:55:45 +00002809 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002810 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002811 ssl->out_hdr[0], ssl->out_hdr[1],
2812 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002815 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002816
2817 ssl->out_left += protected_record_size;
2818 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002819 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002820
Hanno Beckerdd772292020-02-05 10:38:31 +00002821 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002822 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2823 break;
2824
2825 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002826 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002827 {
2828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2829 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2830 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002831 }
2832
Hanno Becker67bc7c32018-08-06 11:33:50 +01002833#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002834 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2835 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002836 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002837 size_t remaining;
2838 ret = ssl_get_remaining_payload_in_datagram( ssl );
2839 if( ret < 0 )
2840 {
2841 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2842 ret );
2843 return( ret );
2844 }
2845
2846 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002847 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002848 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002849 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002850 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002851 else
2852 {
Hanno Becker513815a2018-08-20 11:56:09 +01002853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002854 }
2855 }
2856#endif /* MBEDTLS_SSL_PROTO_DTLS */
2857
2858 if( ( flush == SSL_FORCE_FLUSH ) &&
2859 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002860 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002862 return( ret );
2863 }
2864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002866
2867 return( 0 );
2868}
2869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002871
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02002872MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere25e3b72018-08-16 09:30:53 +01002873static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2874{
2875 if( ssl->in_msglen < ssl->in_hslen ||
2876 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2877 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2878 {
2879 return( 1 );
2880 }
2881 return( 0 );
2882}
Hanno Becker44650b72018-08-16 12:51:11 +01002883
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002884static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002885{
2886 return( ( ssl->in_msg[9] << 16 ) |
2887 ( ssl->in_msg[10] << 8 ) |
2888 ssl->in_msg[11] );
2889}
2890
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002891static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002892{
2893 return( ( ssl->in_msg[6] << 16 ) |
2894 ( ssl->in_msg[7] << 8 ) |
2895 ssl->in_msg[8] );
2896}
2897
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02002898MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002899static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002900{
2901 uint32_t msg_len, frag_off, frag_len;
2902
2903 msg_len = ssl_get_hs_total_len( ssl );
2904 frag_off = ssl_get_hs_frag_off( ssl );
2905 frag_len = ssl_get_hs_frag_len( ssl );
2906
2907 if( frag_off > msg_len )
2908 return( -1 );
2909
2910 if( frag_len > msg_len - frag_off )
2911 return( -1 );
2912
2913 if( frag_len + 12 > ssl->in_msglen )
2914 return( -1 );
2915
2916 return( 0 );
2917}
2918
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002919/*
2920 * Mark bits in bitmask (used for DTLS HS reassembly)
2921 */
2922static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2923{
2924 unsigned int start_bits, end_bits;
2925
2926 start_bits = 8 - ( offset % 8 );
2927 if( start_bits != 8 )
2928 {
2929 size_t first_byte_idx = offset / 8;
2930
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002931 /* Special case */
2932 if( len <= start_bits )
2933 {
2934 for( ; len != 0; len-- )
2935 mask[first_byte_idx] |= 1 << ( start_bits - len );
2936
2937 /* Avoid potential issues with offset or len becoming invalid */
2938 return;
2939 }
2940
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002941 offset += start_bits; /* Now offset % 8 == 0 */
2942 len -= start_bits;
2943
2944 for( ; start_bits != 0; start_bits-- )
2945 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2946 }
2947
2948 end_bits = len % 8;
2949 if( end_bits != 0 )
2950 {
2951 size_t last_byte_idx = ( offset + len ) / 8;
2952
2953 len -= end_bits; /* Now len % 8 == 0 */
2954
2955 for( ; end_bits != 0; end_bits-- )
2956 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2957 }
2958
2959 memset( mask + offset / 8, 0xFF, len / 8 );
2960}
2961
2962/*
2963 * Check that bitmask is full
2964 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02002965MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002966static int ssl_bitmask_check( unsigned char *mask, size_t len )
2967{
2968 size_t i;
2969
2970 for( i = 0; i < len / 8; i++ )
2971 if( mask[i] != 0xFF )
2972 return( -1 );
2973
2974 for( i = 0; i < len % 8; i++ )
2975 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2976 return( -1 );
2977
2978 return( 0 );
2979}
2980
Hanno Becker56e205e2018-08-16 09:06:12 +01002981/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002982static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002983 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002984{
Hanno Becker56e205e2018-08-16 09:06:12 +01002985 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002986
Hanno Becker56e205e2018-08-16 09:06:12 +01002987 alloc_len = 12; /* Handshake header */
2988 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002989
Hanno Beckerd07df862018-08-16 09:14:58 +01002990 if( add_bitmap )
2991 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002992
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002993 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002994}
Hanno Becker56e205e2018-08-16 09:06:12 +01002995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002997
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002998static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002999{
3000 return( ( ssl->in_msg[1] << 16 ) |
3001 ( ssl->in_msg[2] << 8 ) |
3002 ssl->in_msg[3] );
3003}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003004
Simon Butcher99000142016-10-13 17:21:01 +01003005int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003006{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003008 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003009 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003010 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003011 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003012 }
3013
Hanno Becker12555c62018-08-16 12:47:53 +01003014 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003017 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003018 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003021 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003022 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003024 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003025
Hanno Becker44650b72018-08-16 12:51:11 +01003026 if( ssl_check_hs_header( ssl ) != 0 )
3027 {
3028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3029 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3030 }
3031
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003032 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003033 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3034 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3035 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3036 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003037 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003038 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3039 {
3040 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3041 recv_msg_seq,
3042 ssl->handshake->in_msg_seq ) );
3043 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3044 }
3045
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003046 /* Retransmit only on last message from previous flight, to avoid
3047 * too many retransmissions.
3048 * Besides, No sane server ever retransmits HelloVerifyRequest */
3049 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003051 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003053 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003054 recv_msg_seq,
3055 ssl->handshake->in_flight_start_seq ) );
3056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003060 return( ret );
3061 }
3062 }
3063 else
3064 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003066 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003067 recv_msg_seq,
3068 ssl->handshake->in_msg_seq ) );
3069 }
3070
Hanno Becker90333da2017-10-10 11:27:13 +01003071 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003072 }
3073 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003074
Hanno Becker6d97ef52018-08-16 13:09:04 +01003075 /* Message reassembly is handled alongside buffering of future
3076 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003077 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003078 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003079 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003080 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003082 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003083 }
3084 }
3085 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003086#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003087 /* With TLS we don't handle fragmentation (for now) */
3088 if( ssl->in_msglen < ssl->in_hslen )
3089 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3091 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003092 }
3093
Simon Butcher99000142016-10-13 17:21:01 +01003094 return( 0 );
3095}
3096
3097void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3098{
Hanno Becker0271f962018-08-16 13:23:47 +01003099 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003100
Hanno Becker0271f962018-08-16 13:23:47 +01003101 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003102 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003103 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003104 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003105
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003106 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003108 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003109 ssl->handshake != NULL )
3110 {
Hanno Becker0271f962018-08-16 13:23:47 +01003111 unsigned offset;
3112 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003113
Hanno Becker0271f962018-08-16 13:23:47 +01003114 /* Increment handshake sequence number */
3115 hs->in_msg_seq++;
3116
3117 /*
3118 * Clear up handshake buffering and reassembly structure.
3119 */
3120
3121 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003122 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003123
3124 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003125 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3126 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003127 offset++, hs_buf++ )
3128 {
3129 *hs_buf = *(hs_buf + 1);
3130 }
3131
3132 /* Create a fresh last entry */
3133 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003134 }
3135#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003136}
3137
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003138/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139 * DTLS anti-replay: RFC 6347 4.1.2.6
3140 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003141 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3142 * Bit n is set iff record number in_window_top - n has been seen.
3143 *
3144 * Usually, in_window_top is the last record number seen and the lsb of
3145 * in_window is set. The only exception is the initial state (record number 0
3146 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003149void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003150{
3151 ssl->in_window_top = 0;
3152 ssl->in_window = 0;
3153}
3154
3155static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3156{
3157 return( ( (uint64_t) buf[0] << 40 ) |
3158 ( (uint64_t) buf[1] << 32 ) |
3159 ( (uint64_t) buf[2] << 24 ) |
3160 ( (uint64_t) buf[3] << 16 ) |
3161 ( (uint64_t) buf[4] << 8 ) |
3162 ( (uint64_t) buf[5] ) );
3163}
3164
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003165MBEDTLS_CHECK_RETURN_CRITICAL
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003166static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3167{
Janos Follath865b3eb2019-12-16 11:46:15 +00003168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003169 unsigned char *original_in_ctr;
3170
3171 // save original in_ctr
3172 original_in_ctr = ssl->in_ctr;
3173
3174 // use counter from record
3175 ssl->in_ctr = record_in_ctr;
3176
3177 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3178
3179 // restore the counter
3180 ssl->in_ctr = original_in_ctr;
3181
3182 return ret;
3183}
3184
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003185/*
3186 * Return 0 if sequence number is acceptable, -1 otherwise
3187 */
Hanno Becker0183d692019-07-12 08:50:37 +01003188int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003189{
3190 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3191 uint64_t bit;
3192
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003193 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003194 return( 0 );
3195
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003196 if( rec_seqnum > ssl->in_window_top )
3197 return( 0 );
3198
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003199 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003200
3201 if( bit >= 64 )
3202 return( -1 );
3203
3204 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3205 return( -1 );
3206
3207 return( 0 );
3208}
3209
3210/*
3211 * Update replay window on new validated record
3212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003214{
3215 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3216
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003217 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003218 return;
3219
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003220 if( rec_seqnum > ssl->in_window_top )
3221 {
3222 /* Update window_top and the contents of the window */
3223 uint64_t shift = rec_seqnum - ssl->in_window_top;
3224
3225 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003226 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003227 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003228 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003229 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003230 ssl->in_window |= 1;
3231 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003232
3233 ssl->in_window_top = rec_seqnum;
3234 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003235 else
3236 {
3237 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003238 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003239
3240 if( bit < 64 ) /* Always true, but be extra sure */
3241 ssl->in_window |= (uint64_t) 1 << bit;
3242 }
3243}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003245
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003246#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003247/*
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003248 * Check if a datagram looks like a ClientHello with a valid cookie,
3249 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003250 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003251 *
3252 * - if cookie is valid, return 0
3253 * - if ClientHello looks superficially valid but cookie is not,
3254 * fill obuf and set olen, then
3255 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3256 * - otherwise return a specific error code
3257 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003258MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek33f41a82022-06-08 11:47:33 -04003259MBEDTLS_STATIC_TESTABLE
3260int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003261 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003262 const unsigned char *cli_id, size_t cli_id_len,
3263 const unsigned char *in, size_t in_len,
3264 unsigned char *obuf, size_t buf_len, size_t *olen )
3265{
3266 size_t sid_len, cookie_len;
3267 unsigned char *p;
3268
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003269 /*
3270 * Structure of ClientHello with record and handshake headers,
3271 * and expected values. We don't need to check a lot, more checks will be
3272 * done when actually parsing the ClientHello - skipping those checks
3273 * avoids code duplication and does not make cookie forging any easier.
3274 *
3275 * 0-0 ContentType type; copied, must be handshake
3276 * 1-2 ProtocolVersion version; copied
3277 * 3-4 uint16 epoch; copied, must be 0
3278 * 5-10 uint48 sequence_number; copied
3279 * 11-12 uint16 length; (ignored)
3280 *
3281 * 13-13 HandshakeType msg_type; (ignored)
3282 * 14-16 uint24 length; (ignored)
3283 * 17-18 uint16 message_seq; copied
3284 * 19-21 uint24 fragment_offset; copied, must be 0
3285 * 22-24 uint24 fragment_length; (ignored)
3286 *
3287 * 25-26 ProtocolVersion client_version; (ignored)
3288 * 27-58 Random random; (ignored)
3289 * 59-xx SessionID session_id; 1 byte len + sid_len content
3290 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3291 * ...
3292 *
3293 * Minimum length is 61 bytes.
3294 */
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003295 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3296 (unsigned) in_len ) );
3297 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3298 if( in_len < 61 )
3299 {
3300 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3301 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3302 }
3303 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003304 in[3] != 0 || in[4] != 0 ||
3305 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3306 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003307 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3308 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
3309 in[0],
3310 (unsigned) in[3] << 8 | in[4],
3311 (unsigned) in[19] << 16 | in[20] << 8 | in[21] ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003312 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3313 }
3314
3315 sid_len = in[59];
Andrzej Kureke5af9fa2022-06-06 14:42:41 -04003316 if( 59 + 1 + sid_len + 1 > in_len )
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003317 {
3318 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3319 (unsigned) sid_len,
3320 (unsigned) in_len - 61 ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003321 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003322 }
3323 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3324 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003325
3326 cookie_len = in[60 + sid_len];
Andrzej Kureke5af9fa2022-06-06 14:42:41 -04003327 if( 59 + 1 + sid_len + 1 + cookie_len > in_len )
3328 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003329 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3330 (unsigned) cookie_len,
Andrzej Kureke5af9fa2022-06-06 14:42:41 -04003331 (unsigned) ( in_len - sid_len - 61 ) ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003332 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003333 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003334
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003335 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3336 in + sid_len + 61, cookie_len );
3337 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3338 in + sid_len + 61, cookie_len,
3339 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003340 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003341 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003342 return( 0 );
3343 }
3344
3345 /*
3346 * If we get here, we've got an invalid cookie, let's prepare HVR.
3347 *
3348 * 0-0 ContentType type; copied
3349 * 1-2 ProtocolVersion version; copied
3350 * 3-4 uint16 epoch; copied
3351 * 5-10 uint48 sequence_number; copied
3352 * 11-12 uint16 length; olen - 13
3353 *
3354 * 13-13 HandshakeType msg_type; hello_verify_request
3355 * 14-16 uint24 length; olen - 25
3356 * 17-18 uint16 message_seq; copied
3357 * 19-21 uint24 fragment_offset; copied
3358 * 22-24 uint24 fragment_length; olen - 25
3359 *
3360 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3361 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3362 *
3363 * Minimum length is 28.
3364 */
3365 if( buf_len < 28 )
3366 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3367
3368 /* Copy most fields and adapt others */
3369 memcpy( obuf, in, 25 );
3370 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3371 obuf[25] = 0xfe;
3372 obuf[26] = 0xff;
3373
3374 /* Generate and write actual cookie */
3375 p = obuf + 28;
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003376 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3377 &p, obuf + buf_len,
3378 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003379 {
3380 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3381 }
3382
3383 *olen = p - obuf;
3384
3385 /* Go back and fill length fields */
3386 obuf[27] = (unsigned char)( *olen - 28 );
3387
Joe Subbianiad1115a2021-07-16 14:27:50 +01003388 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3389 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3390 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003391
Joe Subbianic54e9082021-07-19 11:56:54 +01003392 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003393
3394 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3395}
3396
3397/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003398 * Handle possible client reconnect with the same UDP quadruplet
3399 * (RFC 6347 Section 4.2.8).
3400 *
3401 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3402 * that looks like a ClientHello.
3403 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003404 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003405 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003406 * - if the input looks like a ClientHello with a valid cookie,
3407 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003408 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003409 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003410 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003411 * This function is called (through ssl_check_client_reconnect()) when an
3412 * unexpected record is found in ssl_get_next_record(), which will discard the
3413 * record if we return 0, and bubble up the return value otherwise (this
3414 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3415 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003416 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003417MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003418static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3419{
Janos Follath865b3eb2019-12-16 11:46:15 +00003420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003421 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003422
Hanno Becker2fddd372019-07-10 14:37:41 +01003423 if( ssl->conf->f_cookie_write == NULL ||
3424 ssl->conf->f_cookie_check == NULL )
3425 {
3426 /* If we can't use cookies to verify reachability of the peer,
3427 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3429 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003430 return( 0 );
3431 }
3432
Andrzej Kurek33f41a82022-06-08 11:47:33 -04003433 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003434 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003435 ssl->cli_id, ssl->cli_id_len,
3436 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003437 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003438
Andrzej Kurek33f41a82022-06-08 11:47:33 -04003439 MBEDTLS_SSL_DEBUG_RET( 2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003440
3441 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003442 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003443 int send_ret;
3444 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3445 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3446 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003447 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003448 * If the error is permanent we'll catch it later,
3449 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003450 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3451 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3452 (void) send_ret;
3453
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003454 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003455 }
3456
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003457 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003460 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003461 {
3462 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3463 return( ret );
3464 }
3465
3466 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003467 }
3468
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003469 return( ret );
3470}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003471#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003472
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003473MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003474static int ssl_check_record_type( uint8_t record_type )
3475{
3476 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3477 record_type != MBEDTLS_SSL_MSG_ALERT &&
3478 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3479 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3480 {
3481 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3482 }
3483
3484 return( 0 );
3485}
3486
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003487/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003488 * ContentType type;
3489 * ProtocolVersion version;
3490 * uint16 epoch; // DTLS only
3491 * uint48 sequence_number; // DTLS only
3492 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003493 *
3494 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003495 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003496 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3497 *
3498 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003499 * 1. proceed with the record if this function returns 0
3500 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3501 * 3. return CLIENT_RECONNECT if this function return that value
3502 * 4. drop the whole datagram if this function returns anything else.
3503 * Point 2 is needed when the peer is resending, and we have already received
3504 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003505 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003506MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker331de3d2019-07-12 11:10:16 +01003507static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003508 unsigned char *buf,
3509 size_t len,
3510 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003511{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003512 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003513
Hanno Beckere5e7e782019-07-11 12:29:35 +01003514 size_t const rec_hdr_type_offset = 0;
3515 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003516
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3518 rec_hdr_type_len;
3519 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003520
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 size_t const rec_hdr_ctr_len = 8;
3522#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003523 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3525 rec_hdr_version_len;
3526
Hanno Beckera0e20d02019-05-15 14:03:01 +01003527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3529 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003530 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003531#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3532#endif /* MBEDTLS_SSL_PROTO_DTLS */
3533
3534 size_t rec_hdr_len_offset; /* To be determined */
3535 size_t const rec_hdr_len_len = 2;
3536
3537 /*
3538 * Check minimum lengths for record header.
3539 */
3540
3541#if defined(MBEDTLS_SSL_PROTO_DTLS)
3542 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3543 {
3544 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3545 }
3546 else
3547#endif /* MBEDTLS_SSL_PROTO_DTLS */
3548 {
3549 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3550 }
3551
3552 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3553 {
3554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3555 (unsigned) len,
3556 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3557 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3558 }
3559
3560 /*
3561 * Parse and validate record content type
3562 */
3563
3564 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003565
3566 /* Check record content type */
3567#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3568 rec->cid_len = 0;
3569
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003570 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571 ssl->conf->cid_len != 0 &&
3572 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003573 {
3574 /* Shift pointers to account for record header including CID
3575 * struct {
3576 * ContentType special_type = tls12_cid;
3577 * ProtocolVersion version;
3578 * uint16 epoch;
3579 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003580 * opaque cid[cid_length]; // Additional field compared to
3581 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003582 * uint16 length;
3583 * opaque enc_content[DTLSCiphertext.length];
3584 * } DTLSCiphertext;
3585 */
3586
3587 /* So far, we only support static CID lengths
3588 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003589 rec_hdr_cid_len = ssl->conf->cid_len;
3590 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003591
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003593 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3595 (unsigned) len,
3596 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003597 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003598 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003599
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003600 /* configured CID len is guaranteed at most 255, see
3601 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3602 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003603 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003604 }
3605 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003606#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003607 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 if( ssl_check_record_type( rec->type ) )
3609 {
Hanno Becker54229812019-07-12 14:40:00 +01003610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3611 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003612 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3613 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003614 }
3615
Hanno Beckere5e7e782019-07-11 12:29:35 +01003616 /*
3617 * Parse and validate record version
3618 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003619 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3620 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003621 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3622 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003623 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003624
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003625 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003626 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch: got %u, expected %u",
3628 (unsigned) major_ver,
3629 (unsigned) ssl->major_ver ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003631 }
3632
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003633 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003634 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch: got %u, expected max %u",
3636 (unsigned) minor_ver,
3637 (unsigned) ssl->conf->max_minor_ver ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003638 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003639 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003640 /*
3641 * Parse/Copy record sequence number.
3642 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003643
Hanno Beckere5e7e782019-07-11 12:29:35 +01003644#if defined(MBEDTLS_SSL_PROTO_DTLS)
3645 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003646 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 /* Copy explicit record sequence number from input buffer. */
3648 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3649 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003650 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 else
3652#endif /* MBEDTLS_SSL_PROTO_DTLS */
3653 {
3654 /* Copy implicit record sequence number from SSL context structure. */
3655 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3656 }
Paul Bakker40e46942009-01-03 21:51:57 +00003657
Hanno Beckere5e7e782019-07-11 12:29:35 +01003658 /*
3659 * Parse record length.
3660 */
3661
Hanno Beckere5e7e782019-07-11 12:29:35 +01003662 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003663 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3664 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003665 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003666
Paul Elliott9f352112020-12-09 14:55:45 +00003667 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003668 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003669 rec->type,
3670 major_ver, minor_ver, rec->data_len ) );
3671
3672 rec->buf = buf;
3673 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003674
Hanno Beckerd417cc92019-07-26 08:20:27 +01003675 if( rec->data_len == 0 )
3676 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003677
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003678 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003679 * DTLS-related tests.
3680 * Check epoch before checking length constraint because
3681 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3682 * message gets duplicated before the corresponding Finished message,
3683 * the second ChangeCipherSpec should be discarded because it belongs
3684 * to an old epoch, but not because its length is shorter than
3685 * the minimum record length for packets using the new record transform.
3686 * Note that these two kinds of failures are handled differently,
3687 * as an unexpected record is silently skipped but an invalid
3688 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003689 */
3690#if defined(MBEDTLS_SSL_PROTO_DTLS)
3691 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3692 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003693 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003694
Hanno Becker955a5c92019-07-10 17:12:07 +01003695 /* Check that the datagram is large enough to contain a record
3696 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003697 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003698 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3700 (unsigned) len,
3701 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003702 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3703 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003704
Hanno Becker37cfe732019-07-10 17:20:01 +01003705 /* Records from other, non-matching epochs are silently discarded.
3706 * (The case of same-port Client reconnects must be considered in
3707 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003708 if( rec_epoch != ssl->in_epoch )
3709 {
3710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003711 "expected %u, received %lu",
3712 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003713
Hanno Becker552f7472019-07-19 10:59:12 +01003714 /* Records from the next epoch are considered for buffering
3715 * (concretely: early Finished messages). */
3716 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003717 {
Hanno Becker552f7472019-07-19 10:59:12 +01003718 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3719 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003720 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003721
Hanno Becker2fddd372019-07-10 14:37:41 +01003722 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003723 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003724#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003725 /* For records from the correct epoch, check whether their
3726 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003727 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3728 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003729 {
3730 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3731 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3732 }
3733#endif
3734 }
3735#endif /* MBEDTLS_SSL_PROTO_DTLS */
3736
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003737 return( 0 );
3738}
Paul Bakker5121ce52009-01-03 21:22:43 +00003739
Paul Bakker5121ce52009-01-03 21:22:43 +00003740
Hanno Becker2fddd372019-07-10 14:37:41 +01003741#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003742MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker2fddd372019-07-10 14:37:41 +01003743static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3744{
3745 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3746
3747 /*
3748 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3749 * access the first byte of record content (handshake type), as we
3750 * have an active transform (possibly iv_len != 0), so use the
3751 * fact that the record header len is 13 instead.
3752 */
3753 if( rec_epoch == 0 &&
3754 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3755 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3756 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3757 ssl->in_left > 13 &&
3758 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3759 {
3760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3761 "from the same port" ) );
3762 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003763 }
3764
3765 return( 0 );
3766}
Hanno Becker2fddd372019-07-10 14:37:41 +01003767#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003768
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003769/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003770 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003771 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003772MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerfdf66042019-07-11 13:07:45 +01003773static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3774 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003775{
3776 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003779 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3782 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003786 ret = mbedtls_ssl_hw_record_read( ssl );
3787 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003788 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003789 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3790 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003791 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003792
3793 if( ret == 0 )
3794 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003795 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003797 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003798 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003799 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003800
Hanno Beckera18d1322018-01-03 14:27:32 +00003801 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003802 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003804 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003805
Hanno Beckera0e20d02019-05-15 14:03:01 +01003806#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003807 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3808 ssl->conf->ignore_unexpected_cid
3809 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3810 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003811 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003812 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003813 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003814#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003815
Paul Bakker5121ce52009-01-03 21:22:43 +00003816 return( ret );
3817 }
3818
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003819 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003820 {
3821 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003822 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003823 }
3824
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003825 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003826 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003827
Hanno Beckera0e20d02019-05-15 14:03:01 +01003828#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003829 /* We have already checked the record content type
3830 * in ssl_parse_record_header(), failing or silently
3831 * dropping the record in the case of an unknown type.
3832 *
3833 * Since with the use of CIDs, the record content type
3834 * might change during decryption, re-check the record
3835 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003836 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003837 {
3838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3839 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3840 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003841#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003842
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003843 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003844 {
3845#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3846 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003847 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003848 {
3849 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3851 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3852 }
3853#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3854
3855 ssl->nb_zero++;
3856
3857 /*
3858 * Three or more empty messages may be a DoS attack
3859 * (excessive CPU consumption).
3860 */
3861 if( ssl->nb_zero > 3 )
3862 {
3863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003864 "messages, possible DoS attack" ) );
3865 /* Treat the records as if they were not properly authenticated,
3866 * thereby failing the connection if we see more than allowed
3867 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003868 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3869 }
3870 }
3871 else
3872 ssl->nb_zero = 0;
3873
3874#if defined(MBEDTLS_SSL_PROTO_DTLS)
3875 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3876 {
3877 ; /* in_ctr read from peer, not maintained internally */
3878 }
3879 else
3880#endif
3881 {
3882 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003883 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003884 if( ++ssl->in_ctr[i - 1] != 0 )
3885 break;
3886
3887 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003888 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003889 {
3890 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3891 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3892 }
3893 }
3894
Paul Bakker5121ce52009-01-03 21:22:43 +00003895 }
3896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003897#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003900 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003901 }
3902#endif
3903
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003904 /* Check actual (decrypted) record content length against
3905 * configured maximum. */
Paul Elliott24ed2ca2022-06-10 14:11:31 +01003906 if( rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003907 {
3908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3909 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3910 }
3911
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003912 return( 0 );
3913}
3914
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003915/*
3916 * Read a record.
3917 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003918 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3919 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3920 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003921 */
Hanno Becker1097b342018-08-15 14:09:41 +01003922
3923/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003924MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01003925static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003926MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003927static int ssl_get_next_record( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02003928MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01003929static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003930
Hanno Becker327c93b2018-08-15 13:56:18 +01003931int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003932 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003933{
Janos Follath865b3eb2019-12-16 11:46:15 +00003934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003937
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003938 if( ssl->keep_current_message == 0 )
3939 {
3940 do {
Simon Butcher99000142016-10-13 17:21:01 +01003941
Hanno Becker26994592018-08-15 14:14:59 +01003942 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003943 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003944 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003945
Hanno Beckere74d5562018-08-15 14:26:08 +01003946 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003947 {
David Horstmann5846c9d2022-10-06 18:31:25 +01003948 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01003949#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01003950
Hanno Becker40f50842018-08-15 14:48:01 +01003951 /* We only check for buffered messages if the
3952 * current datagram is fully consumed. */
3953 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003954 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003955 {
Hanno Becker40f50842018-08-15 14:48:01 +01003956 if( ssl_load_buffered_message( ssl ) == 0 )
David Horstmann5846c9d2022-10-06 18:31:25 +01003957 dtls_have_buffered = 1;
Hanno Becker40f50842018-08-15 14:48:01 +01003958 }
3959
Hanno Becker40f50842018-08-15 14:48:01 +01003960#endif /* MBEDTLS_SSL_PROTO_DTLS */
David Horstmann5846c9d2022-10-06 18:31:25 +01003961 if( dtls_have_buffered == 0 )
Hanno Becker40f50842018-08-15 14:48:01 +01003962 {
3963 ret = ssl_get_next_record( ssl );
3964 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3965 continue;
3966
3967 if( ret != 0 )
3968 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003969 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003970 return( ret );
3971 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003972 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003973 }
3974
3975 ret = mbedtls_ssl_handle_message_type( ssl );
3976
Hanno Becker40f50842018-08-15 14:48:01 +01003977#if defined(MBEDTLS_SSL_PROTO_DTLS)
3978 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3979 {
3980 /* Buffer future message */
3981 ret = ssl_buffer_message( ssl );
3982 if( ret != 0 )
3983 return( ret );
3984
3985 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3986 }
3987#endif /* MBEDTLS_SSL_PROTO_DTLS */
3988
Hanno Becker90333da2017-10-10 11:27:13 +01003989 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3990 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003991
3992 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003993 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003994 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003995 return( ret );
3996 }
3997
Hanno Becker327c93b2018-08-15 13:56:18 +01003998 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003999 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004000 {
4001 mbedtls_ssl_update_handshake_status( ssl );
4002 }
Simon Butcher99000142016-10-13 17:21:01 +01004003 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004004 else
Simon Butcher99000142016-10-13 17:21:01 +01004005 {
Hanno Becker02f59072018-08-15 14:00:24 +01004006 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004007 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004008 }
4009
4010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4011
4012 return( 0 );
4013}
4014
Hanno Becker40f50842018-08-15 14:48:01 +01004015#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004016MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004017static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004018{
Hanno Becker40f50842018-08-15 14:48:01 +01004019 if( ssl->in_left > ssl->next_record_offset )
4020 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004021
Hanno Becker40f50842018-08-15 14:48:01 +01004022 return( 0 );
4023}
4024
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004025MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004026static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4027{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004028 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004029 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004030 int ret = 0;
4031
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004032 if( hs == NULL )
4033 return( -1 );
4034
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00004035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_message" ) );
Hanno Beckere00ae372018-08-20 09:39:42 +01004036
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004037 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4038 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4039 {
4040 /* Check if we have seen a ChangeCipherSpec before.
4041 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004042 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004043 {
4044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4045 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004046 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004047 }
4048
Hanno Becker39b8bc92018-08-28 17:17:13 +01004049 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004050 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4051 ssl->in_msglen = 1;
4052 ssl->in_msg[0] = 1;
4053
4054 /* As long as they are equal, the exact value doesn't matter. */
4055 ssl->in_left = 0;
4056 ssl->next_record_offset = 0;
4057
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004058 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004059 goto exit;
4060 }
Hanno Becker37f95322018-08-16 13:55:32 +01004061
Hanno Beckerb8f50142018-08-28 10:01:34 +01004062#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004063 /* Debug only */
4064 {
4065 unsigned offset;
4066 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4067 {
4068 hs_buf = &hs->buffering.hs[offset];
4069 if( hs_buf->is_valid == 1 )
4070 {
4071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4072 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004073 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004074 }
4075 }
4076 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004077#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004078
4079 /* Check if we have buffered and/or fully reassembled the
4080 * next handshake message. */
4081 hs_buf = &hs->buffering.hs[0];
4082 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4083 {
4084 /* Synthesize a record containing the buffered HS message. */
4085 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4086 ( hs_buf->data[2] << 8 ) |
4087 hs_buf->data[3];
4088
4089 /* Double-check that we haven't accidentally buffered
4090 * a message that doesn't fit into the input buffer. */
4091 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4092 {
4093 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4094 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4095 }
4096
4097 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4098 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4099 hs_buf->data, msg_len + 12 );
4100
4101 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4102 ssl->in_hslen = msg_len + 12;
4103 ssl->in_msglen = msg_len + 12;
4104 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4105
4106 ret = 0;
4107 goto exit;
4108 }
4109 else
4110 {
4111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4112 hs->in_msg_seq ) );
4113 }
4114
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004115 ret = -1;
4116
4117exit:
4118
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4120 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004121}
4122
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004123MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera02b0b42018-08-21 17:20:27 +01004124static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4125 size_t desired )
4126{
4127 int offset;
4128 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4130 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004131
Hanno Becker01315ea2018-08-21 17:22:17 +01004132 /* Get rid of future records epoch first, if such exist. */
4133 ssl_free_buffered_record( ssl );
4134
4135 /* Check if we have enough space available now. */
4136 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4137 hs->buffering.total_bytes_buffered ) )
4138 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004140 return( 0 );
4141 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004142
Hanno Becker4f432ad2018-08-28 10:02:32 +01004143 /* We don't have enough space to buffer the next expected handshake
4144 * message. Remove buffers used for future messages to gain space,
4145 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004146 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4147 offset >= 0; offset-- )
4148 {
4149 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4150 offset ) );
4151
Hanno Beckerb309b922018-08-23 13:18:05 +01004152 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004153
4154 /* Check if we have enough space available now. */
4155 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4156 hs->buffering.total_bytes_buffered ) )
4157 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004159 return( 0 );
4160 }
4161 }
4162
4163 return( -1 );
4164}
4165
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004166MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40f50842018-08-15 14:48:01 +01004167static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4168{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004169 int ret = 0;
4170 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4171
4172 if( hs == NULL )
4173 return( 0 );
4174
4175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4176
4177 switch( ssl->in_msgtype )
4178 {
4179 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004181
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004182 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004183 break;
4184
4185 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004186 {
4187 unsigned recv_msg_seq_offset;
4188 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4189 mbedtls_ssl_hs_buffer *hs_buf;
4190 size_t msg_len = ssl->in_hslen - 12;
4191
4192 /* We should never receive an old handshake
4193 * message - double-check nonetheless. */
4194 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4195 {
4196 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4197 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4198 }
4199
4200 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4201 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4202 {
4203 /* Silently ignore -- message too far in the future */
4204 MBEDTLS_SSL_DEBUG_MSG( 2,
4205 ( "Ignore future HS message with sequence number %u, "
4206 "buffering window %u - %u",
4207 recv_msg_seq, ssl->handshake->in_msg_seq,
4208 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4209
4210 goto exit;
4211 }
4212
4213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4214 recv_msg_seq, recv_msg_seq_offset ) );
4215
4216 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4217
4218 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004219 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004220 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004221 size_t reassembly_buf_sz;
4222
Hanno Becker37f95322018-08-16 13:55:32 +01004223 hs_buf->is_fragmented =
4224 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4225
4226 /* We copy the message back into the input buffer
4227 * after reassembly, so check that it's not too large.
4228 * This is an implementation-specific limitation
4229 * and not one from the standard, hence it is not
4230 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004231 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004232 {
4233 /* Ignore message */
4234 goto exit;
4235 }
4236
Hanno Beckere0b150f2018-08-21 15:51:03 +01004237 /* Check if we have enough space to buffer the message. */
4238 if( hs->buffering.total_bytes_buffered >
4239 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4240 {
4241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4242 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4243 }
4244
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004245 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4246 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004247
4248 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4249 hs->buffering.total_bytes_buffered ) )
4250 {
4251 if( recv_msg_seq_offset > 0 )
4252 {
4253 /* If we can't buffer a future message because
4254 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004255 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4256 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4257 " (already %" MBEDTLS_PRINTF_SIZET
4258 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004259 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004260 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004261 goto exit;
4262 }
Hanno Beckere1801392018-08-21 16:51:05 +01004263 else
4264 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4266 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4267 " (already %" MBEDTLS_PRINTF_SIZET
4268 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004269 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004270 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004271 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004272
Hanno Beckera02b0b42018-08-21 17:20:27 +01004273 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004274 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004275 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4276 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4277 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4278 " (already %" MBEDTLS_PRINTF_SIZET
4279 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004280 msg_len,
4281 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004282 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004283 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004284 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4285 goto exit;
4286 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004287 }
4288
Paul Elliottd48d5c62021-01-07 14:47:05 +00004289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004290 msg_len ) );
4291
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004292 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4293 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004294 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004295 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004296 goto exit;
4297 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004298 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004299
4300 /* Prepare final header: copy msg_type, length and message_seq,
4301 * then add standardised fragment_offset and fragment_length */
4302 memcpy( hs_buf->data, ssl->in_msg, 6 );
4303 memset( hs_buf->data + 6, 0, 3 );
4304 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4305
4306 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004307
4308 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004309 }
4310 else
4311 {
4312 /* Make sure msg_type and length are consistent */
4313 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4314 {
4315 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4316 /* Ignore */
4317 goto exit;
4318 }
4319 }
4320
Hanno Becker4422bbb2018-08-20 09:40:19 +01004321 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004322 {
4323 size_t frag_len, frag_off;
4324 unsigned char * const msg = hs_buf->data + 12;
4325
4326 /*
4327 * Check and copy current fragment
4328 */
4329
4330 /* Validation of header fields already done in
4331 * mbedtls_ssl_prepare_handshake_record(). */
4332 frag_off = ssl_get_hs_frag_off( ssl );
4333 frag_len = ssl_get_hs_frag_len( ssl );
4334
Paul Elliottd48d5c62021-01-07 14:47:05 +00004335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4336 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004337 frag_off, frag_len ) );
4338 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4339
4340 if( hs_buf->is_fragmented )
4341 {
4342 unsigned char * const bitmask = msg + msg_len;
4343 ssl_bitmask_set( bitmask, frag_off, frag_len );
4344 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4345 msg_len ) == 0 );
4346 }
4347 else
4348 {
4349 hs_buf->is_complete = 1;
4350 }
4351
4352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4353 hs_buf->is_complete ? "" : "not yet " ) );
4354 }
4355
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004356 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004357 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004358
4359 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004360 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004361 break;
4362 }
4363
4364exit:
4365
4366 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4367 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004368}
4369#endif /* MBEDTLS_SSL_PROTO_DTLS */
4370
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004371MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker1097b342018-08-15 14:09:41 +01004372static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004373{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004374 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004375 * Consume last content-layer message and potentially
4376 * update in_msglen which keeps track of the contents'
4377 * consumption state.
4378 *
4379 * (1) Handshake messages:
4380 * Remove last handshake message, move content
4381 * and adapt in_msglen.
4382 *
4383 * (2) Alert messages:
4384 * Consume whole record content, in_msglen = 0.
4385 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004386 * (3) Change cipher spec:
4387 * Consume whole record content, in_msglen = 0.
4388 *
4389 * (4) Application data:
4390 * Don't do anything - the record layer provides
4391 * the application data as a stream transport
4392 * and consumes through mbedtls_ssl_read only.
4393 *
4394 */
4395
4396 /* Case (1): Handshake messages */
4397 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004398 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004399 /* Hard assertion to be sure that no application data
4400 * is in flight, as corrupting ssl->in_msglen during
4401 * ssl->in_offt != NULL is fatal. */
4402 if( ssl->in_offt != NULL )
4403 {
4404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4405 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4406 }
4407
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004408 /*
4409 * Get next Handshake message in the current record
4410 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004411
Hanno Becker4a810fb2017-05-24 16:27:30 +01004412 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004413 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004414 * current handshake content: If DTLS handshake
4415 * fragmentation is used, that's the fragment
4416 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004417 * size here is faulty and should be changed at
4418 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004419 * (2) While it doesn't seem to cause problems, one
4420 * has to be very careful not to assume that in_hslen
4421 * is always <= in_msglen in a sensible communication.
4422 * Again, it's wrong for DTLS handshake fragmentation.
4423 * The following check is therefore mandatory, and
4424 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004425 * Additionally, ssl->in_hslen might be arbitrarily out of
4426 * bounds after handling a DTLS message with an unexpected
4427 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004428 */
4429 if( ssl->in_hslen < ssl->in_msglen )
4430 {
4431 ssl->in_msglen -= ssl->in_hslen;
4432 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4433 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004434
Hanno Becker4a810fb2017-05-24 16:27:30 +01004435 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4436 ssl->in_msg, ssl->in_msglen );
4437 }
4438 else
4439 {
4440 ssl->in_msglen = 0;
4441 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004442
Hanno Becker4a810fb2017-05-24 16:27:30 +01004443 ssl->in_hslen = 0;
4444 }
4445 /* Case (4): Application data */
4446 else if( ssl->in_offt != NULL )
4447 {
4448 return( 0 );
4449 }
4450 /* Everything else (CCS & Alerts) */
4451 else
4452 {
4453 ssl->in_msglen = 0;
4454 }
4455
Hanno Becker1097b342018-08-15 14:09:41 +01004456 return( 0 );
4457}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004458
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004459MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004460static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4461{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004462 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004463 return( 1 );
4464
4465 return( 0 );
4466}
4467
Hanno Becker5f066e72018-08-16 14:56:31 +01004468#if defined(MBEDTLS_SSL_PROTO_DTLS)
4469
4470static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4471{
4472 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4473 if( hs == NULL )
4474 return;
4475
Hanno Becker01315ea2018-08-21 17:22:17 +01004476 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004477 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004478 hs->buffering.total_bytes_buffered -=
4479 hs->buffering.future_record.len;
4480
4481 mbedtls_free( hs->buffering.future_record.data );
4482 hs->buffering.future_record.data = NULL;
4483 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004484}
4485
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004486MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker5f066e72018-08-16 14:56:31 +01004487static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4488{
4489 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4490 unsigned char * rec;
4491 size_t rec_len;
4492 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004493#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4494 size_t in_buf_len = ssl->in_buf_len;
4495#else
4496 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4497#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004498 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4499 return( 0 );
4500
4501 if( hs == NULL )
4502 return( 0 );
4503
Hanno Becker5f066e72018-08-16 14:56:31 +01004504 rec = hs->buffering.future_record.data;
4505 rec_len = hs->buffering.future_record.len;
4506 rec_epoch = hs->buffering.future_record.epoch;
4507
4508 if( rec == NULL )
4509 return( 0 );
4510
Hanno Becker4cb782d2018-08-20 11:19:05 +01004511 /* Only consider loading future records if the
4512 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004513 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004514 return( 0 );
4515
Hanno Becker5f066e72018-08-16 14:56:31 +01004516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4517
4518 if( rec_epoch != ssl->in_epoch )
4519 {
4520 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4521 goto exit;
4522 }
4523
4524 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4525
4526 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004527 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004528 {
4529 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4530 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4531 }
4532
4533 memcpy( ssl->in_hdr, rec, rec_len );
4534 ssl->in_left = rec_len;
4535 ssl->next_record_offset = 0;
4536
4537 ssl_free_buffered_record( ssl );
4538
4539exit:
4540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4541 return( 0 );
4542}
4543
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004544MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker519f15d2019-07-11 12:43:20 +01004545static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4546 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004547{
4548 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004549
4550 /* Don't buffer future records outside handshakes. */
4551 if( hs == NULL )
4552 return( 0 );
4553
4554 /* Only buffer handshake records (we are only interested
4555 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004556 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004557 return( 0 );
4558
4559 /* Don't buffer more than one future epoch record. */
4560 if( hs->buffering.future_record.data != NULL )
4561 return( 0 );
4562
Hanno Becker01315ea2018-08-21 17:22:17 +01004563 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004564 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004565 hs->buffering.total_bytes_buffered ) )
4566 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004567 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4568 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4569 " (already %" MBEDTLS_PRINTF_SIZET
4570 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004571 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004572 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004573 return( 0 );
4574 }
4575
Hanno Becker5f066e72018-08-16 14:56:31 +01004576 /* Buffer record */
4577 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004578 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004579 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004580
4581 /* ssl_parse_record_header() only considers records
4582 * of the next epoch as candidates for buffering. */
4583 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004584 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004585
4586 hs->buffering.future_record.data =
4587 mbedtls_calloc( 1, hs->buffering.future_record.len );
4588 if( hs->buffering.future_record.data == NULL )
4589 {
4590 /* If we run out of RAM trying to buffer a
4591 * record from the next epoch, just ignore. */
4592 return( 0 );
4593 }
4594
Hanno Becker519f15d2019-07-11 12:43:20 +01004595 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004596
Hanno Becker519f15d2019-07-11 12:43:20 +01004597 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004598 return( 0 );
4599}
4600
4601#endif /* MBEDTLS_SSL_PROTO_DTLS */
4602
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02004603MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckere74d5562018-08-15 14:26:08 +01004604static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004605{
Janos Follath865b3eb2019-12-16 11:46:15 +00004606 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004607 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004608
Hanno Becker5f066e72018-08-16 14:56:31 +01004609#if defined(MBEDTLS_SSL_PROTO_DTLS)
4610 /* We might have buffered a future record; if so,
4611 * and if the epoch matches now, load it.
4612 * On success, this call will set ssl->in_left to
4613 * the length of the buffered record, so that
4614 * the calls to ssl_fetch_input() below will
4615 * essentially be no-ops. */
4616 ret = ssl_load_buffered_record( ssl );
4617 if( ret != 0 )
4618 return( ret );
4619#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004620
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004621 /* Ensure that we have enough space available for the default form
4622 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4623 * with no space for CIDs counted in). */
4624 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4625 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004626 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004627 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004628 return( ret );
4629 }
4630
Hanno Beckere5e7e782019-07-11 12:29:35 +01004631 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4632 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004633 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004635 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004636 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004637 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4638 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004639 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004640 if( ret != 0 )
4641 return( ret );
4642
4643 /* Fall through to handling of unexpected records */
4644 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4645 }
4646
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004647 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4648 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004649#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004650 /* Reset in pointers to default state for TLS/DTLS records,
4651 * assuming no CID and no offset between record content and
4652 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004653 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004654
Hanno Becker7ae20e02019-07-12 08:33:49 +01004655 /* Setup internal message pointers from record structure. */
4656 ssl->in_msgtype = rec.type;
4657#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4658 ssl->in_len = ssl->in_cid + rec.cid_len;
4659#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4660 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4661 ssl->in_msglen = rec.data_len;
4662
Hanno Becker2fddd372019-07-10 14:37:41 +01004663 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004664 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004665 if( ret != 0 )
4666 return( ret );
4667#endif
4668
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004669 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004670 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004671
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4673 "(header)" ) );
4674 }
4675 else
4676 {
4677 /* Skip invalid record and the rest of the datagram */
4678 ssl->next_record_offset = 0;
4679 ssl->in_left = 0;
4680
4681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4682 "(header)" ) );
4683 }
4684
4685 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004686 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004687 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004688 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004689#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004690 {
4691 return( ret );
4692 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004693 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004697 {
Hanno Beckera8814792019-07-10 15:01:45 +01004698 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004699 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004700 if( ssl->next_record_offset < ssl->in_left )
4701 {
4702 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4703 }
4704 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004705 else
4706#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004707 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004708 /*
4709 * Fetch record contents from underlying transport.
4710 */
Hanno Beckera3175662019-07-11 12:50:29 +01004711 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004712 if( ret != 0 )
4713 {
4714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4715 return( ret );
4716 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004717
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004718 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004719 }
4720
4721 /*
4722 * Decrypt record contents.
4723 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004724
Hanno Beckerfdf66042019-07-11 13:07:45 +01004725 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004726 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004727#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004728 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004729 {
4730 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004731 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004732 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004733 /* Except when waiting for Finished as a bad mac here
4734 * probably means something went wrong in the handshake
4735 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4736 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4737 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4738 {
4739#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4740 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4741 {
4742 mbedtls_ssl_send_alert_message( ssl,
4743 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4744 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4745 }
4746#endif
4747 return( ret );
4748 }
4749
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004750#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004751 if( ssl->conf->badmac_limit != 0 &&
4752 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004753 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4755 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004756 }
4757#endif
4758
Hanno Becker4a810fb2017-05-24 16:27:30 +01004759 /* As above, invalid records cause
4760 * dismissal of the whole datagram. */
4761
4762 ssl->next_record_offset = 0;
4763 ssl->in_left = 0;
4764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004766 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004767 }
4768
4769 return( ret );
4770 }
4771 else
4772#endif
4773 {
4774 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4776 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004777 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004778 mbedtls_ssl_send_alert_message( ssl,
4779 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4780 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004781 }
4782#endif
4783 return( ret );
4784 }
4785 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004786
Hanno Becker44d89b22019-07-12 09:40:44 +01004787
4788 /* Reset in pointers to default state for TLS/DTLS records,
4789 * assuming no CID and no offset between record content and
4790 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004791 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004792#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4793 ssl->in_len = ssl->in_cid + rec.cid_len;
4794#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004795 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004796
Hanno Becker8685c822019-07-12 09:37:30 +01004797 /* The record content type may change during decryption,
4798 * so re-read it. */
4799 ssl->in_msgtype = rec.type;
4800 /* Also update the input buffer, because unfortunately
4801 * the server-side ssl_parse_client_hello() reparses the
4802 * record header when receiving a ClientHello initiating
4803 * a renegotiation. */
4804 ssl->in_hdr[0] = rec.type;
4805 ssl->in_msg = rec.buf + rec.data_offset;
4806 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004807 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004808
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004809#if defined(MBEDTLS_ZLIB_SUPPORT)
4810 if( ssl->transform_in != NULL &&
4811 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4812 {
4813 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4814 {
4815 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4816 return( ret );
4817 }
4818
4819 /* Check actual (decompress) record content length against
4820 * configured maximum. */
4821 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4822 {
4823 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4824 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4825 }
4826 }
4827#endif /* MBEDTLS_ZLIB_SUPPORT */
4828
Simon Butcher99000142016-10-13 17:21:01 +01004829 return( 0 );
4830}
4831
4832int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4833{
Janos Follath865b3eb2019-12-16 11:46:15 +00004834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004835
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004836 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004837 * Handle particular types of records
4838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004839 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004840 {
Simon Butcher99000142016-10-13 17:21:01 +01004841 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4842 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004843 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004844 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004845 }
4846
Hanno Beckere678eaa2018-08-21 14:57:46 +01004847 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004848 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004849 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004850 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004852 ssl->in_msglen ) );
4853 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004854 }
4855
Hanno Beckere678eaa2018-08-21 14:57:46 +01004856 if( ssl->in_msg[0] != 1 )
4857 {
4858 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4859 ssl->in_msg[0] ) );
4860 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4861 }
4862
4863#if defined(MBEDTLS_SSL_PROTO_DTLS)
4864 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4865 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4866 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4867 {
4868 if( ssl->handshake == NULL )
4869 {
4870 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4871 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4872 }
4873
4874 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4875 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4876 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004877#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004878 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004879
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004881 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004882 if( ssl->in_msglen != 2 )
4883 {
4884 /* Note: Standard allows for more than one 2 byte alert
4885 to be packed in a single message, but Mbed TLS doesn't
4886 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004887 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004888 ssl->in_msglen ) );
4889 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4890 }
4891
Paul Elliott9f352112020-12-09 14:55:45 +00004892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004893 ssl->in_msg[0], ssl->in_msg[1] ) );
4894
4895 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004896 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004898 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004899 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004901 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004902 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004903 }
4904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004905 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4906 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4909 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004911
4912#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4913 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4914 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4915 {
Hanno Becker90333da2017-10-10 11:27:13 +01004916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004917 /* Will be handled when trying to parse ServerHello */
4918 return( 0 );
4919 }
4920#endif
4921
4922#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4923 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4924 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4925 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4926 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4927 {
4928 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4929 /* Will be handled in mbedtls_ssl_parse_certificate() */
4930 return( 0 );
4931 }
4932#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4933
4934 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004935 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004936 }
4937
Hanno Beckerc76c6192017-06-06 10:03:17 +01004938#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004940 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004941 /* Drop unexpected ApplicationData records,
4942 * except at the beginning of renegotiations */
4943 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4944 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4945#if defined(MBEDTLS_SSL_RENEGOTIATION)
4946 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4947 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004948#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004949 )
4950 {
4951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4952 return( MBEDTLS_ERR_SSL_NON_FATAL );
4953 }
4954
4955 if( ssl->handshake != NULL &&
4956 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4957 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004958 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004959 }
4960 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004961#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004962
Paul Bakker5121ce52009-01-03 21:22:43 +00004963 return( 0 );
4964}
4965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004967{
irwir6c0da642019-09-26 21:07:41 +03004968 return( mbedtls_ssl_send_alert_message( ssl,
4969 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4970 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004971}
4972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004974 unsigned char level,
4975 unsigned char message )
4976{
Janos Follath865b3eb2019-12-16 11:46:15 +00004977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004978
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004979 if( ssl == NULL || ssl->conf == NULL )
4980 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4981
Hanno Beckerd9c66c02018-08-06 11:35:16 +01004982 if( ssl->out_left != 0 )
4983 return( mbedtls_ssl_flush_output( ssl ) );
4984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004986 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004989 ssl->out_msglen = 2;
4990 ssl->out_msg[0] = level;
4991 ssl->out_msg[1] = message;
4992
Hanno Becker67bc7c32018-08-06 11:33:50 +01004993 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004995 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004996 return( ret );
4997 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004999
5000 return( 0 );
5001}
5002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005004{
Janos Follath865b3eb2019-12-16 11:46:15 +00005005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005009 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005010 ssl->out_msglen = 1;
5011 ssl->out_msg[0] = 1;
5012
Paul Bakker5121ce52009-01-03 21:22:43 +00005013 ssl->state++;
5014
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005015 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005016 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005017 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005018 return( ret );
5019 }
5020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005022
5023 return( 0 );
5024}
5025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005026int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005027{
Janos Follath865b3eb2019-12-16 11:46:15 +00005028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005031
Hanno Becker327c93b2018-08-15 13:56:18 +01005032 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005033 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005035 return( ret );
5036 }
5037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005039 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005041 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5042 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005043 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005044 }
5045
Hanno Beckere678eaa2018-08-21 14:57:46 +01005046 /* CCS records are only accepted if they have length 1 and content '1',
5047 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005048
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005049 /*
5050 * Switch to our negotiated transform and session parameters for inbound
5051 * data.
5052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005053 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005054 ssl->transform_in = ssl->transform_negotiate;
5055 ssl->session_in = ssl->session_negotiate;
5056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005057#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005058 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005059 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005061 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005062#endif
5063
5064 /* Increment epoch */
5065 if( ++ssl->in_epoch == 0 )
5066 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005067 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005068 /* This is highly unlikely to happen for legitimate reasons, so
5069 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005071 }
5072 }
5073 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005075 memset( ssl->in_ctr, 0, 8 );
5076
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005077 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5080 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005081 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005083 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005085 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5086 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005087 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005088 }
5089 }
5090#endif
5091
Paul Bakker5121ce52009-01-03 21:22:43 +00005092 ssl->state++;
5093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005095
5096 return( 0 );
5097}
5098
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005099/* Once ssl->out_hdr as the address of the beginning of the
5100 * next outgoing record is set, deduce the other pointers.
5101 *
5102 * Note: For TLS, we save the implicit record sequence number
5103 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5104 * and the caller has to make sure there's space for this.
5105 */
5106
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005107static size_t ssl_transform_get_explicit_iv_len(
5108 mbedtls_ssl_transform const *transform )
5109{
5110 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5111 return( 0 );
5112
5113 return( transform->ivlen - transform->fixed_ivlen );
5114}
5115
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005116void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5117 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005118{
5119#if defined(MBEDTLS_SSL_PROTO_DTLS)
5120 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5121 {
5122 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005123#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005124 ssl->out_cid = ssl->out_ctr + 8;
5125 ssl->out_len = ssl->out_cid;
5126 if( transform != NULL )
5127 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005128#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005129 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005130#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005131 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005132 }
5133 else
5134#endif
5135 {
5136 ssl->out_ctr = ssl->out_hdr - 8;
5137 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005138#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005139 ssl->out_cid = ssl->out_len;
5140#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005141 ssl->out_iv = ssl->out_hdr + 5;
5142 }
5143
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005144 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005145 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005146 if( transform != NULL )
5147 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005148}
5149
5150/* Once ssl->in_hdr as the address of the beginning of the
5151 * next incoming record is set, deduce the other pointers.
5152 *
5153 * Note: For TLS, we save the implicit record sequence number
5154 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5155 * and the caller has to make sure there's space for this.
5156 */
5157
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005158void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005159{
Hanno Becker79594fd2019-05-08 09:38:41 +01005160 /* This function sets the pointers to match the case
5161 * of unprotected TLS/DTLS records, with both ssl->in_iv
5162 * and ssl->in_msg pointing to the beginning of the record
5163 * content.
5164 *
5165 * When decrypting a protected record, ssl->in_msg
5166 * will be shifted to point to the beginning of the
5167 * record plaintext.
5168 */
5169
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005170#if defined(MBEDTLS_SSL_PROTO_DTLS)
5171 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5172 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005173 /* This sets the header pointers to match records
5174 * without CID. When we receive a record containing
5175 * a CID, the fields are shifted accordingly in
5176 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005177 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005178#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005179 ssl->in_cid = ssl->in_ctr + 8;
5180 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005181#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005182 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005183#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005184 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005185 }
5186 else
5187#endif
5188 {
5189 ssl->in_ctr = ssl->in_hdr - 8;
5190 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005191#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005192 ssl->in_cid = ssl->in_len;
5193#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005194 ssl->in_iv = ssl->in_hdr + 5;
5195 }
5196
Hanno Becker79594fd2019-05-08 09:38:41 +01005197 /* This will be adjusted at record decryption time. */
5198 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005199}
5200
Paul Bakker5121ce52009-01-03 21:22:43 +00005201/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005202 * Setup an SSL context
5203 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005204
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005205void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005206{
5207 /* Set the incoming and outgoing record pointers. */
5208#if defined(MBEDTLS_SSL_PROTO_DTLS)
5209 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5210 {
5211 ssl->out_hdr = ssl->out_buf;
5212 ssl->in_hdr = ssl->in_buf;
5213 }
5214 else
5215#endif /* MBEDTLS_SSL_PROTO_DTLS */
5216 {
5217 ssl->out_hdr = ssl->out_buf + 8;
5218 ssl->in_hdr = ssl->in_buf + 8;
5219 }
5220
5221 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005222 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5223 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005224}
5225
Paul Bakker5121ce52009-01-03 21:22:43 +00005226/*
5227 * SSL get accessors
5228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005230{
5231 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5232}
5233
Hanno Becker8b170a02017-10-10 11:51:19 +01005234int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5235{
5236 /*
5237 * Case A: We're currently holding back
5238 * a message for further processing.
5239 */
5240
5241 if( ssl->keep_current_message == 1 )
5242 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005243 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005244 return( 1 );
5245 }
5246
5247 /*
5248 * Case B: Further records are pending in the current datagram.
5249 */
5250
5251#if defined(MBEDTLS_SSL_PROTO_DTLS)
5252 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5253 ssl->in_left > ssl->next_record_offset )
5254 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005255 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005256 return( 1 );
5257 }
5258#endif /* MBEDTLS_SSL_PROTO_DTLS */
5259
5260 /*
5261 * Case C: A handshake message is being processed.
5262 */
5263
Hanno Becker8b170a02017-10-10 11:51:19 +01005264 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5265 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005266 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005267 return( 1 );
5268 }
5269
5270 /*
5271 * Case D: An application data message is being processed
5272 */
5273 if( ssl->in_offt != NULL )
5274 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005275 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005276 return( 1 );
5277 }
5278
5279 /*
5280 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005281 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005282 * we implement support for multiple alerts in single records.
5283 */
5284
5285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5286 return( 0 );
5287}
5288
Paul Bakker43ca69c2011-01-15 17:35:19 +00005289
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005290int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005291{
Hanno Becker3136ede2018-08-17 15:28:19 +01005292 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005294 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005295
Hanno Becker5903de42019-05-03 14:46:38 +01005296 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5297
Hanno Becker78640902018-08-13 16:35:15 +01005298 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005299 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005301#if defined(MBEDTLS_ZLIB_SUPPORT)
5302 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5303 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005304#endif
5305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005306 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308 case MBEDTLS_MODE_GCM:
5309 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005310 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005312 transform_expansion = transform->minlen;
5313 break;
5314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005316
5317 block_size = mbedtls_cipher_get_block_size(
5318 &transform->cipher_ctx_enc );
5319
Hanno Becker3136ede2018-08-17 15:28:19 +01005320 /* Expansion due to the addition of the MAC. */
5321 transform_expansion += transform->maclen;
5322
5323 /* Expansion due to the addition of CBC padding;
5324 * Theoretically up to 256 bytes, but we never use
5325 * more than the block size of the underlying cipher. */
5326 transform_expansion += block_size;
5327
5328 /* For TLS 1.1 or higher, an explicit IV is added
5329 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005330#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5331 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005332 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005333#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005334
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005335 break;
5336
5337 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005340 }
5341
Hanno Beckera0e20d02019-05-15 14:03:01 +01005342#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005343 if( transform->out_cid_len != 0 )
5344 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005345#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005346
Hanno Becker5903de42019-05-03 14:46:38 +01005347 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005348}
5349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005351/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005352 * Check record counters and renegotiate if they're above the limit.
5353 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02005354MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005356{
Hanno Beckerdd772292020-02-05 10:38:31 +00005357 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005358 int in_ctr_cmp;
5359 int out_ctr_cmp;
5360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5362 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005363 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005364 {
5365 return( 0 );
5366 }
5367
Andres AG2196c7f2016-12-15 17:01:16 +00005368 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5369 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005370 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005371 ssl->conf->renego_period + ep_len, 8 - ep_len );
5372
5373 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005374 {
5375 return( 0 );
5376 }
5377
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005379 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005380}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005381#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005382
5383/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005384 * Receive application data decrypted from the SSL layer
5385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005387{
Janos Follath865b3eb2019-12-16 11:46:15 +00005388 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005389 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005390
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005391 if( ssl == NULL || ssl->conf == NULL )
5392 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005397 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005398 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005400 return( ret );
5401
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005402 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005404 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005405 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005406 return( ret );
5407 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005408 }
5409#endif
5410
Hanno Becker4a810fb2017-05-24 16:27:30 +01005411 /*
5412 * Check if renegotiation is necessary and/or handshake is
5413 * in process. If yes, perform/continue, and fall through
5414 * if an unexpected packet is received while the client
5415 * is waiting for the ServerHello.
5416 *
5417 * (There is no equivalent to the last condition on
5418 * the server-side as it is not treated as within
5419 * a handshake while waiting for the ClientHello
5420 * after a renegotiation request.)
5421 */
5422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005424 ret = ssl_check_ctr_renegotiate( ssl );
5425 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5426 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005427 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005428 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005429 return( ret );
5430 }
5431#endif
5432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005434 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005436 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5437 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005438 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005440 return( ret );
5441 }
5442 }
5443
Hanno Beckere41158b2017-10-23 13:30:32 +01005444 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005445 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005446 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005447 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005448 if( ssl->f_get_timer != NULL &&
5449 ssl->f_get_timer( ssl->p_timer ) == -1 )
5450 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005451 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005452 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005453
Hanno Becker327c93b2018-08-15 13:56:18 +01005454 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005455 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005456 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5457 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005458
Hanno Becker4a810fb2017-05-24 16:27:30 +01005459 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5460 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005461 }
5462
5463 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005465 {
5466 /*
5467 * OpenSSL sends empty messages to randomize the IV
5468 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005469 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005472 return( 0 );
5473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005475 return( ret );
5476 }
5477 }
5478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005482
Hanno Becker4a810fb2017-05-24 16:27:30 +01005483 /*
5484 * - For client-side, expect SERVER_HELLO_REQUEST.
5485 * - For server-side, expect CLIENT_HELLO.
5486 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5487 */
5488
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005490 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005492 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005495
5496 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005498 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005499 {
5500 continue;
5501 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005502#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005503 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005504 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005505#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005506
Hanno Becker4a810fb2017-05-24 16:27:30 +01005507#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005508 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005512
5513 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005514#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005515 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005516 {
5517 continue;
5518 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005519#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005521 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005522#endif /* MBEDTLS_SSL_SRV_C */
5523
Hanno Becker21df7f92017-10-17 11:03:26 +01005524#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005525 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005526 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5527 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5528 ssl->conf->allow_legacy_renegotiation ==
5529 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5530 {
5531 /*
5532 * Accept renegotiation request
5533 */
Paul Bakker48916f92012-09-16 19:57:18 +00005534
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005535 /* DTLS clients need to know renego is server-initiated */
5536#if defined(MBEDTLS_SSL_PROTO_DTLS)
5537 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5538 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5539 {
5540 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5541 }
5542#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005543 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005544 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5545 ret != 0 )
5546 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005547 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5548 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005549 return( ret );
5550 }
5551 }
5552 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005553#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005554 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005555 /*
5556 * Refuse renegotiation
5557 */
5558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005559 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005561#if defined(MBEDTLS_SSL_PROTO_SSL3)
5562 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005563 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005564 /* SSLv3 does not have a "no_renegotiation" warning, so
5565 we send a fatal alert and abort the connection. */
5566 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5567 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5568 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005569 }
5570 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5572#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5573 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5574 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5577 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5578 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005579 {
5580 return( ret );
5581 }
Paul Bakker48916f92012-09-16 19:57:18 +00005582 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005583 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5585 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5588 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005589 }
Paul Bakker48916f92012-09-16 19:57:18 +00005590 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005591
Hanno Becker90333da2017-10-10 11:27:13 +01005592 /* At this point, we don't know whether the renegotiation has been
5593 * completed or not. The cases to consider are the following:
5594 * 1) The renegotiation is complete. In this case, no new record
5595 * has been read yet.
5596 * 2) The renegotiation is incomplete because the client received
5597 * an application data record while awaiting the ServerHello.
5598 * 3) The renegotiation is incomplete because the client received
5599 * a non-handshake, non-application data message while awaiting
5600 * the ServerHello.
5601 * In each of these case, looping will be the proper action:
5602 * - For 1), the next iteration will read a new record and check
5603 * if it's application data.
5604 * - For 2), the loop condition isn't satisfied as application data
5605 * is present, hence continue is the same as break
5606 * - For 3), the loop condition is satisfied and read_record
5607 * will re-deliver the message that was held back by the client
5608 * when expecting the ServerHello.
5609 */
5610 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005611 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005612#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005614 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005615 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005616 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005617 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005618 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005620 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005621 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005622 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005623 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005624 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005627 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5628 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005631 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005632 }
5633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005634 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005635 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5637 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005638 }
5639
5640 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005641
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005642 /* We're going to return something now, cancel timer,
5643 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005644 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005645 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005646
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005647#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005648 /* If we requested renego but received AppData, resend HelloRequest.
5649 * Do it now, after setting in_offt, to avoid taking this branch
5650 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005651#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005652 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005653 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005654 {
Hanno Becker786300f2020-02-05 10:46:40 +00005655 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005656 {
Hanno Becker786300f2020-02-05 10:46:40 +00005657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5658 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005659 return( ret );
5660 }
5661 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005662#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005663#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005664 }
5665
5666 n = ( len < ssl->in_msglen )
5667 ? len : ssl->in_msglen;
5668
5669 memcpy( buf, ssl->in_offt, n );
5670 ssl->in_msglen -= n;
5671
gabor-mezei-arma3214132020-07-15 10:55:00 +02005672 /* Zeroising the plaintext buffer to erase unused application data
5673 from the memory. */
5674 mbedtls_platform_zeroize( ssl->in_offt, n );
5675
Paul Bakker5121ce52009-01-03 21:22:43 +00005676 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005677 {
5678 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005679 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005680 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005681 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005682 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005683 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005684 /* more data available */
5685 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005686 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005689
Paul Bakker23986e52011-04-24 08:57:21 +00005690 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005691}
5692
5693/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005694 * Send application data to be encrypted by the SSL layer, taking care of max
5695 * fragment length and buffer size.
5696 *
5697 * According to RFC 5246 Section 6.2.1:
5698 *
5699 * Zero-length fragments of Application data MAY be sent as they are
5700 * potentially useful as a traffic analysis countermeasure.
5701 *
5702 * Therefore, it is possible that the input message length is 0 and the
5703 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005704 */
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02005705MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005706static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005707 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005708{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005709 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5710 const size_t max_len = (size_t) ret;
5711
5712 if( ret < 0 )
5713 {
5714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5715 return( ret );
5716 }
5717
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005718 if( len > max_len )
5719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005721 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005722 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005724 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5725 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005726 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005728 }
5729 else
5730#endif
5731 len = max_len;
5732 }
Paul Bakker887bd502011-06-08 13:10:54 +00005733
Paul Bakker5121ce52009-01-03 21:22:43 +00005734 if( ssl->out_left != 0 )
5735 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005736 /*
5737 * The user has previously tried to send the data and
5738 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5739 * written. In this case, we expect the high-level write function
5740 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005742 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005743 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005744 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005745 return( ret );
5746 }
5747 }
Paul Bakker887bd502011-06-08 13:10:54 +00005748 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005749 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005750 /*
5751 * The user is trying to send a message the first time, so we need to
5752 * copy the data into the internal buffers and setup the data structure
5753 * to keep track of partial writes
5754 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005755 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005757 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005758
Hanno Becker67bc7c32018-08-06 11:33:50 +01005759 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005762 return( ret );
5763 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005764 }
5765
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005766 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005767}
5768
5769/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005770 * Write application data, doing 1/n-1 splitting if necessary.
5771 *
5772 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005773 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005774 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardd904d662022-06-17 10:24:00 +02005777MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005778static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005779 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005780{
Janos Follath865b3eb2019-12-16 11:46:15 +00005781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005782
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005783 if( ssl->conf->cbc_record_splitting ==
5784 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005785 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5787 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5788 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005789 {
5790 return( ssl_write_real( ssl, buf, len ) );
5791 }
5792
5793 if( ssl->split_done == 0 )
5794 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005795 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005796 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005797 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005798 }
5799
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005800 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5801 return( ret );
5802 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005803
5804 return( ret + 1 );
5805}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005806#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005807
5808/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005809 * Write application data (public-facing wrapper)
5810 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005811int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005812{
Janos Follath865b3eb2019-12-16 11:46:15 +00005813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005814
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005815 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005816
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005817 if( ssl == NULL || ssl->conf == NULL )
5818 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5819
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005820#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005821 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5822 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005823 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005824 return( ret );
5825 }
5826#endif
5827
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005828 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005829 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005830 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005831 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005833 return( ret );
5834 }
5835 }
5836
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005837#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005838 ret = ssl_write_split( ssl, buf, len );
5839#else
5840 ret = ssl_write_real( ssl, buf, len );
5841#endif
5842
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005843 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005844
5845 return( ret );
5846}
5847
5848/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005849 * Notify the peer that the connection is being closed
5850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005851int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005852{
Janos Follath865b3eb2019-12-16 11:46:15 +00005853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005854
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005855 if( ssl == NULL || ssl->conf == NULL )
5856 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005860 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005861 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005862 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5863 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5864 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005866 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005867 return( ret );
5868 }
5869 }
5870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005872
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005873 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005874}
5875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005876void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005877{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005878 if( transform == NULL )
5879 return;
5880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005881#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005882 deflateEnd( &transform->ctx_deflate );
5883 inflateEnd( &transform->ctx_inflate );
5884#endif
5885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005886 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5887 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005888
Hanno Beckerd56ed242018-01-03 15:32:51 +00005889#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005890 mbedtls_md_free( &transform->md_ctx_enc );
5891 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005892#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005893
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005894 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005895}
5896
Hanno Becker0271f962018-08-16 13:23:47 +01005897#if defined(MBEDTLS_SSL_PROTO_DTLS)
5898
Hanno Becker533ab5f2020-02-05 10:49:13 +00005899void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005900{
5901 unsigned offset;
5902 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5903
5904 if( hs == NULL )
5905 return;
5906
Hanno Becker283f5ef2018-08-24 09:34:47 +01005907 ssl_free_buffered_record( ssl );
5908
Hanno Becker0271f962018-08-16 13:23:47 +01005909 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005910 ssl_buffering_free_slot( ssl, offset );
5911}
5912
5913static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5914 uint8_t slot )
5915{
5916 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5917 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005918
5919 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5920 return;
5921
Hanno Beckere605b192018-08-21 15:59:07 +01005922 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005923 {
Hanno Beckere605b192018-08-21 15:59:07 +01005924 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005925 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005926 mbedtls_free( hs_buf->data );
5927 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005928 }
5929}
5930
5931#endif /* MBEDTLS_SSL_PROTO_DTLS */
5932
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005933/*
5934 * Convert version numbers to/from wire format
5935 * and, for DTLS, to/from TLS equivalent.
5936 *
5937 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005938 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005939 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5940 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005942void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005943 unsigned char ver[2] )
5944{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005945#if defined(MBEDTLS_SSL_PROTO_DTLS)
5946 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005948 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005949 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5950
5951 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5952 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5953 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005954 else
5955#else
5956 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005957#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005958 {
5959 ver[0] = (unsigned char) major;
5960 ver[1] = (unsigned char) minor;
5961 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005962}
5963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005964void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005965 const unsigned char ver[2] )
5966{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005967#if defined(MBEDTLS_SSL_PROTO_DTLS)
5968 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005969 {
5970 *major = 255 - ver[0] + 2;
5971 *minor = 255 - ver[1] + 1;
5972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005973 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005974 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5975 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005976 else
5977#else
5978 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005979#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005980 {
5981 *major = ver[0];
5982 *minor = ver[1];
5983 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005984}
5985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005986#endif /* MBEDTLS_SSL_TLS_C */