blob: 1ea7c5fc00ab9efcfaf7a5898a5a71dce53c5146 [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#if defined(MBEDTLS_PLATFORM_C)
34#include "mbedtls/platform.h"
35#else
36#include <stdlib.h>
37#define mbedtls_calloc calloc
38#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010039#endif
40
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020042#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000043#include "mbedtls/debug.h"
44#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050045#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010046#include "mbedtls/version.h"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020047#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020048
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020049#include "ssl_invasive.h"
50
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <string.h>
52
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#include "mbedtls/psa_util.h"
55#include "psa/crypto.h"
56#endif
57
Janos Follath23bdca02016-10-07 14:47:14 +010058#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000059#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020060#endif
61
Hanno Beckercd9dcda2018-08-28 17:18:56 +010062static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010063
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064/*
65 * Start a timer.
66 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020067 */
Hanno Becker0f57a652020-02-05 10:37:26 +000068void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020069{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020070 if( ssl->f_set_timer == NULL )
71 return;
72
73 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
74 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020075}
76
77/*
78 * Return -1 is timer is expired, 0 if it isn't.
79 */
Hanno Becker7876d122020-02-05 10:39:31 +000080int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020081{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020082 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020083 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020084
85 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020086 {
87 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020090
91 return( 0 );
92}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020093
Hanno Beckercfe45792019-07-03 16:13:00 +010094#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010095static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t len,
98 mbedtls_record *rec );
99
Hanno Beckercfe45792019-07-03 16:13:00 +0100100int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
101 unsigned char *buf,
102 size_t buflen )
103{
Hanno Becker54229812019-07-12 14:40:00 +0100104 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
106 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
107
108 /* We don't support record checking in TLS because
109 * (a) there doesn't seem to be a usecase for it, and
110 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
111 * and we'd need to backup the transform here.
112 */
113 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
114 {
115 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
116 goto exit;
117 }
118#if defined(MBEDTLS_SSL_PROTO_DTLS)
119 else
120 {
irwir734f0cf2019-09-26 21:03:24 +0300121 mbedtls_record rec;
122
Hanno Becker54229812019-07-12 14:40:00 +0100123 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
124 if( ret != 0 )
125 {
126 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
127 goto exit;
128 }
129
130 if( ssl->transform_in != NULL )
131 {
132 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
133 if( ret != 0 )
134 {
135 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
136 goto exit;
137 }
138 }
139 }
140#endif /* MBEDTLS_SSL_PROTO_DTLS */
141
142exit:
143 /* On success, we have decrypted the buffer in-place, so make
144 * sure we don't leak any plaintext data. */
145 mbedtls_platform_zeroize( buf, buflen );
146
147 /* For the purpose of this API, treat messages with unexpected CID
148 * as well as such from future epochs as unexpected. */
149 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
150 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
151 {
152 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
153 }
154
155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
156 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100157}
158#endif /* MBEDTLS_SSL_RECORD_CHECKING */
159
Hanno Becker67bc7c32018-08-06 11:33:50 +0100160#define SSL_DONT_FORCE_FLUSH 0
161#define SSL_FORCE_FLUSH 1
162
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200163#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100164
Hanno Beckerd5847772018-08-28 10:09:23 +0100165/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100166static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
167 uint8_t slot );
168static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
170static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
171static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100172static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
173 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100174static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100175
Hanno Becker11682cc2018-08-22 14:41:02 +0100176static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100177{
Hanno Becker89490712020-02-05 10:50:12 +0000178 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000179#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
180 size_t out_buf_len = ssl->out_buf_len;
181#else
182 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
183#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100184
Darryl Greenb33cc762019-11-28 14:29:44 +0000185 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100186 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100187
Darryl Greenb33cc762019-11-28 14:29:44 +0000188 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100189}
190
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
207static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
208{
Janos Follath865b3eb2019-12-16 11:46:15 +0000209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100210 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400211 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100212
213#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400214 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100215
216 if( max_len > mfl )
217 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100218
219 /* By the standard (RFC 6066 Sect. 4), the MFL extension
220 * only limits the maximum record payload size, so in theory
221 * we would be allowed to pack multiple records of payload size
222 * MFL into a single datagram. However, this would mean that there's
223 * no way to explicitly communicate MTU restrictions to the peer.
224 *
225 * The following reduction of max_len makes sure that we never
226 * write datagrams larger than MFL + Record Expansion Overhead.
227 */
228 if( max_len <= ssl->out_left )
229 return( 0 );
230
231 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100232#endif
233
234 ret = ssl_get_remaining_space_in_datagram( ssl );
235 if( ret < 0 )
236 return( ret );
237 remaining = (size_t) ret;
238
239 ret = mbedtls_ssl_get_record_expansion( ssl );
240 if( ret < 0 )
241 return( ret );
242 expansion = (size_t) ret;
243
244 if( remaining <= expansion )
245 return( 0 );
246
247 remaining -= expansion;
248 if( remaining >= max_len )
249 remaining = max_len;
250
251 return( (int) remaining );
252}
253
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254/*
255 * Double the retransmit timeout value, within the allowed range,
256 * returning -1 if the maximum value has already been reached.
257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200259{
260 uint32_t new_timeout;
261
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200262 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200263 return( -1 );
264
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
266 * in the following way: after the initial transmission and a first
267 * retransmission, back off to a temporary estimated MTU of 508 bytes.
268 * This value is guaranteed to be deliverable (if not guaranteed to be
269 * delivered) of any compliant IPv4 (and IPv6) network, and should work
270 * on most non-IP stacks too. */
271 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400272 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200273 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
275 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200276
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200277 new_timeout = 2 * ssl->handshake->retransmit_timeout;
278
279 /* Avoid arithmetic overflow and range overflow */
280 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200281 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200282 {
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 }
285
286 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289
290 return( 0 );
291}
292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200294{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200295 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000296 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
297 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200298}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
302int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200303 const unsigned char *key_enc, const unsigned char *key_dec,
304 size_t keylen,
305 const unsigned char *iv_enc, const unsigned char *iv_dec,
306 size_t ivlen,
307 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200308 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
310int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
313int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
314#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000315
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100316/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000317 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200318 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000319
Hanno Beckerccc13d02020-05-04 12:30:04 +0100320#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
321 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100322
323static size_t ssl_compute_padding_length( size_t len,
324 size_t granularity )
325{
326 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
327}
328
Hanno Becker581bc1b2020-05-04 12:20:03 +0100329/* This functions transforms a (D)TLS plaintext fragment and a record content
330 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
331 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
332 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100333 *
334 * struct {
335 * opaque content[DTLSPlaintext.length];
336 * ContentType real_type;
337 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100338 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339 *
340 * Input:
341 * - `content`: The beginning of the buffer holding the
342 * plaintext to be wrapped.
343 * - `*content_size`: The length of the plaintext in Bytes.
344 * - `max_len`: The number of Bytes available starting from
345 * `content`. This must be `>= *content_size`.
346 * - `rec_type`: The desired record content type.
347 *
348 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100349 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
350 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100351 *
352 * Returns:
353 * - `0` on success.
354 * - A negative error code if `max_len` didn't offer enough space
355 * for the expansion.
356 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357static int ssl_build_inner_plaintext( unsigned char *content,
358 size_t *content_size,
359 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100360 uint8_t rec_type,
361 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362{
363 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100364
365 /* Write real content type */
366 if( remaining == 0 )
367 return( -1 );
368 content[ len ] = rec_type;
369 len++;
370 remaining--;
371
372 if( remaining < pad )
373 return( -1 );
374 memset( content + len, 0, pad );
375 len += pad;
376 remaining -= pad;
377
378 *content_size = len;
379 return( 0 );
380}
381
Hanno Becker581bc1b2020-05-04 12:20:03 +0100382/* This function parses a (D)TLSInnerPlaintext structure.
383 * See ssl_build_inner_plaintext() for details. */
384static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100385 size_t *content_size,
386 uint8_t *rec_type )
387{
388 size_t remaining = *content_size;
389
390 /* Determine length of padding by skipping zeroes from the back. */
391 do
392 {
393 if( remaining == 0 )
394 return( -1 );
395 remaining--;
396 } while( content[ remaining ] == 0 );
397
398 *content_size = remaining;
399 *rec_type = content[ remaining ];
400
401 return( 0 );
402}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100403#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
404 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100405
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100406/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100407 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000408static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100409 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100410 mbedtls_record *rec,
411 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000412{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100413 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100414 *
415 * additional_data = seq_num + TLSCompressed.type +
416 * TLSCompressed.version + TLSCompressed.length;
417 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100418 * For the CID extension, this is extended as follows
419 * (quoting draft-ietf-tls-dtls-connection-id-05,
420 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100421 *
422 * additional_data = seq_num + DTLSPlaintext.type +
423 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100424 * cid +
425 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100426 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100427 *
428 * For TLS 1.3, the record sequence number is dropped from the AAD
429 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 */
431
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 unsigned char *cur = add_data;
433
434#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
435 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
436#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
437 {
438 ((void) minor_ver);
439 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
440 cur += sizeof( rec->ctr );
441 }
442
443 *cur = rec->type;
444 cur++;
445
446 memcpy( cur, rec->ver, sizeof( rec->ver ) );
447 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100448
Hanno Beckera0e20d02019-05-15 14:03:01 +0100449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100450 if( rec->cid_len != 0 )
451 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100452 memcpy( cur, rec->cid, rec->cid_len );
453 cur += rec->cid_len;
454
455 *cur = rec->cid_len;
456 cur++;
457
Joe Subbianic54e9082021-07-19 11:56:54 +0100458 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 }
461 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 {
Joe Subbianic54e9082021-07-19 11:56:54 +0100464 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100465 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100466 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100467
468 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000469}
470
Hanno Becker9d062f92020-02-07 10:26:36 +0000471#if defined(MBEDTLS_SSL_PROTO_SSL3)
472
473#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
474
475/*
476 * SSLv3.0 MAC functions
477 */
478static void ssl_mac( mbedtls_md_context_t *md_ctx,
479 const unsigned char *secret,
480 const unsigned char *buf, size_t len,
481 const unsigned char *ctr, int type,
482 unsigned char out[SSL3_MAC_MAX_BYTES] )
483{
484 unsigned char header[11];
485 unsigned char padding[48];
486 int padlen;
487 int md_size = mbedtls_md_get_size( md_ctx->md_info );
488 int md_type = mbedtls_md_get_type( md_ctx->md_info );
489
490 /* Only MD5 and SHA-1 supported */
491 if( md_type == MBEDTLS_MD_MD5 )
492 padlen = 48;
493 else
494 padlen = 40;
495
496 memcpy( header, ctr, 8 );
Joe Subbiania651e6f2021-08-23 11:35:25 +0100497 header[8] = (unsigned char) type;
Joe Subbiani11b71312021-08-23 12:49:14 +0100498 MBEDTLS_PUT_UINT16_BE( len, header, 9);
Hanno Becker9d062f92020-02-07 10:26:36 +0000499
500 memset( padding, 0x36, padlen );
501 mbedtls_md_starts( md_ctx );
502 mbedtls_md_update( md_ctx, secret, md_size );
503 mbedtls_md_update( md_ctx, padding, padlen );
504 mbedtls_md_update( md_ctx, header, 11 );
505 mbedtls_md_update( md_ctx, buf, len );
506 mbedtls_md_finish( md_ctx, out );
507
508 memset( padding, 0x5C, padlen );
509 mbedtls_md_starts( md_ctx );
510 mbedtls_md_update( md_ctx, secret, md_size );
511 mbedtls_md_update( md_ctx, padding, padlen );
512 mbedtls_md_update( md_ctx, out, md_size );
513 mbedtls_md_finish( md_ctx, out );
514}
515#endif /* MBEDTLS_SSL_PROTO_SSL3 */
516
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#if defined(MBEDTLS_GCM_C) || \
518 defined(MBEDTLS_CCM_C) || \
519 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100520static int ssl_transform_aead_dynamic_iv_is_explicit(
521 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100522{
Hanno Becker17263802020-05-28 07:05:48 +0100523 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524}
525
Hanno Becker17263802020-05-28 07:05:48 +0100526/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
527 *
528 * Concretely, this occurs in two variants:
529 *
530 * a) Fixed and dynamic IV lengths add up to total IV length, giving
531 * IV = fixed_iv || dynamic_iv
532 *
Hanno Becker15952812020-06-04 13:31:46 +0100533 * This variant is used in TLS 1.2 when used with GCM or CCM.
534 *
Hanno Becker17263802020-05-28 07:05:48 +0100535 * b) Fixed IV lengths matches total IV length, giving
536 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100537 *
538 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
539 *
540 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100541 *
542 * This function has the precondition that
543 *
544 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
545 *
546 * which has to be ensured by the caller. If this precondition
547 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100548 */
549static void ssl_build_record_nonce( unsigned char *dst_iv,
550 size_t dst_iv_len,
551 unsigned char const *fixed_iv,
552 size_t fixed_iv_len,
553 unsigned char const *dynamic_iv,
554 size_t dynamic_iv_len )
555{
556 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100557
558 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100559 memset( dst_iv, 0, dst_iv_len );
560 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100561
Hanno Becker17263802020-05-28 07:05:48 +0100562 dst_iv += dst_iv_len - dynamic_iv_len;
563 for( i = 0; i < dynamic_iv_len; i++ )
564 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100565}
Hanno Becker67a37db2020-05-28 16:27:07 +0100566#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567
Hanno Beckera18d1322018-01-03 14:27:32 +0000568int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
569 mbedtls_ssl_transform *transform,
570 mbedtls_record *rec,
571 int (*f_rng)(void *, unsigned char *, size_t),
572 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000573{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100575 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100577 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100578 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000579 size_t post_avail;
580
581 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000582#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200583 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000584 ((void) ssl);
585#endif
586
587 /* The PRNG is used for dynamic IV generation that's used
588 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200589#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000590 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
591 ((void) f_rng);
592 ((void) p_rng);
593#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000597 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100598 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
601 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100602 if( rec == NULL
603 || rec->buf == NULL
604 || rec->buf_len < rec->data_offset
605 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100607 || rec->cid_len != 0
608#endif
609 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000610 {
611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100613 }
614
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000615 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000618 data, rec->data_len );
619
620 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
621
622 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
623 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
625 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000626 rec->data_len,
627 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000628 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
629 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100630
Hanno Becker92313402020-05-20 13:58:58 +0100631 /* The following two code paths implement the (D)TLSInnerPlaintext
632 * structure present in TLS 1.3 and DTLS 1.2 + CID.
633 *
634 * See ssl_build_inner_plaintext() for more information.
635 *
636 * Note that this changes `rec->data_len`, and hence
637 * `post_avail` needs to be recalculated afterwards.
638 *
639 * Note also that the two code paths cannot occur simultaneously
640 * since they apply to different versions of the protocol. There
641 * is hence no risk of double-addition of the inner plaintext.
642 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100643#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
644 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
645 {
Hanno Becker13996922020-05-28 16:15:19 +0100646 size_t padding =
647 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100648 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100649 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100650 &rec->data_len,
651 post_avail,
652 rec->type,
653 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100654 {
655 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
656 }
657
658 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
659 }
660#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
661
Hanno Beckera0e20d02019-05-15 14:03:01 +0100662#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100663 /*
664 * Add CID information
665 */
666 rec->cid_len = transform->out_cid_len;
667 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
668 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100669
670 if( rec->cid_len != 0 )
671 {
Hanno Becker13996922020-05-28 16:15:19 +0100672 size_t padding =
673 ssl_compute_padding_length( rec->data_len,
674 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100675 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100676 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100677 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100678 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100679 * Note that this changes `rec->data_len`, and hence
680 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100681 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100682 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100683 &rec->data_len,
684 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100685 rec->type,
686 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100687 {
688 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
689 }
690
691 rec->type = MBEDTLS_SSL_MSG_CID;
692 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100694
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100695 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
696
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100698 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000699 */
Hanno Becker52344c22018-01-03 15:24:20 +0000700#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 if( mode == MBEDTLS_MODE_STREAM ||
702 ( mode == MBEDTLS_MODE_CBC
703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100705#endif
706 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000707 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000708 if( post_avail < transform->maclen )
709 {
710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
711 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
712 }
713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200716 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000717 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000718 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
719 data, rec->data_len, rec->ctr, rec->type, mac );
720 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200721 }
722 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200723#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
725 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200727 {
Hanno Becker992b6872017-11-09 18:57:39 +0000728 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
729
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100730 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
731 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000732
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100734 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000735 mbedtls_md_hmac_update( &transform->md_ctx_enc,
736 data, rec->data_len );
737 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
738 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
739
740 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200741 }
742 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200743#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200747 }
748
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
750 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200751
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 rec->data_len += transform->maclen;
753 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100754 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200755 }
Hanno Becker52344c22018-01-03 15:24:20 +0000756#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000757
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200758 /*
759 * Encrypt
760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
762 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000763 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000767 "including %d bytes of padding",
768 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000769
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
771 transform->iv_enc, transform->ivlen,
772 data, rec->data_len,
773 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200776 return( ret );
777 }
778
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
782 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200783 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 }
Paul Bakker68884e32013-01-07 18:20:04 +0100785 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000787
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200788#if defined(MBEDTLS_GCM_C) || \
789 defined(MBEDTLS_CCM_C) || \
790 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792 mode == MBEDTLS_MODE_CCM ||
793 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000794 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200796 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797 unsigned char *dynamic_iv;
798 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100799 int dynamic_iv_is_explicit =
800 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000801
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100802 /* Check that there's space for the authentication tag. */
803 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 {
805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
806 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
807 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000808
Paul Bakker68884e32013-01-07 18:20:04 +0100809 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100810 * Build nonce for AEAD encryption.
811 *
812 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
813 * part of the IV is prepended to the ciphertext and
814 * can be chosen freely - in particular, it need not
815 * agree with the record sequence number.
816 * However, since ChaChaPoly as well as all AEAD modes
817 * in TLS 1.3 use the record sequence number as the
818 * dynamic part of the nonce, we uniformly use the
819 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100820 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100821 dynamic_iv = rec->ctr;
822 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200823
Hanno Becker17263802020-05-28 07:05:48 +0100824 ssl_build_record_nonce( iv, sizeof( iv ),
825 transform->iv_enc,
826 transform->fixed_ivlen,
827 dynamic_iv,
828 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100829
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100830 /*
831 * Build additional data for AEAD encryption.
832 * This depends on the TLS version.
833 */
834 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
835 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100836
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200837 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100838 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200839 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100840 dynamic_iv,
841 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100843 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000844 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000847
Paul Bakker68884e32013-01-07 18:20:04 +0100848 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200849 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200850 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000851
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100852 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100854 add_data, add_data_len,
855 data, rec->data_len, /* src */
856 data, rec->buf_len - (data - rec->buf), /* dst */
857 &rec->data_len,
858 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 return( ret );
862 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100864 data + rec->data_len - transform->taglen,
865 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868
869 /*
870 * Prefix record content with dynamic IV in case it is explicit.
871 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100872 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100873 {
874 if( rec->data_offset < dynamic_iv_len )
875 {
876 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
877 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
878 }
879
880 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
881 rec->data_offset -= dynamic_iv_len;
882 rec->data_len += dynamic_iv_len;
883 }
884
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100885 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000886 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100888#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200889#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 size_t padlen, i;
894 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 /* Currently we're always using minimal padding
897 * (up to 255 bytes would be allowed). */
898 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
899 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 padlen = 0;
901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 /* Check there's enough space in the buffer for the padding. */
903 if( post_avail < padlen + 1 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
906 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
907 }
908
Paul Bakker5121ce52009-01-03 21:22:43 +0000909 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 rec->data_len += padlen + 1;
913 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000916 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
918 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000919 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000920 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 if( f_rng == NULL )
923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
926 }
927
928 if( rec->data_offset < transform->ivlen )
929 {
930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
932 }
933
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 /*
935 * Generate IV
936 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000938 if( ret != 0 )
939 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 memcpy( data - transform->ivlen, transform->iv_enc,
942 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000946
Paul Elliottd48d5c62021-01-07 14:47:05 +0000947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
948 "including %" MBEDTLS_PRINTF_SIZET
949 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000950 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200951 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
954 transform->iv_enc,
955 transform->ivlen,
956 data, rec->data_len,
957 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200960 return( ret );
961 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200967 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000970 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200971 {
972 /*
973 * Save IV in SSL3 and TLS1
974 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000975 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
976 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200979#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 {
981 data -= transform->ivlen;
982 rec->data_offset -= transform->ivlen;
983 rec->data_len += transform->ivlen;
984 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100987 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100988 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000989 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
990
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100991 /*
992 * MAC(MAC_write_key, seq_num +
993 * TLSCipherText.type +
994 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100995 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100996 * IV + // except for TLS 1.0
997 * ENC(content + padding + padding_length));
998 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999
1000 if( post_avail < transform->maclen)
1001 {
1002 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1003 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1004 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001006 ssl_extract_add_data_from_record( add_data, &add_data_len,
1007 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001010 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001011 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001012
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001013 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001014 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001015 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1016 data, rec->data_len );
1017 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1018 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001019
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001021
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 rec->data_len += transform->maclen;
1023 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001028 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001034
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001035 /* Make extra sure authentication was performed, exactly once */
1036 if( auth_done != 1 )
1037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001040 }
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001043
1044 return( 0 );
1045}
1046
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001048/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001049 * Constant-flow boolean "equal" comparison:
1050 * return x == y
1051 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001052 * This function can be used to write constant-time code by replacing branches
1053 * with bit operations - it can be used in conjunction with
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001054 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001055 *
1056 * This function is implemented without using comparison operators, as those
1057 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001058 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001059static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001060{
1061 /* diff = 0 if x == y, non-zero otherwise */
1062 const size_t diff = x ^ y;
1063
1064 /* MSVC has a warning about unary minus on unsigned integer types,
1065 * but this is well-defined and precisely what we want to do here. */
1066#if defined(_MSC_VER)
1067#pragma warning( push )
1068#pragma warning( disable : 4146 )
1069#endif
1070
1071 /* diff_msb's most significant bit is equal to x != y */
1072 const size_t diff_msb = ( diff | -diff );
1073
1074#if defined(_MSC_VER)
1075#pragma warning( pop )
1076#endif
1077
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001078 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001079 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1080
1081 return( 1 ^ diff1 );
1082}
1083
1084/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001085 * Constant-flow conditional memcpy:
1086 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1087 * - otherwise, a no-op,
1088 * but with execution flow independent of the values of c1 and c2.
1089 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001090 * This function is implemented without using comparison operators, as those
1091 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001092 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001093static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1094 const unsigned char *src,
1095 size_t len,
1096 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001097{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001098 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001099 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1100 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001101
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001102 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001103 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001104 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001105}
1106
1107/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001108 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001109 *
1110 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1111 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001112 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001113MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001114 mbedtls_md_context_t *ctx,
1115 const unsigned char *add_data, size_t add_data_len,
1116 const unsigned char *data, size_t data_len_secret,
1117 size_t min_data_len, size_t max_data_len,
1118 unsigned char *output )
1119{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001120 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001121 * This function breaks the HMAC abstraction and uses the md_clone()
1122 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001123 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001124 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001125 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001126 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001127 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001128 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1129 * minlen, then cloning the context, and for each byte up to maxlen
1130 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001131 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001132 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001133 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001134 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001135 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1136 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001137 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001138 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001139 const unsigned char * const okey = ikey + block_size;
1140 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001141
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001142 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1143 mbedtls_md_context_t aux;
1144 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001146
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001147 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001148
1149#define MD_CHK( func_call ) \
1150 do { \
1151 ret = (func_call); \
1152 if( ret != 0 ) \
1153 goto cleanup; \
1154 } while( 0 )
1155
1156 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001157
1158 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1159 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001160 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1161 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001162
1163 /* For each possible length, compute the hash up to that point */
1164 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001165 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001166 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1167 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001168 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001169 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1170 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001171
1172 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001173 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001174 }
1175
Manuel Pégourié-Gonnard21bfbdd2021-05-17 12:28:08 +02001176 /* The context needs to finish() before it starts() again */
1177 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1178
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001179 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001180 MD_CHK( mbedtls_md_starts( ctx ) );
1181 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1182 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1183 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001184
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001185 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001186 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001187
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001188#undef MD_CHK
1189
1190cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001191 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001192 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001193}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001194
1195/*
1196 * Constant-flow memcpy from variable position in buffer.
1197 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001198 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001199 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001200MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001201 unsigned char *dst,
1202 const unsigned char *src_base,
1203 size_t offset_secret,
1204 size_t offset_min, size_t offset_max,
1205 size_t len )
1206{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001207 size_t offset;
1208
1209 for( offset = offset_min; offset <= offset_max; offset++ )
1210 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001211 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1212 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001213 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001214}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001215#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001216
Hanno Becker605949f2019-07-12 08:23:59 +01001217int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001218 mbedtls_ssl_transform *transform,
1219 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001220{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001221 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001223 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001224#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001225 size_t padlen = 0, correct = 1;
1226#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001227 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001228 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001229 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001230
Hanno Beckera18d1322018-01-03 14:27:32 +00001231#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001232 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001233 ((void) ssl);
1234#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001237 if( rec == NULL ||
1238 rec->buf == NULL ||
1239 rec->buf_len < rec->data_offset ||
1240 rec->buf_len - rec->data_offset < rec->data_len )
1241 {
1242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001244 }
1245
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246 data = rec->buf + rec->data_offset;
1247 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001248
Hanno Beckera0e20d02019-05-15 14:03:01 +01001249#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001250 /*
1251 * Match record's CID with incoming CID.
1252 */
Hanno Becker938489a2019-05-08 13:02:22 +01001253 if( rec->cid_len != transform->in_cid_len ||
1254 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1255 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001256 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001257 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001258#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1261 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001262 {
1263 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1265 transform->iv_dec,
1266 transform->ivlen,
1267 data, rec->data_len,
1268 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001269 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001271 return( ret );
1272 }
1273
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001274 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001275 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1277 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001278 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001279 }
Paul Bakker68884e32013-01-07 18:20:04 +01001280 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001282#if defined(MBEDTLS_GCM_C) || \
1283 defined(MBEDTLS_CCM_C) || \
1284 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001286 mode == MBEDTLS_MODE_CCM ||
1287 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001288 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001289 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001290 unsigned char *dynamic_iv;
1291 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001292
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001293 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001294 * Extract dynamic part of nonce for AEAD decryption.
1295 *
1296 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1297 * part of the IV is prepended to the ciphertext and
1298 * can be chosen freely - in particular, it need not
1299 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001300 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001301 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001302 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001303 {
1304 if( rec->data_len < dynamic_iv_len )
1305 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001306 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1307 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001308 rec->data_len,
1309 dynamic_iv_len ) );
1310 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1311 }
1312 dynamic_iv = data;
1313
1314 data += dynamic_iv_len;
1315 rec->data_offset += dynamic_iv_len;
1316 rec->data_len -= dynamic_iv_len;
1317 }
Hanno Becker17263802020-05-28 07:05:48 +01001318 else
1319 {
1320 dynamic_iv = rec->ctr;
1321 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001322
1323 /* Check that there's space for the authentication tag. */
1324 if( rec->data_len < transform->taglen )
1325 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001326 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1327 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001328 rec->data_len,
1329 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001331 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001332 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001333
Hanno Beckerdf8be222020-05-21 15:30:57 +01001334 /*
1335 * Prepare nonce from dynamic and static parts.
1336 */
Hanno Becker17263802020-05-28 07:05:48 +01001337 ssl_build_record_nonce( iv, sizeof( iv ),
1338 transform->iv_dec,
1339 transform->fixed_ivlen,
1340 dynamic_iv,
1341 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001342
Hanno Beckerdf8be222020-05-21 15:30:57 +01001343 /*
1344 * Build additional data for AEAD encryption.
1345 * This depends on the TLS version.
1346 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001347 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1348 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001349 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001350 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001351
Hanno Beckerd96a6522019-07-10 13:55:25 +01001352 /* Because of the check above, we know that there are
1353 * explicit_iv_len Bytes preceeding data, and taglen
1354 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001355 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001356 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001357
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001358 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001359 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001360 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001361
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001362 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001363 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001364 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001365 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001367 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001368 data, rec->data_len + transform->taglen, /* src */
1369 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001370 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001371 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1375 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001376
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001377 return( ret );
1378 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001379 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001380
Hanno Beckerd96a6522019-07-10 13:55:25 +01001381 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001382 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001383 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001384 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1385 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001386 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001387 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001392 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001393 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001394
Paul Bakker5121ce52009-01-03 21:22:43 +00001395 /*
Paul Bakker45829992013-01-03 14:52:21 +01001396 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001398#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001399 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1400 {
1401 /* The ciphertext is prefixed with the CBC IV. */
1402 minlen += transform->ivlen;
1403 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001404#endif
Paul Bakker45829992013-01-03 14:52:21 +01001405
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001406 /* Size considerations:
1407 *
1408 * - The CBC cipher text must not be empty and hence
1409 * at least of size transform->ivlen.
1410 *
1411 * Together with the potential IV-prefix, this explains
1412 * the first of the two checks below.
1413 *
1414 * - The record must contain a MAC, either in plain or
1415 * encrypted, depending on whether Encrypt-then-MAC
1416 * is used or not.
1417 * - If it is, the message contains the IV-prefix,
1418 * the CBC ciphertext, and the MAC.
1419 * - If it is not, the padded plaintext, and hence
1420 * the CBC ciphertext, has at least length maclen + 1
1421 * because there is at least the padding length byte.
1422 *
1423 * As the CBC ciphertext is not empty, both cases give the
1424 * lower bound minlen + maclen + 1 on the record size, which
1425 * we test for in the second check below.
1426 */
1427 if( rec->data_len < minlen + transform->ivlen ||
1428 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001429 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1431 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1432 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 "+ 1 ) ( + expl IV )", rec->data_len,
1434 transform->ivlen,
1435 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001437 }
1438
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001439 /*
1440 * Authenticate before decrypt if enabled
1441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001442#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001443 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001444 {
Hanno Becker992b6872017-11-09 18:57:39 +00001445 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001446
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001448
Hanno Beckerd96a6522019-07-10 13:55:25 +01001449 /* Update data_len in tandem with add_data.
1450 *
1451 * The subtraction is safe because of the previous check
1452 * data_len >= minlen + maclen + 1.
1453 *
1454 * Afterwards, we know that data + data_len is followed by at
1455 * least maclen Bytes, which justifies the call to
1456 * mbedtls_ssl_safer_memcmp() below.
1457 *
1458 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001460 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1461 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001462
Hanno Beckerd96a6522019-07-10 13:55:25 +01001463 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001464 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1465 add_data_len );
1466 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1467 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001468 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1469 data, rec->data_len );
1470 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1471 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001472
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001473 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1474 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001475 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001476 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001477
Hanno Beckerd96a6522019-07-10 13:55:25 +01001478 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001479 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1480 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001484 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001485 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001486 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001488
1489 /*
1490 * Check length sanity
1491 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001492
1493 /* We know from above that data_len > minlen >= 0,
1494 * so the following check in particular implies that
1495 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001496 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001497 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001498 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1499 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001502 }
1503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001505 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001506 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001507 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001509 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001510 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001511 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001512
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001513 data += transform->ivlen;
1514 rec->data_offset += transform->ivlen;
1515 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001516 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001518
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1520
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1522 transform->iv_dec, transform->ivlen,
1523 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001526 return( ret );
1527 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001528
Hanno Beckerd96a6522019-07-10 13:55:25 +01001529 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001530 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1533 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001534 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001538 {
1539 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001540 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1541 * records is equivalent to CBC decryption of the concatenation
1542 * of the records; in other words, IVs are maintained across
1543 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001544 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001545 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1546 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001547 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001548#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 /* Safe since data_len >= minlen + maclen + 1, so after having
1551 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001552 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1553 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001554 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001555
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556 if( auth_done == 1 )
1557 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001558 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001559 rec->data_len,
1560 padlen + 1 );
1561 correct &= mask;
1562 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001563 }
1564 else
Paul Bakker45829992013-01-03 14:52:21 +01001565 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567 if( rec->data_len < transform->maclen + padlen + 1 )
1568 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1570 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1571 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001572 rec->data_len,
1573 transform->maclen,
1574 padlen + 1 ) );
1575 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001576#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001577
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001578 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001579 rec->data_len,
1580 transform->maclen + padlen + 1 );
1581 correct &= mask;
1582 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001583 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001584
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001585 padlen++;
1586
1587 /* Regardless of the validity of the padding,
1588 * we have data_len >= padlen here. */
1589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001591 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001592 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001593 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1594 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001595 * the protocol (known as part of POODLE), so we don't care if the
1596 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001597 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001600 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1601 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001602 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001603#endif
Paul Bakker45829992013-01-03 14:52:21 +01001604 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001605 }
1606 }
1607 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1609#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1610 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001611 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001612 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001613 /* The padding check involves a series of up to 256
1614 * consecutive memory reads at the end of the record
1615 * plaintext buffer. In order to hide the length and
1616 * validity of the padding, always perform exactly
1617 * `min(256,plaintext_len)` reads (but take into account
1618 * only the last `padlen` bytes for the padding check). */
1619 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001621
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001622 /* Index of first padding byte; it has been ensured above
1623 * that the subtraction is safe. */
1624 size_t const padding_idx = rec->data_len - padlen;
1625 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1626 size_t const start_idx = rec->data_len - num_checks;
1627 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001628
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001629 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001630 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001631 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001632 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001633 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001634 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1635 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1636 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001637 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001638 }
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001639 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001642 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001644#endif
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001645 padlen &= mbedtls_cf_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001646 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001647 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1649 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001650 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1652 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001653 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001654
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001655 /* If the padding was found to be invalid, padlen == 0
1656 * and the subtraction is safe. If the padding was found valid,
1657 * padlen hasn't been changed and the previous assertion
1658 * data_len >= padlen still holds. */
1659 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001660 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001661 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001662#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001663 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1665 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001666 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001667
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001668#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001670 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001671#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001672
1673 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001674 * Authenticate if not done yet.
1675 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 */
Hanno Becker52344c22018-01-03 15:24:20 +00001677#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001678 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001679 {
Hanno Becker992b6872017-11-09 18:57:39 +00001680 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001681 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001682
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001683 /* If the initial value of padlen was such that
1684 * data_len < maclen + padlen + 1, then padlen
1685 * got reset to 1, and the initial check
1686 * data_len >= minlen + maclen + 1
1687 * guarantees that at this point we still
1688 * have at least data_len >= maclen.
1689 *
1690 * If the initial value of padlen was such that
1691 * data_len >= maclen + padlen + 1, then we have
1692 * subtracted either padlen + 1 (if the padding was correct)
1693 * or 0 (if the padding was incorrect) since then,
1694 * hence data_len >= maclen in any case.
1695 */
1696 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001697 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1698 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001701 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001702 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001703 ssl_mac( &transform->md_ctx_dec,
1704 transform->mac_dec,
1705 data, rec->data_len,
1706 rec->ctr, rec->type,
1707 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001708 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001709 }
1710 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1712#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1713 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001714 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001715 {
1716 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001717 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001718 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001719 *
1720 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001721 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001722 *
1723 * Note that max_len + maclen is never more than the buffer
1724 * length, as we previously did in_msglen -= maclen too.
1725 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001726 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001727 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1728
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001729 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1730 add_data, add_data_len,
1731 data, rec->data_len, min_len, max_len,
1732 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001733 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001734 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001735 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1736 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001737 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001738
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001739 mbedtls_cf_memcpy_offset( mac_peer, data,
1740 rec->data_len,
1741 min_len, max_len,
1742 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001743 }
1744 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1746 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001747 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1749 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001750 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001751
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001752#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001753 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001754 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001755#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001756
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001757 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001758 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760#if defined(MBEDTLS_SSL_DEBUG_ALL)
1761 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001762#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001763 correct = 0;
1764 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001765 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001766 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001767
1768 /*
1769 * Finally check the correct flag
1770 */
1771 if( correct == 0 )
1772 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001773#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001774
1775 /* Make extra sure authentication was performed, exactly once */
1776 if( auth_done != 1 )
1777 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1779 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001780 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001781
Hanno Beckerccc13d02020-05-04 12:30:04 +01001782#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1783 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1784 {
1785 /* Remove inner padding and infer true content type. */
1786 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1787 &rec->type );
1788
1789 if( ret != 0 )
1790 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1791 }
1792#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1793
Hanno Beckera0e20d02019-05-15 14:03:01 +01001794#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001795 if( rec->cid_len != 0 )
1796 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001797 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1798 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001799 if( ret != 0 )
1800 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1801 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001802#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001805
1806 return( 0 );
1807}
1808
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001809#undef MAC_NONE
1810#undef MAC_PLAINTEXT
1811#undef MAC_CIPHERTEXT
1812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814/*
1815 * Compression/decompression functions
1816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001818{
Janos Follath865b3eb2019-12-16 11:46:15 +00001819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001820 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001821 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001822 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001823 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001824#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1825 size_t out_buf_len = ssl->out_buf_len;
1826#else
1827 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1828#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001831
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001832 if( len_pre == 0 )
1833 return( 0 );
1834
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835 memcpy( msg_pre, ssl->out_msg, len_pre );
1836
Paul Elliottd48d5c62021-01-07 14:47:05 +00001837 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838 ssl->out_msglen ) );
1839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001841 ssl->out_msg, ssl->out_msglen );
1842
Paul Bakker48916f92012-09-16 19:57:18 +00001843 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1844 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1845 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001846 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001847
Paul Bakker48916f92012-09-16 19:57:18 +00001848 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001849 if( ret != Z_OK )
1850 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1852 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001853 }
1854
Darryl Greenb33cc762019-11-28 14:29:44 +00001855 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001856 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001857
Paul Elliottd48d5c62021-01-07 14:47:05 +00001858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001859 ssl->out_msglen ) );
1860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001862 ssl->out_msg, ssl->out_msglen );
1863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001865
1866 return( 0 );
1867}
1868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001870{
Janos Follath865b3eb2019-12-16 11:46:15 +00001871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001872 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001873 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001875 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001876#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1877 size_t in_buf_len = ssl->in_buf_len;
1878#else
1879 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1880#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001883
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001884 if( len_pre == 0 )
1885 return( 0 );
1886
Paul Bakker2770fbd2012-07-03 13:30:23 +00001887 memcpy( msg_pre, ssl->in_msg, len_pre );
1888
Paul Elliottd48d5c62021-01-07 14:47:05 +00001889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001890 ssl->in_msglen ) );
1891
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001893 ssl->in_msg, ssl->in_msglen );
1894
Paul Bakker48916f92012-09-16 19:57:18 +00001895 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1896 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1897 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001898 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001899
Paul Bakker48916f92012-09-16 19:57:18 +00001900 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001901 if( ret != Z_OK )
1902 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1904 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001905 }
1906
Darryl Greenb33cc762019-11-28 14:29:44 +00001907 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001908 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001909
Paul Elliottd48d5c62021-01-07 14:47:05 +00001910 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001911 ssl->in_msglen ) );
1912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001914 ssl->in_msg, ssl->in_msglen );
1915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001917
1918 return( 0 );
1919}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001921
Paul Bakker5121ce52009-01-03 21:22:43 +00001922/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001923 * Fill the input message buffer by appending data to it.
1924 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001925 *
1926 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1927 * available (from this read and/or a previous one). Otherwise, an error code
1928 * is returned (possibly EOF or WANT_READ).
1929 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001930 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1931 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1932 * since we always read a whole datagram at once.
1933 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001934 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001935 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001938{
Janos Follath865b3eb2019-12-16 11:46:15 +00001939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001940 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001941#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1942 size_t in_buf_len = ssl->in_buf_len;
1943#else
1944 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1945#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001948
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001949 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1950 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001952 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001954 }
1955
Darryl Greenb33cc762019-11-28 14:29:44 +00001956 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1959 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001960 }
1961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001964 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001965 uint32_t timeout;
1966
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001967 /*
1968 * The point is, we need to always read a full datagram at once, so we
1969 * sometimes read more then requested, and handle the additional data.
1970 * It could be the rest of the current record (while fetching the
1971 * header) and/or some other records in the same datagram.
1972 */
1973
1974 /*
1975 * Move to the next record in the already read datagram if applicable
1976 */
1977 if( ssl->next_record_offset != 0 )
1978 {
1979 if( ssl->in_left < ssl->next_record_offset )
1980 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001983 }
1984
1985 ssl->in_left -= ssl->next_record_offset;
1986
1987 if( ssl->in_left != 0 )
1988 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1990 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001991 ssl->next_record_offset ) );
1992 memmove( ssl->in_hdr,
1993 ssl->in_hdr + ssl->next_record_offset,
1994 ssl->in_left );
1995 }
1996
1997 ssl->next_record_offset = 0;
1998 }
1999
Paul Elliottd48d5c62021-01-07 14:47:05 +00002000 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2001 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00002002 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002003
2004 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002005 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002006 */
2007 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002008 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002010 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002011 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002012
2013 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002014 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002015 * are not at the beginning of a new record, the caller did something
2016 * wrong.
2017 */
2018 if( ssl->in_left != 0 )
2019 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2021 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002022 }
2023
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002024 /*
2025 * Don't even try to read if time's out already.
2026 * This avoids by-passing the timer when repeatedly receiving messages
2027 * that will end up being dropped.
2028 */
Hanno Becker7876d122020-02-05 10:39:31 +00002029 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002030 {
2031 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002032 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002033 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002034 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002035 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002036 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002039 timeout = ssl->handshake->retransmit_timeout;
2040 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002041 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002042
Paul Elliott9f352112020-12-09 14:55:45 +00002043 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002044
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002045 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002046 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2047 timeout );
2048 else
2049 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002052
2053 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002055 }
2056
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002057 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002060 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002063 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002064 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002067 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002068 }
2069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002073 return( ret );
2074 }
2075
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002076 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002077 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002079 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002081 {
Hanno Becker786300f2020-02-05 10:46:40 +00002082 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002083 {
Hanno Becker786300f2020-02-05 10:46:40 +00002084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2085 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002086 return( ret );
2087 }
2088
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002089 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002090 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002092 }
2093
Paul Bakker5121ce52009-01-03 21:22:43 +00002094 if( ret < 0 )
2095 return( ret );
2096
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002097 ssl->in_left = ret;
2098 }
2099 else
2100#endif
2101 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2103 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002104 ssl->in_left, nb_want ) );
2105
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002106 while( ssl->in_left < nb_want )
2107 {
2108 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002109
Hanno Becker7876d122020-02-05 10:39:31 +00002110 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002111 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2112 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002113 {
2114 if( ssl->f_recv_timeout != NULL )
2115 {
2116 ret = ssl->f_recv_timeout( ssl->p_bio,
2117 ssl->in_hdr + ssl->in_left, len,
2118 ssl->conf->read_timeout );
2119 }
2120 else
2121 {
2122 ret = ssl->f_recv( ssl->p_bio,
2123 ssl->in_hdr + ssl->in_left, len );
2124 }
2125 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002126
Paul Elliottd48d5c62021-01-07 14:47:05 +00002127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2128 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002129 ssl->in_left, nb_want ) );
2130 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002131
2132 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002134
2135 if( ret < 0 )
2136 return( ret );
2137
makise-homuraaf9513b2020-08-24 18:26:27 +03002138 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002139 {
Darryl Green11999bb2018-03-13 15:22:58 +00002140 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002141 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002142 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002143 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2144 }
2145
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002146 ssl->in_left += ret;
2147 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 }
2149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002151
2152 return( 0 );
2153}
2154
2155/*
2156 * Flush any data not yet written
2157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002159{
Janos Follath865b3eb2019-12-16 11:46:15 +00002160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002161 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002164
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002165 if( ssl->f_send == NULL )
2166 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002168 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002170 }
2171
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002172 /* Avoid incrementing counter if data is flushed */
2173 if( ssl->out_left == 0 )
2174 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002176 return( 0 );
2177 }
2178
Paul Bakker5121ce52009-01-03 21:22:43 +00002179 while( ssl->out_left > 0 )
2180 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2182 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002183 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002184
Hanno Becker2b1e3542018-08-06 11:19:13 +01002185 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002186 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002189
2190 if( ret <= 0 )
2191 return( ret );
2192
makise-homuraaf9513b2020-08-24 18:26:27 +03002193 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002194 {
Darryl Green11999bb2018-03-13 15:22:58 +00002195 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002196 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002197 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002198 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2199 }
2200
Paul Bakker5121ce52009-01-03 21:22:43 +00002201 ssl->out_left -= ret;
2202 }
2203
Hanno Becker2b1e3542018-08-06 11:19:13 +01002204#if defined(MBEDTLS_SSL_PROTO_DTLS)
2205 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002206 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002207 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002208 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002209 else
2210#endif
2211 {
2212 ssl->out_hdr = ssl->out_buf + 8;
2213 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002214 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002217
2218 return( 0 );
2219}
2220
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002221/*
2222 * Functions to handle the DTLS retransmission state machine
2223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002225/*
2226 * Append current handshake message to current outgoing flight
2227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002228static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002229{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002231 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2232 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2233 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002234
2235 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002236 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002237 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002238 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002240 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002241 }
2242
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002243 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002245 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2246 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002248 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002249 }
2250
2251 /* Copy current handshake message with headers */
2252 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2253 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002255 msg->next = NULL;
2256
2257 /* Append to the current flight */
2258 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002259 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260 else
2261 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002263 while( cur->next != NULL )
2264 cur = cur->next;
2265 cur->next = msg;
2266 }
2267
Hanno Becker3b235902018-08-06 09:54:53 +01002268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002269 return( 0 );
2270}
2271
2272/*
2273 * Free the current flight of handshake messages
2274 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002275void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 mbedtls_ssl_flight_item *cur = flight;
2278 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002279
2280 while( cur != NULL )
2281 {
2282 next = cur->next;
2283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284 mbedtls_free( cur->p );
2285 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002286
2287 cur = next;
2288 }
2289}
2290
2291/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002292 * Swap transform_out and out_ctr with the alternative ones
2293 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002294static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002295{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002296 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002297 unsigned char tmp_out_ctr[8];
2298
2299 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2300 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002301 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002302 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002303 }
2304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002306
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002307 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002308 tmp_transform = ssl->transform_out;
2309 ssl->transform_out = ssl->handshake->alt_transform_out;
2310 ssl->handshake->alt_transform_out = tmp_transform;
2311
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002312 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002313 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2314 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002315 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002316
2317 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002318 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002320#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2321 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002322 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002323 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2324 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002325 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2327 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002328 }
2329 }
2330#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002331
2332 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002333}
2334
2335/*
2336 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002337 */
2338int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2339{
2340 int ret = 0;
2341
2342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2343
2344 ret = mbedtls_ssl_flight_transmit( ssl );
2345
2346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2347
2348 return( ret );
2349}
2350
2351/*
2352 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002353 *
2354 * Need to remember the current message in case flush_output returns
2355 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002356 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002357 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002358int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002359{
Janos Follath865b3eb2019-12-16 11:46:15 +00002360 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002361 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002364 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002365 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002366
2367 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002368 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002369 ret = ssl_swap_epochs( ssl );
2370 if( ret != 0 )
2371 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002374 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002375
2376 while( ssl->handshake->cur_msg != NULL )
2377 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002378 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002380
Hanno Beckere1dcb032018-08-17 16:47:58 +01002381 int const is_finished =
2382 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2383 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2384
Hanno Becker04da1892018-08-14 13:22:10 +01002385 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2386 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2387
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002388 /* Swap epochs before sending Finished: we can't do it after
2389 * sending ChangeCipherSpec, in case write returns WANT_READ.
2390 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002391 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002392 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002393 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002394 ret = ssl_swap_epochs( ssl );
2395 if( ret != 0 )
2396 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002397 }
2398
Hanno Becker67bc7c32018-08-06 11:33:50 +01002399 ret = ssl_get_remaining_payload_in_datagram( ssl );
2400 if( ret < 0 )
2401 return( ret );
2402 max_frag_len = (size_t) ret;
2403
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002404 /* CCS is copied as is, while HS messages may need fragmentation */
2405 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2406 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002407 if( max_frag_len == 0 )
2408 {
2409 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2410 return( ret );
2411
2412 continue;
2413 }
2414
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002415 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002416 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002417 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002418
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002419 /* Update position inside current message */
2420 ssl->handshake->cur_msg_p += cur->len;
2421 }
2422 else
2423 {
2424 const unsigned char * const p = ssl->handshake->cur_msg_p;
2425 const size_t hs_len = cur->len - 12;
2426 const size_t frag_off = p - ( cur->p + 12 );
2427 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002428 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002429
Hanno Beckere1dcb032018-08-17 16:47:58 +01002430 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002431 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002432 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002433 {
2434 ret = ssl_swap_epochs( ssl );
2435 if( ret != 0 )
2436 return( ret );
2437 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002438
Hanno Becker67bc7c32018-08-06 11:33:50 +01002439 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2440 return( ret );
2441
2442 continue;
2443 }
2444 max_hs_frag_len = max_frag_len - 12;
2445
2446 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2447 max_hs_frag_len : rem_len;
2448
2449 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002450 {
2451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002452 (unsigned) cur_hs_frag_len,
2453 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002454 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002455
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002456 /* Messages are stored with handshake headers as if not fragmented,
2457 * copy beginning of headers then fill fragmentation fields.
2458 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2459 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002460
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002461 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2462 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2463 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002465 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2466 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2467 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002468
2469 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2470
Hanno Becker3f7b9732018-08-28 09:53:25 +01002471 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002472 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2473 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002474 ssl->out_msgtype = cur->type;
2475
2476 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002477 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002478 }
2479
2480 /* If done with the current message move to the next one if any */
2481 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2482 {
2483 if( cur->next != NULL )
2484 {
2485 ssl->handshake->cur_msg = cur->next;
2486 ssl->handshake->cur_msg_p = cur->next->p + 12;
2487 }
2488 else
2489 {
2490 ssl->handshake->cur_msg = NULL;
2491 ssl->handshake->cur_msg_p = NULL;
2492 }
2493 }
2494
2495 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002496 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002499 return( ret );
2500 }
2501 }
2502
Hanno Becker67bc7c32018-08-06 11:33:50 +01002503 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2504 return( ret );
2505
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002506 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2508 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002509 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002512 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002513 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002514
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002515 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002516
2517 return( 0 );
2518}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002519
2520/*
2521 * To be called when the last message of an incoming flight is received.
2522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002524{
2525 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002526 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002527 ssl->handshake->flight = NULL;
2528 ssl->handshake->cur_msg = NULL;
2529
2530 /* The next incoming flight will start with this msg_seq */
2531 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2532
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002533 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002534 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002535
Hanno Becker0271f962018-08-16 13:23:47 +01002536 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002537 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002538
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002539 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002540 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2543 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002544 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546 }
2547 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002549}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002550
2551/*
2552 * To be called when the last message of an outgoing flight is send.
2553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002555{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002556 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002557 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2560 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002563 }
2564 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002566}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002568
Paul Bakker5121ce52009-01-03 21:22:43 +00002569/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002570 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002572
2573/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002574 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002575 *
2576 * - fill in handshake headers
2577 * - update handshake checksum
2578 * - DTLS: save message for resending
2579 * - then pass to the record layer
2580 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002581 * DTLS: except for HelloRequest, messages are only queued, and will only be
2582 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002583 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002584 * Inputs:
2585 * - ssl->out_msglen: 4 + actual handshake message len
2586 * (4 is the size of handshake headers for TLS)
2587 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2588 * - ssl->out_msg + 4: the handshake message body
2589 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002590 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002591 * - ssl->out_msglen: the length of the record contents
2592 * (including handshake headers but excluding record headers)
2593 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002594 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002595int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002596{
Janos Follath865b3eb2019-12-16 11:46:15 +00002597 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002598 const size_t hs_len = ssl->out_msglen - 4;
2599 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002600
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002601 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2602
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002603 /*
2604 * Sanity checks
2605 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002606 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002607 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2608 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002609 /* In SSLv3, the client might send a NoCertificate alert. */
2610#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2611 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2612 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2613 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2614#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2615 {
2616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2617 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2618 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002619 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002620
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002621 /* Whenever we send anything different from a
2622 * HelloRequest we should be in a handshake - double check. */
2623 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2624 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002625 ssl->handshake == NULL )
2626 {
2627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2628 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2629 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002632 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002633 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002635 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2637 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002638 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002639#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002640
Hanno Beckerb50a2532018-08-06 11:52:54 +01002641 /* Double-check that we did not exceed the bounds
2642 * of the outgoing record buffer.
2643 * This should never fail as the various message
2644 * writing functions must obey the bounds of the
2645 * outgoing record buffer, but better be safe.
2646 *
2647 * Note: We deliberately do not check for the MTU or MFL here.
2648 */
2649 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2650 {
2651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002652 "size %" MBEDTLS_PRINTF_SIZET
2653 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002654 ssl->out_msglen,
2655 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002656 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2657 }
2658
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002659 /*
2660 * Fill handshake headers
2661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002663 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002664 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2665 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2666 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002667
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002668 /*
2669 * DTLS has additional fields in the Handshake layer,
2670 * between the length field and the actual payload:
2671 * uint16 message_seq;
2672 * uint24 fragment_offset;
2673 * uint24 fragment_length;
2674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002676 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002677 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002678 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002679 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002680 {
2681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002682 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002683 hs_len,
2684 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002685 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2686 }
2687
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002688 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002689 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002690
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002691 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002692 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002693 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002694 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002695 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002696 }
2697 else
2698 {
2699 ssl->out_msg[4] = 0;
2700 ssl->out_msg[5] = 0;
2701 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002702
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002703 /* Handshake hashes are computed without fragmentation,
2704 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002705 memset( ssl->out_msg + 6, 0x00, 3 );
2706 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002707 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002709
Hanno Becker0207e532018-08-28 10:28:28 +01002710 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002711 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2712 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002713 }
2714
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002715 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002717 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002718 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2719 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002720 {
2721 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2722 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002724 return( ret );
2725 }
2726 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002727 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002728#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002729 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002730 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002731 {
2732 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2733 return( ret );
2734 }
2735 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002736
2737 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2738
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002739 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002740}
2741
2742/*
2743 * Record layer functions
2744 */
2745
2746/*
2747 * Write current record.
2748 *
2749 * Uses:
2750 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2751 * - ssl->out_msglen: length of the record content (excl headers)
2752 * - ssl->out_msg: record content
2753 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002754int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002755{
2756 int ret, done = 0;
2757 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002758 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002759
2760 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002762#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002763 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002765 {
2766 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2767 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002769 return( ret );
2770 }
2771
2772 len = ssl->out_msglen;
2773 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2777 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002778 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 ret = mbedtls_ssl_hw_record_write( ssl );
2782 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2785 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002786 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002787
2788 if( ret == 0 )
2789 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002790 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002792 if( !done )
2793 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002794 unsigned i;
2795 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002796#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2797 size_t out_buf_len = ssl->out_buf_len;
2798#else
2799 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2800#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002801 /* Skip writing the record content type to after the encryption,
2802 * as it may change when using the CID extension. */
2803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002805 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002806
Hanno Becker19859472018-08-06 09:40:20 +01002807 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002808 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002809
Paul Bakker48916f92012-09-16 19:57:18 +00002810 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002811 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002812 mbedtls_record rec;
2813
2814 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002815 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002816 rec.data_len = ssl->out_msglen;
2817 rec.data_offset = ssl->out_msg - rec.buf;
2818
2819 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2820 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2821 ssl->conf->transport, rec.ver );
2822 rec.type = ssl->out_msgtype;
2823
Hanno Beckera0e20d02019-05-15 14:03:01 +01002824#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002825 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002826 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002827#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002828
Hanno Beckera18d1322018-01-03 14:27:32 +00002829 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002830 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002833 return( ret );
2834 }
2835
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002836 if( rec.data_offset != 0 )
2837 {
2838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2839 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2840 }
2841
Hanno Becker6430faf2019-05-08 11:57:13 +01002842 /* Update the record content type and CID. */
2843 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002844#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002845 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002846#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002847 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002848 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002849 }
2850
Hanno Becker5903de42019-05-03 14:46:38 +01002851 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002852
2853#if defined(MBEDTLS_SSL_PROTO_DTLS)
2854 /* In case of DTLS, double-check that we don't exceed
2855 * the remaining space in the datagram. */
2856 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2857 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002858 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002859 if( ret < 0 )
2860 return( ret );
2861
2862 if( protected_record_size > (size_t) ret )
2863 {
2864 /* Should never happen */
2865 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2866 }
2867 }
2868#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002869
Hanno Becker6430faf2019-05-08 11:57:13 +01002870 /* Now write the potentially updated record content type. */
2871 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2872
Paul Elliott9f352112020-12-09 14:55:45 +00002873 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002874 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002875 ssl->out_hdr[0], ssl->out_hdr[1],
2876 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002879 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002880
2881 ssl->out_left += protected_record_size;
2882 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002883 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002884
Hanno Beckerdd772292020-02-05 10:38:31 +00002885 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002886 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2887 break;
2888
2889 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002890 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002891 {
2892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2893 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2894 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002895 }
2896
Hanno Becker67bc7c32018-08-06 11:33:50 +01002897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2899 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002900 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002901 size_t remaining;
2902 ret = ssl_get_remaining_payload_in_datagram( ssl );
2903 if( ret < 0 )
2904 {
2905 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2906 ret );
2907 return( ret );
2908 }
2909
2910 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002911 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002912 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002913 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002914 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002915 else
2916 {
Hanno Becker513815a2018-08-20 11:56:09 +01002917 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002918 }
2919 }
2920#endif /* MBEDTLS_SSL_PROTO_DTLS */
2921
2922 if( ( flush == SSL_FORCE_FLUSH ) &&
2923 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002926 return( ret );
2927 }
2928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002929 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002930
2931 return( 0 );
2932}
2933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002935
2936static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2937{
2938 if( ssl->in_msglen < ssl->in_hslen ||
2939 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2940 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2941 {
2942 return( 1 );
2943 }
2944 return( 0 );
2945}
Hanno Becker44650b72018-08-16 12:51:11 +01002946
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002947static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002948{
2949 return( ( ssl->in_msg[9] << 16 ) |
2950 ( ssl->in_msg[10] << 8 ) |
2951 ssl->in_msg[11] );
2952}
2953
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002954static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002955{
2956 return( ( ssl->in_msg[6] << 16 ) |
2957 ( ssl->in_msg[7] << 8 ) |
2958 ssl->in_msg[8] );
2959}
2960
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002961static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002962{
2963 uint32_t msg_len, frag_off, frag_len;
2964
2965 msg_len = ssl_get_hs_total_len( ssl );
2966 frag_off = ssl_get_hs_frag_off( ssl );
2967 frag_len = ssl_get_hs_frag_len( ssl );
2968
2969 if( frag_off > msg_len )
2970 return( -1 );
2971
2972 if( frag_len > msg_len - frag_off )
2973 return( -1 );
2974
2975 if( frag_len + 12 > ssl->in_msglen )
2976 return( -1 );
2977
2978 return( 0 );
2979}
2980
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002981/*
2982 * Mark bits in bitmask (used for DTLS HS reassembly)
2983 */
2984static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2985{
2986 unsigned int start_bits, end_bits;
2987
2988 start_bits = 8 - ( offset % 8 );
2989 if( start_bits != 8 )
2990 {
2991 size_t first_byte_idx = offset / 8;
2992
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002993 /* Special case */
2994 if( len <= start_bits )
2995 {
2996 for( ; len != 0; len-- )
2997 mask[first_byte_idx] |= 1 << ( start_bits - len );
2998
2999 /* Avoid potential issues with offset or len becoming invalid */
3000 return;
3001 }
3002
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003003 offset += start_bits; /* Now offset % 8 == 0 */
3004 len -= start_bits;
3005
3006 for( ; start_bits != 0; start_bits-- )
3007 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3008 }
3009
3010 end_bits = len % 8;
3011 if( end_bits != 0 )
3012 {
3013 size_t last_byte_idx = ( offset + len ) / 8;
3014
3015 len -= end_bits; /* Now len % 8 == 0 */
3016
3017 for( ; end_bits != 0; end_bits-- )
3018 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3019 }
3020
3021 memset( mask + offset / 8, 0xFF, len / 8 );
3022}
3023
3024/*
3025 * Check that bitmask is full
3026 */
3027static int ssl_bitmask_check( unsigned char *mask, size_t len )
3028{
3029 size_t i;
3030
3031 for( i = 0; i < len / 8; i++ )
3032 if( mask[i] != 0xFF )
3033 return( -1 );
3034
3035 for( i = 0; i < len % 8; i++ )
3036 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3037 return( -1 );
3038
3039 return( 0 );
3040}
3041
Hanno Becker56e205e2018-08-16 09:06:12 +01003042/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003043static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003044 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003045{
Hanno Becker56e205e2018-08-16 09:06:12 +01003046 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003047
Hanno Becker56e205e2018-08-16 09:06:12 +01003048 alloc_len = 12; /* Handshake header */
3049 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003050
Hanno Beckerd07df862018-08-16 09:14:58 +01003051 if( add_bitmap )
3052 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003053
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003054 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003055}
Hanno Becker56e205e2018-08-16 09:06:12 +01003056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003058
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003059static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003060{
3061 return( ( ssl->in_msg[1] << 16 ) |
3062 ( ssl->in_msg[2] << 8 ) |
3063 ssl->in_msg[3] );
3064}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003065
Simon Butcher99000142016-10-13 17:21:01 +01003066int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003067{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003069 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003070 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003071 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003073 }
3074
Hanno Becker12555c62018-08-16 12:47:53 +01003075 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003076
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003078 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003079 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003082 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003083 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003085 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003086
Hanno Becker44650b72018-08-16 12:51:11 +01003087 if( ssl_check_hs_header( ssl ) != 0 )
3088 {
3089 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3090 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3091 }
3092
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003093 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003094 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3095 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3096 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3097 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003098 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003099 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3100 {
3101 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3102 recv_msg_seq,
3103 ssl->handshake->in_msg_seq ) );
3104 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3105 }
3106
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003107 /* Retransmit only on last message from previous flight, to avoid
3108 * too many retransmissions.
3109 * Besides, No sane server ever retransmits HelloVerifyRequest */
3110 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003114 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003115 recv_msg_seq,
3116 ssl->handshake->in_flight_start_seq ) );
3117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003121 return( ret );
3122 }
3123 }
3124 else
3125 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003127 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003128 recv_msg_seq,
3129 ssl->handshake->in_msg_seq ) );
3130 }
3131
Hanno Becker90333da2017-10-10 11:27:13 +01003132 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003133 }
3134 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003135
Hanno Becker6d97ef52018-08-16 13:09:04 +01003136 /* Message reassembly is handled alongside buffering of future
3137 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003138 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003139 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003140 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003141 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003143 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003144 }
3145 }
3146 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003148 /* With TLS we don't handle fragmentation (for now) */
3149 if( ssl->in_msglen < ssl->in_hslen )
3150 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3152 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003153 }
3154
Simon Butcher99000142016-10-13 17:21:01 +01003155 return( 0 );
3156}
3157
3158void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3159{
Hanno Becker0271f962018-08-16 13:23:47 +01003160 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003161
Hanno Becker0271f962018-08-16 13:23:47 +01003162 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003163 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003164 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003165 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003166
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003167 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003169 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003170 ssl->handshake != NULL )
3171 {
Hanno Becker0271f962018-08-16 13:23:47 +01003172 unsigned offset;
3173 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003174
Hanno Becker0271f962018-08-16 13:23:47 +01003175 /* Increment handshake sequence number */
3176 hs->in_msg_seq++;
3177
3178 /*
3179 * Clear up handshake buffering and reassembly structure.
3180 */
3181
3182 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003183 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003184
3185 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003186 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3187 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003188 offset++, hs_buf++ )
3189 {
3190 *hs_buf = *(hs_buf + 1);
3191 }
3192
3193 /* Create a fresh last entry */
3194 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003195 }
3196#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003197}
3198
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003199/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003200 * DTLS anti-replay: RFC 6347 4.1.2.6
3201 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003202 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3203 * Bit n is set iff record number in_window_top - n has been seen.
3204 *
3205 * Usually, in_window_top is the last record number seen and the lsb of
3206 * in_window is set. The only exception is the initial state (record number 0
3207 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003210void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003211{
3212 ssl->in_window_top = 0;
3213 ssl->in_window = 0;
3214}
3215
3216static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3217{
3218 return( ( (uint64_t) buf[0] << 40 ) |
3219 ( (uint64_t) buf[1] << 32 ) |
3220 ( (uint64_t) buf[2] << 24 ) |
3221 ( (uint64_t) buf[3] << 16 ) |
3222 ( (uint64_t) buf[4] << 8 ) |
3223 ( (uint64_t) buf[5] ) );
3224}
3225
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003226static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3227{
Janos Follath865b3eb2019-12-16 11:46:15 +00003228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003229 unsigned char *original_in_ctr;
3230
3231 // save original in_ctr
3232 original_in_ctr = ssl->in_ctr;
3233
3234 // use counter from record
3235 ssl->in_ctr = record_in_ctr;
3236
3237 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3238
3239 // restore the counter
3240 ssl->in_ctr = original_in_ctr;
3241
3242 return ret;
3243}
3244
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003245/*
3246 * Return 0 if sequence number is acceptable, -1 otherwise
3247 */
Hanno Becker0183d692019-07-12 08:50:37 +01003248int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003249{
3250 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3251 uint64_t bit;
3252
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003253 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003254 return( 0 );
3255
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003256 if( rec_seqnum > ssl->in_window_top )
3257 return( 0 );
3258
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003259 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260
3261 if( bit >= 64 )
3262 return( -1 );
3263
3264 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3265 return( -1 );
3266
3267 return( 0 );
3268}
3269
3270/*
3271 * Update replay window on new validated record
3272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003274{
3275 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3276
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003277 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003278 return;
3279
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003280 if( rec_seqnum > ssl->in_window_top )
3281 {
3282 /* Update window_top and the contents of the window */
3283 uint64_t shift = rec_seqnum - ssl->in_window_top;
3284
3285 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003286 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003287 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003288 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003289 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003290 ssl->in_window |= 1;
3291 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003292
3293 ssl->in_window_top = rec_seqnum;
3294 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003295 else
3296 {
3297 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003298 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003299
3300 if( bit < 64 ) /* Always true, but be extra sure */
3301 ssl->in_window |= (uint64_t) 1 << bit;
3302 }
3303}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003305
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003306#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003307/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003308 * Without any SSL context, check if a datagram looks like a ClientHello with
3309 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003310 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003311 *
3312 * - if cookie is valid, return 0
3313 * - if ClientHello looks superficially valid but cookie is not,
3314 * fill obuf and set olen, then
3315 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3316 * - otherwise return a specific error code
3317 */
3318static int ssl_check_dtls_clihlo_cookie(
3319 mbedtls_ssl_cookie_write_t *f_cookie_write,
3320 mbedtls_ssl_cookie_check_t *f_cookie_check,
3321 void *p_cookie,
3322 const unsigned char *cli_id, size_t cli_id_len,
3323 const unsigned char *in, size_t in_len,
3324 unsigned char *obuf, size_t buf_len, size_t *olen )
3325{
3326 size_t sid_len, cookie_len;
3327 unsigned char *p;
3328
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003329 /*
3330 * Structure of ClientHello with record and handshake headers,
3331 * and expected values. We don't need to check a lot, more checks will be
3332 * done when actually parsing the ClientHello - skipping those checks
3333 * avoids code duplication and does not make cookie forging any easier.
3334 *
3335 * 0-0 ContentType type; copied, must be handshake
3336 * 1-2 ProtocolVersion version; copied
3337 * 3-4 uint16 epoch; copied, must be 0
3338 * 5-10 uint48 sequence_number; copied
3339 * 11-12 uint16 length; (ignored)
3340 *
3341 * 13-13 HandshakeType msg_type; (ignored)
3342 * 14-16 uint24 length; (ignored)
3343 * 17-18 uint16 message_seq; copied
3344 * 19-21 uint24 fragment_offset; copied, must be 0
3345 * 22-24 uint24 fragment_length; (ignored)
3346 *
3347 * 25-26 ProtocolVersion client_version; (ignored)
3348 * 27-58 Random random; (ignored)
3349 * 59-xx SessionID session_id; 1 byte len + sid_len content
3350 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3351 * ...
3352 *
3353 * Minimum length is 61 bytes.
3354 */
3355 if( in_len < 61 ||
3356 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3357 in[3] != 0 || in[4] != 0 ||
3358 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3359 {
3360 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3361 }
3362
3363 sid_len = in[59];
3364 if( sid_len > in_len - 61 )
3365 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3366
3367 cookie_len = in[60 + sid_len];
3368 if( cookie_len > in_len - 60 )
3369 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3370
3371 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3372 cli_id, cli_id_len ) == 0 )
3373 {
3374 /* Valid cookie */
3375 return( 0 );
3376 }
3377
3378 /*
3379 * If we get here, we've got an invalid cookie, let's prepare HVR.
3380 *
3381 * 0-0 ContentType type; copied
3382 * 1-2 ProtocolVersion version; copied
3383 * 3-4 uint16 epoch; copied
3384 * 5-10 uint48 sequence_number; copied
3385 * 11-12 uint16 length; olen - 13
3386 *
3387 * 13-13 HandshakeType msg_type; hello_verify_request
3388 * 14-16 uint24 length; olen - 25
3389 * 17-18 uint16 message_seq; copied
3390 * 19-21 uint24 fragment_offset; copied
3391 * 22-24 uint24 fragment_length; olen - 25
3392 *
3393 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3394 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3395 *
3396 * Minimum length is 28.
3397 */
3398 if( buf_len < 28 )
3399 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3400
3401 /* Copy most fields and adapt others */
3402 memcpy( obuf, in, 25 );
3403 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3404 obuf[25] = 0xfe;
3405 obuf[26] = 0xff;
3406
3407 /* Generate and write actual cookie */
3408 p = obuf + 28;
3409 if( f_cookie_write( p_cookie,
3410 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3411 {
3412 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3413 }
3414
3415 *olen = p - obuf;
3416
3417 /* Go back and fill length fields */
3418 obuf[27] = (unsigned char)( *olen - 28 );
3419
Joe Subbianiad1115a2021-07-16 14:27:50 +01003420 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3421 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3422 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003423
Joe Subbianic54e9082021-07-19 11:56:54 +01003424 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003425
3426 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3427}
3428
3429/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003430 * Handle possible client reconnect with the same UDP quadruplet
3431 * (RFC 6347 Section 4.2.8).
3432 *
3433 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3434 * that looks like a ClientHello.
3435 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003436 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003437 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003438 * - if the input looks like a ClientHello with a valid cookie,
3439 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003440 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003441 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003442 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003443 * This function is called (through ssl_check_client_reconnect()) when an
3444 * unexpected record is found in ssl_get_next_record(), which will discard the
3445 * record if we return 0, and bubble up the return value otherwise (this
3446 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3447 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003448 */
3449static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3450{
Janos Follath865b3eb2019-12-16 11:46:15 +00003451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003452 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003453
Hanno Becker2fddd372019-07-10 14:37:41 +01003454 if( ssl->conf->f_cookie_write == NULL ||
3455 ssl->conf->f_cookie_check == NULL )
3456 {
3457 /* If we can't use cookies to verify reachability of the peer,
3458 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3460 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003461 return( 0 );
3462 }
3463
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003464 ret = ssl_check_dtls_clihlo_cookie(
3465 ssl->conf->f_cookie_write,
3466 ssl->conf->f_cookie_check,
3467 ssl->conf->p_cookie,
3468 ssl->cli_id, ssl->cli_id_len,
3469 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003470 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003471
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003472 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3473
3474 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003475 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003476 int send_ret;
3477 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3478 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3479 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003480 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003481 * If the error is permanent we'll catch it later,
3482 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003483 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3484 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3485 (void) send_ret;
3486
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003487 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003488 }
3489
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003490 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003491 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003493 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003494 {
3495 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3496 return( ret );
3497 }
3498
3499 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003500 }
3501
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003502 return( ret );
3503}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003504#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003505
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003506static int ssl_check_record_type( uint8_t record_type )
3507{
3508 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3509 record_type != MBEDTLS_SSL_MSG_ALERT &&
3510 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3511 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3512 {
3513 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3514 }
3515
3516 return( 0 );
3517}
3518
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003519/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003520 * ContentType type;
3521 * ProtocolVersion version;
3522 * uint16 epoch; // DTLS only
3523 * uint48 sequence_number; // DTLS only
3524 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003525 *
3526 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003527 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003528 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3529 *
3530 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003531 * 1. proceed with the record if this function returns 0
3532 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3533 * 3. return CLIENT_RECONNECT if this function return that value
3534 * 4. drop the whole datagram if this function returns anything else.
3535 * Point 2 is needed when the peer is resending, and we have already received
3536 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003537 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003538static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003539 unsigned char *buf,
3540 size_t len,
3541 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003542{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003543 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003544
Hanno Beckere5e7e782019-07-11 12:29:35 +01003545 size_t const rec_hdr_type_offset = 0;
3546 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003547
Hanno Beckere5e7e782019-07-11 12:29:35 +01003548 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3549 rec_hdr_type_len;
3550 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003551
Hanno Beckere5e7e782019-07-11 12:29:35 +01003552 size_t const rec_hdr_ctr_len = 8;
3553#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003554 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3556 rec_hdr_version_len;
3557
Hanno Beckera0e20d02019-05-15 14:03:01 +01003558#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003559 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3560 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003561 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3563#endif /* MBEDTLS_SSL_PROTO_DTLS */
3564
3565 size_t rec_hdr_len_offset; /* To be determined */
3566 size_t const rec_hdr_len_len = 2;
3567
3568 /*
3569 * Check minimum lengths for record header.
3570 */
3571
3572#if defined(MBEDTLS_SSL_PROTO_DTLS)
3573 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3574 {
3575 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3576 }
3577 else
3578#endif /* MBEDTLS_SSL_PROTO_DTLS */
3579 {
3580 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3581 }
3582
3583 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3584 {
3585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3586 (unsigned) len,
3587 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3588 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3589 }
3590
3591 /*
3592 * Parse and validate record content type
3593 */
3594
3595 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596
3597 /* Check record content type */
3598#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3599 rec->cid_len = 0;
3600
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003601 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003602 ssl->conf->cid_len != 0 &&
3603 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003604 {
3605 /* Shift pointers to account for record header including CID
3606 * struct {
3607 * ContentType special_type = tls12_cid;
3608 * ProtocolVersion version;
3609 * uint16 epoch;
3610 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003611 * opaque cid[cid_length]; // Additional field compared to
3612 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003613 * uint16 length;
3614 * opaque enc_content[DTLSCiphertext.length];
3615 * } DTLSCiphertext;
3616 */
3617
3618 /* So far, we only support static CID lengths
3619 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003620 rec_hdr_cid_len = ssl->conf->cid_len;
3621 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003622
Hanno Beckere5e7e782019-07-11 12:29:35 +01003623 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003624 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003625 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3626 (unsigned) len,
3627 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003628 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003629 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003630
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003631 /* configured CID len is guaranteed at most 255, see
3632 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3633 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003634 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003635 }
3636 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003637#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003638 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003639 if( ssl_check_record_type( rec->type ) )
3640 {
Hanno Becker54229812019-07-12 14:40:00 +01003641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3642 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003643 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3644 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003645 }
3646
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 /*
3648 * Parse and validate record version
3649 */
3650
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003651 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3652 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003653 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3654 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003655 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003656
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003657 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3660 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003661 }
3662
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003663 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003665 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3666 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003667 }
3668
Hanno Beckere5e7e782019-07-11 12:29:35 +01003669 /*
3670 * Parse/Copy record sequence number.
3671 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003672
Hanno Beckere5e7e782019-07-11 12:29:35 +01003673#if defined(MBEDTLS_SSL_PROTO_DTLS)
3674 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003675 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676 /* Copy explicit record sequence number from input buffer. */
3677 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3678 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003679 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003680 else
3681#endif /* MBEDTLS_SSL_PROTO_DTLS */
3682 {
3683 /* Copy implicit record sequence number from SSL context structure. */
3684 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3685 }
Paul Bakker40e46942009-01-03 21:51:57 +00003686
Hanno Beckere5e7e782019-07-11 12:29:35 +01003687 /*
3688 * Parse record length.
3689 */
3690
Hanno Beckere5e7e782019-07-11 12:29:35 +01003691 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003692 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3693 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003694 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003695
Paul Elliott9f352112020-12-09 14:55:45 +00003696 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003697 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003698 rec->type,
3699 major_ver, minor_ver, rec->data_len ) );
3700
3701 rec->buf = buf;
3702 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003703
Hanno Beckerd417cc92019-07-26 08:20:27 +01003704 if( rec->data_len == 0 )
3705 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003706
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003707 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003708 * DTLS-related tests.
3709 * Check epoch before checking length constraint because
3710 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3711 * message gets duplicated before the corresponding Finished message,
3712 * the second ChangeCipherSpec should be discarded because it belongs
3713 * to an old epoch, but not because its length is shorter than
3714 * the minimum record length for packets using the new record transform.
3715 * Note that these two kinds of failures are handled differently,
3716 * as an unexpected record is silently skipped but an invalid
3717 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003718 */
3719#if defined(MBEDTLS_SSL_PROTO_DTLS)
3720 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3721 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003722 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003723
Hanno Becker955a5c92019-07-10 17:12:07 +01003724 /* Check that the datagram is large enough to contain a record
3725 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003726 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003727 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3729 (unsigned) len,
3730 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003731 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3732 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003733
Hanno Becker37cfe732019-07-10 17:20:01 +01003734 /* Records from other, non-matching epochs are silently discarded.
3735 * (The case of same-port Client reconnects must be considered in
3736 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003737 if( rec_epoch != ssl->in_epoch )
3738 {
3739 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003740 "expected %u, received %lu",
3741 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003742
Hanno Becker552f7472019-07-19 10:59:12 +01003743 /* Records from the next epoch are considered for buffering
3744 * (concretely: early Finished messages). */
3745 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003746 {
Hanno Becker552f7472019-07-19 10:59:12 +01003747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3748 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003749 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003750
Hanno Becker2fddd372019-07-10 14:37:41 +01003751 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003752 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003753#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003754 /* For records from the correct epoch, check whether their
3755 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003756 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3757 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003758 {
3759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3760 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3761 }
3762#endif
3763 }
3764#endif /* MBEDTLS_SSL_PROTO_DTLS */
3765
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003766 return( 0 );
3767}
Paul Bakker5121ce52009-01-03 21:22:43 +00003768
Paul Bakker5121ce52009-01-03 21:22:43 +00003769
Hanno Becker2fddd372019-07-10 14:37:41 +01003770#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3771static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3772{
3773 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3774
3775 /*
3776 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3777 * access the first byte of record content (handshake type), as we
3778 * have an active transform (possibly iv_len != 0), so use the
3779 * fact that the record header len is 13 instead.
3780 */
3781 if( rec_epoch == 0 &&
3782 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3783 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3784 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3785 ssl->in_left > 13 &&
3786 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3787 {
3788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3789 "from the same port" ) );
3790 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003791 }
3792
3793 return( 0 );
3794}
Hanno Becker2fddd372019-07-10 14:37:41 +01003795#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003796
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003797/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003798 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003799 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003800static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3801 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003802{
3803 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003805 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003806 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003808#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3809 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003811 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813 ret = mbedtls_ssl_hw_record_read( ssl );
3814 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003816 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3817 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003818 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003819
3820 if( ret == 0 )
3821 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003822 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003823#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003824 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003825 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003826 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003827
Hanno Beckera18d1322018-01-03 14:27:32 +00003828 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003829 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003832
Hanno Beckera0e20d02019-05-15 14:03:01 +01003833#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003834 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3835 ssl->conf->ignore_unexpected_cid
3836 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3837 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003838 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003839 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003840 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003841#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003842
Paul Bakker5121ce52009-01-03 21:22:43 +00003843 return( ret );
3844 }
3845
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003846 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003847 {
3848 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003849 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003850 }
3851
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003852 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003853 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003854
Hanno Beckera0e20d02019-05-15 14:03:01 +01003855#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003856 /* We have already checked the record content type
3857 * in ssl_parse_record_header(), failing or silently
3858 * dropping the record in the case of an unknown type.
3859 *
3860 * Since with the use of CIDs, the record content type
3861 * might change during decryption, re-check the record
3862 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003863 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003864 {
3865 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3866 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3867 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003868#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003869
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003870 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003871 {
3872#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3873 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003874 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003875 {
3876 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3878 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3879 }
3880#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3881
3882 ssl->nb_zero++;
3883
3884 /*
3885 * Three or more empty messages may be a DoS attack
3886 * (excessive CPU consumption).
3887 */
3888 if( ssl->nb_zero > 3 )
3889 {
3890 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003891 "messages, possible DoS attack" ) );
3892 /* Treat the records as if they were not properly authenticated,
3893 * thereby failing the connection if we see more than allowed
3894 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003895 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3896 }
3897 }
3898 else
3899 ssl->nb_zero = 0;
3900
3901#if defined(MBEDTLS_SSL_PROTO_DTLS)
3902 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3903 {
3904 ; /* in_ctr read from peer, not maintained internally */
3905 }
3906 else
3907#endif
3908 {
3909 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003910 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003911 if( ++ssl->in_ctr[i - 1] != 0 )
3912 break;
3913
3914 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003915 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003916 {
3917 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3918 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3919 }
3920 }
3921
Paul Bakker5121ce52009-01-03 21:22:43 +00003922 }
3923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003924#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003925 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003926 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003927 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003928 }
3929#endif
3930
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003931 /* Check actual (decrypted) record content length against
3932 * configured maximum. */
3933 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3934 {
3935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3936 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3937 }
3938
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003939 return( 0 );
3940}
3941
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003942/*
3943 * Read a record.
3944 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003945 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3946 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3947 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003948 */
Hanno Becker1097b342018-08-15 14:09:41 +01003949
3950/* Helper functions for mbedtls_ssl_read_record(). */
3951static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003952static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3953static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003954
Hanno Becker327c93b2018-08-15 13:56:18 +01003955int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003956 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003957{
Janos Follath865b3eb2019-12-16 11:46:15 +00003958 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003961
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003962 if( ssl->keep_current_message == 0 )
3963 {
3964 do {
Simon Butcher99000142016-10-13 17:21:01 +01003965
Hanno Becker26994592018-08-15 14:14:59 +01003966 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003967 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003968 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003969
Hanno Beckere74d5562018-08-15 14:26:08 +01003970 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003971 {
Hanno Becker40f50842018-08-15 14:48:01 +01003972#if defined(MBEDTLS_SSL_PROTO_DTLS)
3973 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003974
Hanno Becker40f50842018-08-15 14:48:01 +01003975 /* We only check for buffered messages if the
3976 * current datagram is fully consumed. */
3977 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003978 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003979 {
Hanno Becker40f50842018-08-15 14:48:01 +01003980 if( ssl_load_buffered_message( ssl ) == 0 )
3981 have_buffered = 1;
3982 }
3983
3984 if( have_buffered == 0 )
3985#endif /* MBEDTLS_SSL_PROTO_DTLS */
3986 {
3987 ret = ssl_get_next_record( ssl );
3988 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3989 continue;
3990
3991 if( ret != 0 )
3992 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003993 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003994 return( ret );
3995 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003996 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003997 }
3998
3999 ret = mbedtls_ssl_handle_message_type( ssl );
4000
Hanno Becker40f50842018-08-15 14:48:01 +01004001#if defined(MBEDTLS_SSL_PROTO_DTLS)
4002 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4003 {
4004 /* Buffer future message */
4005 ret = ssl_buffer_message( ssl );
4006 if( ret != 0 )
4007 return( ret );
4008
4009 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4010 }
4011#endif /* MBEDTLS_SSL_PROTO_DTLS */
4012
Hanno Becker90333da2017-10-10 11:27:13 +01004013 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4014 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004015
4016 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004017 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004018 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004019 return( ret );
4020 }
4021
Hanno Becker327c93b2018-08-15 13:56:18 +01004022 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004023 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004024 {
4025 mbedtls_ssl_update_handshake_status( ssl );
4026 }
Simon Butcher99000142016-10-13 17:21:01 +01004027 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004028 else
Simon Butcher99000142016-10-13 17:21:01 +01004029 {
Hanno Becker02f59072018-08-15 14:00:24 +01004030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004031 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004032 }
4033
4034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4035
4036 return( 0 );
4037}
4038
Hanno Becker40f50842018-08-15 14:48:01 +01004039#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004040static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004041{
Hanno Becker40f50842018-08-15 14:48:01 +01004042 if( ssl->in_left > ssl->next_record_offset )
4043 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004044
Hanno Becker40f50842018-08-15 14:48:01 +01004045 return( 0 );
4046}
4047
4048static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4049{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004050 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004051 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004052 int ret = 0;
4053
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004054 if( hs == NULL )
4055 return( -1 );
4056
Hanno Beckere00ae372018-08-20 09:39:42 +01004057 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4058
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004059 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4060 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4061 {
4062 /* Check if we have seen a ChangeCipherSpec before.
4063 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004064 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004065 {
4066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4067 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004068 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004069 }
4070
Hanno Becker39b8bc92018-08-28 17:17:13 +01004071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004072 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4073 ssl->in_msglen = 1;
4074 ssl->in_msg[0] = 1;
4075
4076 /* As long as they are equal, the exact value doesn't matter. */
4077 ssl->in_left = 0;
4078 ssl->next_record_offset = 0;
4079
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004080 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004081 goto exit;
4082 }
Hanno Becker37f95322018-08-16 13:55:32 +01004083
Hanno Beckerb8f50142018-08-28 10:01:34 +01004084#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004085 /* Debug only */
4086 {
4087 unsigned offset;
4088 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4089 {
4090 hs_buf = &hs->buffering.hs[offset];
4091 if( hs_buf->is_valid == 1 )
4092 {
4093 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4094 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004095 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004096 }
4097 }
4098 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004099#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004100
4101 /* Check if we have buffered and/or fully reassembled the
4102 * next handshake message. */
4103 hs_buf = &hs->buffering.hs[0];
4104 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4105 {
4106 /* Synthesize a record containing the buffered HS message. */
4107 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4108 ( hs_buf->data[2] << 8 ) |
4109 hs_buf->data[3];
4110
4111 /* Double-check that we haven't accidentally buffered
4112 * a message that doesn't fit into the input buffer. */
4113 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4114 {
4115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4116 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4117 }
4118
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4120 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4121 hs_buf->data, msg_len + 12 );
4122
4123 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4124 ssl->in_hslen = msg_len + 12;
4125 ssl->in_msglen = msg_len + 12;
4126 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4127
4128 ret = 0;
4129 goto exit;
4130 }
4131 else
4132 {
4133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4134 hs->in_msg_seq ) );
4135 }
4136
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004137 ret = -1;
4138
4139exit:
4140
4141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4142 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004143}
4144
Hanno Beckera02b0b42018-08-21 17:20:27 +01004145static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4146 size_t desired )
4147{
4148 int offset;
4149 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004150 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4151 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004152
Hanno Becker01315ea2018-08-21 17:22:17 +01004153 /* Get rid of future records epoch first, if such exist. */
4154 ssl_free_buffered_record( ssl );
4155
4156 /* Check if we have enough space available now. */
4157 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4158 hs->buffering.total_bytes_buffered ) )
4159 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004160 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004161 return( 0 );
4162 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004163
Hanno Becker4f432ad2018-08-28 10:02:32 +01004164 /* We don't have enough space to buffer the next expected handshake
4165 * message. Remove buffers used for future messages to gain space,
4166 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004167 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4168 offset >= 0; offset-- )
4169 {
4170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4171 offset ) );
4172
Hanno Beckerb309b922018-08-23 13:18:05 +01004173 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004174
4175 /* Check if we have enough space available now. */
4176 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4177 hs->buffering.total_bytes_buffered ) )
4178 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004179 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004180 return( 0 );
4181 }
4182 }
4183
4184 return( -1 );
4185}
4186
Hanno Becker40f50842018-08-15 14:48:01 +01004187static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4188{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004189 int ret = 0;
4190 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4191
4192 if( hs == NULL )
4193 return( 0 );
4194
4195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4196
4197 switch( ssl->in_msgtype )
4198 {
4199 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4200 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004201
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004202 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004203 break;
4204
4205 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004206 {
4207 unsigned recv_msg_seq_offset;
4208 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4209 mbedtls_ssl_hs_buffer *hs_buf;
4210 size_t msg_len = ssl->in_hslen - 12;
4211
4212 /* We should never receive an old handshake
4213 * message - double-check nonetheless. */
4214 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4215 {
4216 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4217 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4218 }
4219
4220 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4221 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4222 {
4223 /* Silently ignore -- message too far in the future */
4224 MBEDTLS_SSL_DEBUG_MSG( 2,
4225 ( "Ignore future HS message with sequence number %u, "
4226 "buffering window %u - %u",
4227 recv_msg_seq, ssl->handshake->in_msg_seq,
4228 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4229
4230 goto exit;
4231 }
4232
4233 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4234 recv_msg_seq, recv_msg_seq_offset ) );
4235
4236 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4237
4238 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004239 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004240 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004241 size_t reassembly_buf_sz;
4242
Hanno Becker37f95322018-08-16 13:55:32 +01004243 hs_buf->is_fragmented =
4244 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4245
4246 /* We copy the message back into the input buffer
4247 * after reassembly, so check that it's not too large.
4248 * This is an implementation-specific limitation
4249 * and not one from the standard, hence it is not
4250 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004251 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004252 {
4253 /* Ignore message */
4254 goto exit;
4255 }
4256
Hanno Beckere0b150f2018-08-21 15:51:03 +01004257 /* Check if we have enough space to buffer the message. */
4258 if( hs->buffering.total_bytes_buffered >
4259 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4260 {
4261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4262 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4263 }
4264
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004265 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4266 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004267
4268 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4269 hs->buffering.total_bytes_buffered ) )
4270 {
4271 if( recv_msg_seq_offset > 0 )
4272 {
4273 /* If we can't buffer a future message because
4274 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004275 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4276 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4277 " (already %" MBEDTLS_PRINTF_SIZET
4278 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004279 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004280 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004281 goto exit;
4282 }
Hanno Beckere1801392018-08-21 16:51:05 +01004283 else
4284 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4286 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4287 " (already %" MBEDTLS_PRINTF_SIZET
4288 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004289 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004290 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004291 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004292
Hanno Beckera02b0b42018-08-21 17:20:27 +01004293 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004294 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004295 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4296 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4297 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4298 " (already %" MBEDTLS_PRINTF_SIZET
4299 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004300 msg_len,
4301 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004302 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004303 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004304 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4305 goto exit;
4306 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004307 }
4308
Paul Elliottd48d5c62021-01-07 14:47:05 +00004309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004310 msg_len ) );
4311
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004312 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4313 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004314 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004315 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004316 goto exit;
4317 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004318 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004319
4320 /* Prepare final header: copy msg_type, length and message_seq,
4321 * then add standardised fragment_offset and fragment_length */
4322 memcpy( hs_buf->data, ssl->in_msg, 6 );
4323 memset( hs_buf->data + 6, 0, 3 );
4324 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4325
4326 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004327
4328 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004329 }
4330 else
4331 {
4332 /* Make sure msg_type and length are consistent */
4333 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4334 {
4335 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4336 /* Ignore */
4337 goto exit;
4338 }
4339 }
4340
Hanno Becker4422bbb2018-08-20 09:40:19 +01004341 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004342 {
4343 size_t frag_len, frag_off;
4344 unsigned char * const msg = hs_buf->data + 12;
4345
4346 /*
4347 * Check and copy current fragment
4348 */
4349
4350 /* Validation of header fields already done in
4351 * mbedtls_ssl_prepare_handshake_record(). */
4352 frag_off = ssl_get_hs_frag_off( ssl );
4353 frag_len = ssl_get_hs_frag_len( ssl );
4354
Paul Elliottd48d5c62021-01-07 14:47:05 +00004355 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4356 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004357 frag_off, frag_len ) );
4358 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4359
4360 if( hs_buf->is_fragmented )
4361 {
4362 unsigned char * const bitmask = msg + msg_len;
4363 ssl_bitmask_set( bitmask, frag_off, frag_len );
4364 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4365 msg_len ) == 0 );
4366 }
4367 else
4368 {
4369 hs_buf->is_complete = 1;
4370 }
4371
4372 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4373 hs_buf->is_complete ? "" : "not yet " ) );
4374 }
4375
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004376 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004377 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004378
4379 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004380 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004381 break;
4382 }
4383
4384exit:
4385
4386 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4387 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004388}
4389#endif /* MBEDTLS_SSL_PROTO_DTLS */
4390
Hanno Becker1097b342018-08-15 14:09:41 +01004391static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004392{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004393 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004394 * Consume last content-layer message and potentially
4395 * update in_msglen which keeps track of the contents'
4396 * consumption state.
4397 *
4398 * (1) Handshake messages:
4399 * Remove last handshake message, move content
4400 * and adapt in_msglen.
4401 *
4402 * (2) Alert messages:
4403 * Consume whole record content, in_msglen = 0.
4404 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004405 * (3) Change cipher spec:
4406 * Consume whole record content, in_msglen = 0.
4407 *
4408 * (4) Application data:
4409 * Don't do anything - the record layer provides
4410 * the application data as a stream transport
4411 * and consumes through mbedtls_ssl_read only.
4412 *
4413 */
4414
4415 /* Case (1): Handshake messages */
4416 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004417 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004418 /* Hard assertion to be sure that no application data
4419 * is in flight, as corrupting ssl->in_msglen during
4420 * ssl->in_offt != NULL is fatal. */
4421 if( ssl->in_offt != NULL )
4422 {
4423 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4424 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4425 }
4426
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004427 /*
4428 * Get next Handshake message in the current record
4429 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004430
Hanno Becker4a810fb2017-05-24 16:27:30 +01004431 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004432 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004433 * current handshake content: If DTLS handshake
4434 * fragmentation is used, that's the fragment
4435 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004436 * size here is faulty and should be changed at
4437 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004438 * (2) While it doesn't seem to cause problems, one
4439 * has to be very careful not to assume that in_hslen
4440 * is always <= in_msglen in a sensible communication.
4441 * Again, it's wrong for DTLS handshake fragmentation.
4442 * The following check is therefore mandatory, and
4443 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004444 * Additionally, ssl->in_hslen might be arbitrarily out of
4445 * bounds after handling a DTLS message with an unexpected
4446 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004447 */
4448 if( ssl->in_hslen < ssl->in_msglen )
4449 {
4450 ssl->in_msglen -= ssl->in_hslen;
4451 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4452 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004453
Hanno Becker4a810fb2017-05-24 16:27:30 +01004454 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4455 ssl->in_msg, ssl->in_msglen );
4456 }
4457 else
4458 {
4459 ssl->in_msglen = 0;
4460 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004461
Hanno Becker4a810fb2017-05-24 16:27:30 +01004462 ssl->in_hslen = 0;
4463 }
4464 /* Case (4): Application data */
4465 else if( ssl->in_offt != NULL )
4466 {
4467 return( 0 );
4468 }
4469 /* Everything else (CCS & Alerts) */
4470 else
4471 {
4472 ssl->in_msglen = 0;
4473 }
4474
Hanno Becker1097b342018-08-15 14:09:41 +01004475 return( 0 );
4476}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004477
Hanno Beckere74d5562018-08-15 14:26:08 +01004478static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4479{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004480 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004481 return( 1 );
4482
4483 return( 0 );
4484}
4485
Hanno Becker5f066e72018-08-16 14:56:31 +01004486#if defined(MBEDTLS_SSL_PROTO_DTLS)
4487
4488static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4489{
4490 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4491 if( hs == NULL )
4492 return;
4493
Hanno Becker01315ea2018-08-21 17:22:17 +01004494 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004495 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004496 hs->buffering.total_bytes_buffered -=
4497 hs->buffering.future_record.len;
4498
4499 mbedtls_free( hs->buffering.future_record.data );
4500 hs->buffering.future_record.data = NULL;
4501 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004502}
4503
4504static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4505{
4506 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4507 unsigned char * rec;
4508 size_t rec_len;
4509 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004510#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4511 size_t in_buf_len = ssl->in_buf_len;
4512#else
4513 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4514#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004515 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4516 return( 0 );
4517
4518 if( hs == NULL )
4519 return( 0 );
4520
Hanno Becker5f066e72018-08-16 14:56:31 +01004521 rec = hs->buffering.future_record.data;
4522 rec_len = hs->buffering.future_record.len;
4523 rec_epoch = hs->buffering.future_record.epoch;
4524
4525 if( rec == NULL )
4526 return( 0 );
4527
Hanno Becker4cb782d2018-08-20 11:19:05 +01004528 /* Only consider loading future records if the
4529 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004530 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004531 return( 0 );
4532
Hanno Becker5f066e72018-08-16 14:56:31 +01004533 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4534
4535 if( rec_epoch != ssl->in_epoch )
4536 {
4537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4538 goto exit;
4539 }
4540
4541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4542
4543 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004544 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004545 {
4546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4547 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4548 }
4549
4550 memcpy( ssl->in_hdr, rec, rec_len );
4551 ssl->in_left = rec_len;
4552 ssl->next_record_offset = 0;
4553
4554 ssl_free_buffered_record( ssl );
4555
4556exit:
4557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4558 return( 0 );
4559}
4560
Hanno Becker519f15d2019-07-11 12:43:20 +01004561static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4562 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004563{
4564 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004565
4566 /* Don't buffer future records outside handshakes. */
4567 if( hs == NULL )
4568 return( 0 );
4569
4570 /* Only buffer handshake records (we are only interested
4571 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004572 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004573 return( 0 );
4574
4575 /* Don't buffer more than one future epoch record. */
4576 if( hs->buffering.future_record.data != NULL )
4577 return( 0 );
4578
Hanno Becker01315ea2018-08-21 17:22:17 +01004579 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004580 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004581 hs->buffering.total_bytes_buffered ) )
4582 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004583 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4584 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4585 " (already %" MBEDTLS_PRINTF_SIZET
4586 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004587 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004588 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004589 return( 0 );
4590 }
4591
Hanno Becker5f066e72018-08-16 14:56:31 +01004592 /* Buffer record */
4593 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004594 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004595 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004596
4597 /* ssl_parse_record_header() only considers records
4598 * of the next epoch as candidates for buffering. */
4599 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004600 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004601
4602 hs->buffering.future_record.data =
4603 mbedtls_calloc( 1, hs->buffering.future_record.len );
4604 if( hs->buffering.future_record.data == NULL )
4605 {
4606 /* If we run out of RAM trying to buffer a
4607 * record from the next epoch, just ignore. */
4608 return( 0 );
4609 }
4610
Hanno Becker519f15d2019-07-11 12:43:20 +01004611 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004612
Hanno Becker519f15d2019-07-11 12:43:20 +01004613 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004614 return( 0 );
4615}
4616
4617#endif /* MBEDTLS_SSL_PROTO_DTLS */
4618
Hanno Beckere74d5562018-08-15 14:26:08 +01004619static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004620{
Janos Follath865b3eb2019-12-16 11:46:15 +00004621 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004622 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004623
Hanno Becker5f066e72018-08-16 14:56:31 +01004624#if defined(MBEDTLS_SSL_PROTO_DTLS)
4625 /* We might have buffered a future record; if so,
4626 * and if the epoch matches now, load it.
4627 * On success, this call will set ssl->in_left to
4628 * the length of the buffered record, so that
4629 * the calls to ssl_fetch_input() below will
4630 * essentially be no-ops. */
4631 ret = ssl_load_buffered_record( ssl );
4632 if( ret != 0 )
4633 return( ret );
4634#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004635
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004636 /* Ensure that we have enough space available for the default form
4637 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4638 * with no space for CIDs counted in). */
4639 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4640 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004641 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004643 return( ret );
4644 }
4645
Hanno Beckere5e7e782019-07-11 12:29:35 +01004646 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4647 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004648 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004650 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004651 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004652 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4653 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004654 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004655 if( ret != 0 )
4656 return( ret );
4657
4658 /* Fall through to handling of unexpected records */
4659 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4660 }
4661
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004662 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4663 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004664#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004665 /* Reset in pointers to default state for TLS/DTLS records,
4666 * assuming no CID and no offset between record content and
4667 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004668 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004669
Hanno Becker7ae20e02019-07-12 08:33:49 +01004670 /* Setup internal message pointers from record structure. */
4671 ssl->in_msgtype = rec.type;
4672#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4673 ssl->in_len = ssl->in_cid + rec.cid_len;
4674#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4675 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4676 ssl->in_msglen = rec.data_len;
4677
Hanno Becker2fddd372019-07-10 14:37:41 +01004678 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004679 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004680 if( ret != 0 )
4681 return( ret );
4682#endif
4683
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004684 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004685 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004686
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004687 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4688 "(header)" ) );
4689 }
4690 else
4691 {
4692 /* Skip invalid record and the rest of the datagram */
4693 ssl->next_record_offset = 0;
4694 ssl->in_left = 0;
4695
4696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4697 "(header)" ) );
4698 }
4699
4700 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004701 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004702 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004703 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004704#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004705 {
4706 return( ret );
4707 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004708 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004711 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004712 {
Hanno Beckera8814792019-07-10 15:01:45 +01004713 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004714 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004715 if( ssl->next_record_offset < ssl->in_left )
4716 {
4717 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4718 }
4719 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004720 else
4721#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004722 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004723 /*
4724 * Fetch record contents from underlying transport.
4725 */
Hanno Beckera3175662019-07-11 12:50:29 +01004726 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004727 if( ret != 0 )
4728 {
4729 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4730 return( ret );
4731 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004732
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004733 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004734 }
4735
4736 /*
4737 * Decrypt record contents.
4738 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004739
Hanno Beckerfdf66042019-07-11 13:07:45 +01004740 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004741 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004743 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004744 {
4745 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004746 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004747 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004748 /* Except when waiting for Finished as a bad mac here
4749 * probably means something went wrong in the handshake
4750 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4751 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4752 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4753 {
4754#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4755 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4756 {
4757 mbedtls_ssl_send_alert_message( ssl,
4758 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4759 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4760 }
4761#endif
4762 return( ret );
4763 }
4764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004765#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004766 if( ssl->conf->badmac_limit != 0 &&
4767 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004768 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4770 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004771 }
4772#endif
4773
Hanno Becker4a810fb2017-05-24 16:27:30 +01004774 /* As above, invalid records cause
4775 * dismissal of the whole datagram. */
4776
4777 ssl->next_record_offset = 0;
4778 ssl->in_left = 0;
4779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004781 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004782 }
4783
4784 return( ret );
4785 }
4786 else
4787#endif
4788 {
4789 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4791 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793 mbedtls_ssl_send_alert_message( ssl,
4794 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4795 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004796 }
4797#endif
4798 return( ret );
4799 }
4800 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004801
Hanno Becker44d89b22019-07-12 09:40:44 +01004802
4803 /* Reset in pointers to default state for TLS/DTLS records,
4804 * assuming no CID and no offset between record content and
4805 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004806 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004807#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4808 ssl->in_len = ssl->in_cid + rec.cid_len;
4809#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004810 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004811
Hanno Becker8685c822019-07-12 09:37:30 +01004812 /* The record content type may change during decryption,
4813 * so re-read it. */
4814 ssl->in_msgtype = rec.type;
4815 /* Also update the input buffer, because unfortunately
4816 * the server-side ssl_parse_client_hello() reparses the
4817 * record header when receiving a ClientHello initiating
4818 * a renegotiation. */
4819 ssl->in_hdr[0] = rec.type;
4820 ssl->in_msg = rec.buf + rec.data_offset;
4821 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004822 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004823
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004824#if defined(MBEDTLS_ZLIB_SUPPORT)
4825 if( ssl->transform_in != NULL &&
4826 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4827 {
4828 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4829 {
4830 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4831 return( ret );
4832 }
4833
4834 /* Check actual (decompress) record content length against
4835 * configured maximum. */
4836 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4837 {
4838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4839 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4840 }
4841 }
4842#endif /* MBEDTLS_ZLIB_SUPPORT */
4843
Simon Butcher99000142016-10-13 17:21:01 +01004844 return( 0 );
4845}
4846
4847int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4848{
Janos Follath865b3eb2019-12-16 11:46:15 +00004849 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004850
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004851 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004852 * Handle particular types of records
4853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004854 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004855 {
Simon Butcher99000142016-10-13 17:21:01 +01004856 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4857 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004858 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004859 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004860 }
4861
Hanno Beckere678eaa2018-08-21 14:57:46 +01004862 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004863 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004864 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004865 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004866 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004867 ssl->in_msglen ) );
4868 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004869 }
4870
Hanno Beckere678eaa2018-08-21 14:57:46 +01004871 if( ssl->in_msg[0] != 1 )
4872 {
4873 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4874 ssl->in_msg[0] ) );
4875 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4876 }
4877
4878#if defined(MBEDTLS_SSL_PROTO_DTLS)
4879 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4880 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4881 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4882 {
4883 if( ssl->handshake == NULL )
4884 {
4885 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4886 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4887 }
4888
4889 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4890 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4891 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004892#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004893 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004896 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004897 if( ssl->in_msglen != 2 )
4898 {
4899 /* Note: Standard allows for more than one 2 byte alert
4900 to be packed in a single message, but Mbed TLS doesn't
4901 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004903 ssl->in_msglen ) );
4904 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4905 }
4906
Paul Elliott9f352112020-12-09 14:55:45 +00004907 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004908 ssl->in_msg[0], ssl->in_msg[1] ) );
4909
4910 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004911 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004916 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004917 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004918 }
4919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004920 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4921 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004922 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4924 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004925 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004926
4927#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4928 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4929 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4930 {
Hanno Becker90333da2017-10-10 11:27:13 +01004931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004932 /* Will be handled when trying to parse ServerHello */
4933 return( 0 );
4934 }
4935#endif
4936
4937#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4938 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4939 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4940 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4941 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4942 {
4943 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4944 /* Will be handled in mbedtls_ssl_parse_certificate() */
4945 return( 0 );
4946 }
4947#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4948
4949 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004950 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004951 }
4952
Hanno Beckerc76c6192017-06-06 10:03:17 +01004953#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004954 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004955 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004956 /* Drop unexpected ApplicationData records,
4957 * except at the beginning of renegotiations */
4958 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4959 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4960#if defined(MBEDTLS_SSL_RENEGOTIATION)
4961 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4962 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004963#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004964 )
4965 {
4966 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4967 return( MBEDTLS_ERR_SSL_NON_FATAL );
4968 }
4969
4970 if( ssl->handshake != NULL &&
4971 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4972 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004973 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004974 }
4975 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004976#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004977
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 return( 0 );
4979}
4980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004981int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004982{
irwir6c0da642019-09-26 21:07:41 +03004983 return( mbedtls_ssl_send_alert_message( ssl,
4984 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4985 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004986}
4987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004989 unsigned char level,
4990 unsigned char message )
4991{
Janos Follath865b3eb2019-12-16 11:46:15 +00004992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004993
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004994 if( ssl == NULL || ssl->conf == NULL )
4995 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004998 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005000 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005001 ssl->out_msglen = 2;
5002 ssl->out_msg[0] = level;
5003 ssl->out_msg[1] = message;
5004
Hanno Becker67bc7c32018-08-06 11:33:50 +01005005 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005008 return( ret );
5009 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005011
5012 return( 0 );
5013}
5014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005016{
Janos Follath865b3eb2019-12-16 11:46:15 +00005017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005022 ssl->out_msglen = 1;
5023 ssl->out_msg[0] = 1;
5024
Paul Bakker5121ce52009-01-03 21:22:43 +00005025 ssl->state++;
5026
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005027 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005028 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005029 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005030 return( ret );
5031 }
5032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005034
5035 return( 0 );
5036}
5037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005039{
Janos Follath865b3eb2019-12-16 11:46:15 +00005040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005043
Hanno Becker327c93b2018-08-15 13:56:18 +01005044 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005045 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005047 return( ret );
5048 }
5049
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005050 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005051 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005052 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005053 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5054 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005056 }
5057
Hanno Beckere678eaa2018-08-21 14:57:46 +01005058 /* CCS records are only accepted if they have length 1 and content '1',
5059 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005060
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005061 /*
5062 * Switch to our negotiated transform and session parameters for inbound
5063 * data.
5064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005066 ssl->transform_in = ssl->transform_negotiate;
5067 ssl->session_in = ssl->session_negotiate;
5068
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005069#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005070 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005072#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005073 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005074#endif
5075
5076 /* Increment epoch */
5077 if( ++ssl->in_epoch == 0 )
5078 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005080 /* This is highly unlikely to happen for legitimate reasons, so
5081 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005082 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005083 }
5084 }
5085 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005087 memset( ssl->in_ctr, 0, 8 );
5088
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005089 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005091#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5092 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005093 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005094 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005095 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005096 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005097 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5098 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005100 }
5101 }
5102#endif
5103
Paul Bakker5121ce52009-01-03 21:22:43 +00005104 ssl->state++;
5105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005107
5108 return( 0 );
5109}
5110
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005111/* Once ssl->out_hdr as the address of the beginning of the
5112 * next outgoing record is set, deduce the other pointers.
5113 *
5114 * Note: For TLS, we save the implicit record sequence number
5115 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5116 * and the caller has to make sure there's space for this.
5117 */
5118
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005119static size_t ssl_transform_get_explicit_iv_len(
5120 mbedtls_ssl_transform const *transform )
5121{
5122 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5123 return( 0 );
5124
5125 return( transform->ivlen - transform->fixed_ivlen );
5126}
5127
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005128void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5129 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005130{
5131#if defined(MBEDTLS_SSL_PROTO_DTLS)
5132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5133 {
5134 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005135#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005136 ssl->out_cid = ssl->out_ctr + 8;
5137 ssl->out_len = ssl->out_cid;
5138 if( transform != NULL )
5139 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005140#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005141 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005142#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005143 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005144 }
5145 else
5146#endif
5147 {
5148 ssl->out_ctr = ssl->out_hdr - 8;
5149 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005150#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005151 ssl->out_cid = ssl->out_len;
5152#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005153 ssl->out_iv = ssl->out_hdr + 5;
5154 }
5155
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005156 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005157 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005158 if( transform != NULL )
5159 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005160}
5161
5162/* Once ssl->in_hdr as the address of the beginning of the
5163 * next incoming record is set, deduce the other pointers.
5164 *
5165 * Note: For TLS, we save the implicit record sequence number
5166 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5167 * and the caller has to make sure there's space for this.
5168 */
5169
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005170void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005171{
Hanno Becker79594fd2019-05-08 09:38:41 +01005172 /* This function sets the pointers to match the case
5173 * of unprotected TLS/DTLS records, with both ssl->in_iv
5174 * and ssl->in_msg pointing to the beginning of the record
5175 * content.
5176 *
5177 * When decrypting a protected record, ssl->in_msg
5178 * will be shifted to point to the beginning of the
5179 * record plaintext.
5180 */
5181
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005182#if defined(MBEDTLS_SSL_PROTO_DTLS)
5183 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5184 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005185 /* This sets the header pointers to match records
5186 * without CID. When we receive a record containing
5187 * a CID, the fields are shifted accordingly in
5188 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005189 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005190#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005191 ssl->in_cid = ssl->in_ctr + 8;
5192 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005193#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005194 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005196 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005197 }
5198 else
5199#endif
5200 {
5201 ssl->in_ctr = ssl->in_hdr - 8;
5202 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005203#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005204 ssl->in_cid = ssl->in_len;
5205#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005206 ssl->in_iv = ssl->in_hdr + 5;
5207 }
5208
Hanno Becker79594fd2019-05-08 09:38:41 +01005209 /* This will be adjusted at record decryption time. */
5210 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211}
5212
Paul Bakker5121ce52009-01-03 21:22:43 +00005213/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005214 * Setup an SSL context
5215 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005216
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005217void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005218{
5219 /* Set the incoming and outgoing record pointers. */
5220#if defined(MBEDTLS_SSL_PROTO_DTLS)
5221 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5222 {
5223 ssl->out_hdr = ssl->out_buf;
5224 ssl->in_hdr = ssl->in_buf;
5225 }
5226 else
5227#endif /* MBEDTLS_SSL_PROTO_DTLS */
5228 {
5229 ssl->out_hdr = ssl->out_buf + 8;
5230 ssl->in_hdr = ssl->in_buf + 8;
5231 }
5232
5233 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005234 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5235 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005236}
5237
Paul Bakker5121ce52009-01-03 21:22:43 +00005238/*
5239 * SSL get accessors
5240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005241size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005242{
5243 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5244}
5245
Hanno Becker8b170a02017-10-10 11:51:19 +01005246int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5247{
5248 /*
5249 * Case A: We're currently holding back
5250 * a message for further processing.
5251 */
5252
5253 if( ssl->keep_current_message == 1 )
5254 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005255 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005256 return( 1 );
5257 }
5258
5259 /*
5260 * Case B: Further records are pending in the current datagram.
5261 */
5262
5263#if defined(MBEDTLS_SSL_PROTO_DTLS)
5264 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5265 ssl->in_left > ssl->next_record_offset )
5266 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005267 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005268 return( 1 );
5269 }
5270#endif /* MBEDTLS_SSL_PROTO_DTLS */
5271
5272 /*
5273 * Case C: A handshake message is being processed.
5274 */
5275
Hanno Becker8b170a02017-10-10 11:51:19 +01005276 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5277 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005278 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005279 return( 1 );
5280 }
5281
5282 /*
5283 * Case D: An application data message is being processed
5284 */
5285 if( ssl->in_offt != NULL )
5286 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005288 return( 1 );
5289 }
5290
5291 /*
5292 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005293 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005294 * we implement support for multiple alerts in single records.
5295 */
5296
5297 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5298 return( 0 );
5299}
5300
Paul Bakker43ca69c2011-01-15 17:35:19 +00005301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005302int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005303{
Hanno Becker3136ede2018-08-17 15:28:19 +01005304 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005305 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005306 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005307
Hanno Becker5903de42019-05-03 14:46:38 +01005308 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5309
Hanno Becker78640902018-08-13 16:35:15 +01005310 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005311 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005313#if defined(MBEDTLS_ZLIB_SUPPORT)
5314 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5315 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005316#endif
5317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005319 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005320 case MBEDTLS_MODE_GCM:
5321 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005322 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005323 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005324 transform_expansion = transform->minlen;
5325 break;
5326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005327 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005328
5329 block_size = mbedtls_cipher_get_block_size(
5330 &transform->cipher_ctx_enc );
5331
Hanno Becker3136ede2018-08-17 15:28:19 +01005332 /* Expansion due to the addition of the MAC. */
5333 transform_expansion += transform->maclen;
5334
5335 /* Expansion due to the addition of CBC padding;
5336 * Theoretically up to 256 bytes, but we never use
5337 * more than the block size of the underlying cipher. */
5338 transform_expansion += block_size;
5339
5340 /* For TLS 1.1 or higher, an explicit IV is added
5341 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005342#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5343 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005344 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005345#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005346
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005347 break;
5348
5349 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005351 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005352 }
5353
Hanno Beckera0e20d02019-05-15 14:03:01 +01005354#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005355 if( transform->out_cid_len != 0 )
5356 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005357#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005358
Hanno Becker5903de42019-05-03 14:46:38 +01005359 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005360}
5361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005363/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005364 * Check record counters and renegotiate if they're above the limit.
5365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005367{
Hanno Beckerdd772292020-02-05 10:38:31 +00005368 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005369 int in_ctr_cmp;
5370 int out_ctr_cmp;
5371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5373 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005374 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005375 {
5376 return( 0 );
5377 }
5378
Andres AG2196c7f2016-12-15 17:01:16 +00005379 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5380 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005381 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005382 ssl->conf->renego_period + ep_len, 8 - ep_len );
5383
5384 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005385 {
5386 return( 0 );
5387 }
5388
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005390 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005391}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005393
5394/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005395 * Receive application data decrypted from the SSL layer
5396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005397int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005398{
Janos Follath865b3eb2019-12-16 11:46:15 +00005399 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005400 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005401
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005402 if( ssl == NULL || ssl->conf == NULL )
5403 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5404
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005405 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005406
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005408 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005411 return( ret );
5412
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005413 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005414 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005415 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005416 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005417 return( ret );
5418 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005419 }
5420#endif
5421
Hanno Becker4a810fb2017-05-24 16:27:30 +01005422 /*
5423 * Check if renegotiation is necessary and/or handshake is
5424 * in process. If yes, perform/continue, and fall through
5425 * if an unexpected packet is received while the client
5426 * is waiting for the ServerHello.
5427 *
5428 * (There is no equivalent to the last condition on
5429 * the server-side as it is not treated as within
5430 * a handshake while waiting for the ClientHello
5431 * after a renegotiation request.)
5432 */
5433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005435 ret = ssl_check_ctr_renegotiate( ssl );
5436 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5437 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005438 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005440 return( ret );
5441 }
5442#endif
5443
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005444 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005445 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005447 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5448 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005449 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005451 return( ret );
5452 }
5453 }
5454
Hanno Beckere41158b2017-10-23 13:30:32 +01005455 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005456 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005457 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005458 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005459 if( ssl->f_get_timer != NULL &&
5460 ssl->f_get_timer( ssl->p_timer ) == -1 )
5461 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005462 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005463 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005464
Hanno Becker327c93b2018-08-15 13:56:18 +01005465 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005466 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005467 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5468 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005469
Hanno Becker4a810fb2017-05-24 16:27:30 +01005470 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5471 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005472 }
5473
5474 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005476 {
5477 /*
5478 * OpenSSL sends empty messages to randomize the IV
5479 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005480 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005482 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005483 return( 0 );
5484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005486 return( ret );
5487 }
5488 }
5489
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005490 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005491 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005492 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005493
Hanno Becker4a810fb2017-05-24 16:27:30 +01005494 /*
5495 * - For client-side, expect SERVER_HELLO_REQUEST.
5496 * - For server-side, expect CLIENT_HELLO.
5497 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5498 */
5499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005501 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005503 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005506
5507 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005509 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005510 {
5511 continue;
5512 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005513#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005514 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005515 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005516#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005517
Hanno Becker4a810fb2017-05-24 16:27:30 +01005518#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005519 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005521 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005523
5524 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005525#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005526 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005527 {
5528 continue;
5529 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005530#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005531 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005532 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005533#endif /* MBEDTLS_SSL_SRV_C */
5534
Hanno Becker21df7f92017-10-17 11:03:26 +01005535#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005536 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005537 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5538 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5539 ssl->conf->allow_legacy_renegotiation ==
5540 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5541 {
5542 /*
5543 * Accept renegotiation request
5544 */
Paul Bakker48916f92012-09-16 19:57:18 +00005545
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005546 /* DTLS clients need to know renego is server-initiated */
5547#if defined(MBEDTLS_SSL_PROTO_DTLS)
5548 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5549 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5550 {
5551 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5552 }
5553#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005554 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005555 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5556 ret != 0 )
5557 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005558 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5559 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005560 return( ret );
5561 }
5562 }
5563 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005564#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005565 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005566 /*
5567 * Refuse renegotiation
5568 */
5569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572#if defined(MBEDTLS_SSL_PROTO_SSL3)
5573 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005574 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005575 /* SSLv3 does not have a "no_renegotiation" warning, so
5576 we send a fatal alert and abort the connection. */
5577 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5578 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5579 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005580 }
5581 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5583#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5584 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5585 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5588 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5589 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005590 {
5591 return( ret );
5592 }
Paul Bakker48916f92012-09-16 19:57:18 +00005593 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005594 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5596 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005597 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005598 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5599 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005600 }
Paul Bakker48916f92012-09-16 19:57:18 +00005601 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005602
Hanno Becker90333da2017-10-10 11:27:13 +01005603 /* At this point, we don't know whether the renegotiation has been
5604 * completed or not. The cases to consider are the following:
5605 * 1) The renegotiation is complete. In this case, no new record
5606 * has been read yet.
5607 * 2) The renegotiation is incomplete because the client received
5608 * an application data record while awaiting the ServerHello.
5609 * 3) The renegotiation is incomplete because the client received
5610 * a non-handshake, non-application data message while awaiting
5611 * the ServerHello.
5612 * In each of these case, looping will be the proper action:
5613 * - For 1), the next iteration will read a new record and check
5614 * if it's application data.
5615 * - For 2), the loop condition isn't satisfied as application data
5616 * is present, hence continue is the same as break
5617 * - For 3), the loop condition is satisfied and read_record
5618 * will re-deliver the message that was held back by the client
5619 * when expecting the ServerHello.
5620 */
5621 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005622 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005623#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005624 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005625 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005626 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005627 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005628 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005631 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005632 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005633 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005634 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005635 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005636#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5639 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005642 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005643 }
5644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005645 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5648 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005649 }
5650
5651 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005652
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005653 /* We're going to return something now, cancel timer,
5654 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005655 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005656 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005657
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005658#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005659 /* If we requested renego but received AppData, resend HelloRequest.
5660 * Do it now, after setting in_offt, to avoid taking this branch
5661 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005662#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005663 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005664 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005665 {
Hanno Becker786300f2020-02-05 10:46:40 +00005666 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005667 {
Hanno Becker786300f2020-02-05 10:46:40 +00005668 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5669 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005670 return( ret );
5671 }
5672 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005674#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005675 }
5676
5677 n = ( len < ssl->in_msglen )
5678 ? len : ssl->in_msglen;
5679
5680 memcpy( buf, ssl->in_offt, n );
5681 ssl->in_msglen -= n;
5682
gabor-mezei-arma3214132020-07-15 10:55:00 +02005683 /* Zeroising the plaintext buffer to erase unused application data
5684 from the memory. */
5685 mbedtls_platform_zeroize( ssl->in_offt, n );
5686
Paul Bakker5121ce52009-01-03 21:22:43 +00005687 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005688 {
5689 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005690 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005691 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005692 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005693 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005694 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005695 /* more data available */
5696 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005697 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005699 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005700
Paul Bakker23986e52011-04-24 08:57:21 +00005701 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005702}
5703
5704/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005705 * Send application data to be encrypted by the SSL layer, taking care of max
5706 * fragment length and buffer size.
5707 *
5708 * According to RFC 5246 Section 6.2.1:
5709 *
5710 * Zero-length fragments of Application data MAY be sent as they are
5711 * potentially useful as a traffic analysis countermeasure.
5712 *
5713 * Therefore, it is possible that the input message length is 0 and the
5714 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005715 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005716static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005717 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005718{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005719 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5720 const size_t max_len = (size_t) ret;
5721
5722 if( ret < 0 )
5723 {
5724 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5725 return( ret );
5726 }
5727
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005728 if( len > max_len )
5729 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005730#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005731 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005734 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5735 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005736 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005738 }
5739 else
5740#endif
5741 len = max_len;
5742 }
Paul Bakker887bd502011-06-08 13:10:54 +00005743
Paul Bakker5121ce52009-01-03 21:22:43 +00005744 if( ssl->out_left != 0 )
5745 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005746 /*
5747 * The user has previously tried to send the data and
5748 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5749 * written. In this case, we expect the high-level write function
5750 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5751 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005752 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005753 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005754 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005755 return( ret );
5756 }
5757 }
Paul Bakker887bd502011-06-08 13:10:54 +00005758 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005759 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005760 /*
5761 * The user is trying to send a message the first time, so we need to
5762 * copy the data into the internal buffers and setup the data structure
5763 * to keep track of partial writes
5764 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005765 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005767 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005768
Hanno Becker67bc7c32018-08-06 11:33:50 +01005769 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005772 return( ret );
5773 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005774 }
5775
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005776 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005777}
5778
5779/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005780 * Write application data, doing 1/n-1 splitting if necessary.
5781 *
5782 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005783 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005784 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005786#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005787static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005788 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005789{
Janos Follath865b3eb2019-12-16 11:46:15 +00005790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005791
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005792 if( ssl->conf->cbc_record_splitting ==
5793 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005794 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5796 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5797 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005798 {
5799 return( ssl_write_real( ssl, buf, len ) );
5800 }
5801
5802 if( ssl->split_done == 0 )
5803 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005804 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005805 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005806 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005807 }
5808
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005809 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5810 return( ret );
5811 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005812
5813 return( ret + 1 );
5814}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005815#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005816
5817/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005818 * Write application data (public-facing wrapper)
5819 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005820int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005821{
Janos Follath865b3eb2019-12-16 11:46:15 +00005822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005823
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005825
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005826 if( ssl == NULL || ssl->conf == NULL )
5827 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5828
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005829#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005830 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5831 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005832 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005833 return( ret );
5834 }
5835#endif
5836
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005837 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005838 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005839 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005840 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005841 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005842 return( ret );
5843 }
5844 }
5845
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005846#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005847 ret = ssl_write_split( ssl, buf, len );
5848#else
5849 ret = ssl_write_real( ssl, buf, len );
5850#endif
5851
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005853
5854 return( ret );
5855}
5856
5857/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005858 * Notify the peer that the connection is being closed
5859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005860int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005861{
Janos Follath865b3eb2019-12-16 11:46:15 +00005862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005863
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005864 if( ssl == NULL || ssl->conf == NULL )
5865 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005867 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005868
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005869 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005870 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005872 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005873 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005874 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5875 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5876 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005877 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005878 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005879 return( ret );
5880 }
5881 }
5882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005884
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005885 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005886}
5887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005888void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005889{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005890 if( transform == NULL )
5891 return;
5892
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005893#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005894 deflateEnd( &transform->ctx_deflate );
5895 inflateEnd( &transform->ctx_inflate );
5896#endif
5897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005898 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5899 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005900
Hanno Beckerd56ed242018-01-03 15:32:51 +00005901#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005902 mbedtls_md_free( &transform->md_ctx_enc );
5903 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005904#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005905
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005906 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005907}
5908
Hanno Becker0271f962018-08-16 13:23:47 +01005909#if defined(MBEDTLS_SSL_PROTO_DTLS)
5910
Hanno Becker533ab5f2020-02-05 10:49:13 +00005911void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005912{
5913 unsigned offset;
5914 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5915
5916 if( hs == NULL )
5917 return;
5918
Hanno Becker283f5ef2018-08-24 09:34:47 +01005919 ssl_free_buffered_record( ssl );
5920
Hanno Becker0271f962018-08-16 13:23:47 +01005921 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005922 ssl_buffering_free_slot( ssl, offset );
5923}
5924
5925static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5926 uint8_t slot )
5927{
5928 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5929 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005930
5931 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5932 return;
5933
Hanno Beckere605b192018-08-21 15:59:07 +01005934 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005935 {
Hanno Beckere605b192018-08-21 15:59:07 +01005936 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005937 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005938 mbedtls_free( hs_buf->data );
5939 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005940 }
5941}
5942
5943#endif /* MBEDTLS_SSL_PROTO_DTLS */
5944
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005945/*
5946 * Convert version numbers to/from wire format
5947 * and, for DTLS, to/from TLS equivalent.
5948 *
5949 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005950 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005951 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5952 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005954void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005955 unsigned char ver[2] )
5956{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005957#if defined(MBEDTLS_SSL_PROTO_DTLS)
5958 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005959 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005960 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005961 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5962
5963 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5964 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5965 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005966 else
5967#else
5968 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005969#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005970 {
5971 ver[0] = (unsigned char) major;
5972 ver[1] = (unsigned char) minor;
5973 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005974}
5975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005976void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005977 const unsigned char ver[2] )
5978{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005979#if defined(MBEDTLS_SSL_PROTO_DTLS)
5980 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005981 {
5982 *major = 255 - ver[0] + 2;
5983 *minor = 255 - ver[1] + 1;
5984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005985 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005986 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5987 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005988 else
5989#else
5990 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005991#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005992 {
5993 *major = ver[0];
5994 *minor = ver[1];
5995 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005996}
5997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005998#endif /* MBEDTLS_SSL_TLS_C */