blob: 3efb74c9d96a74bc04c39dacc518396734a5f918 [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 mask generation for "less than" comparison:
1050 * - if x < y, return all bits 1, that is (size_t) -1
1051 * - otherwise, return all bits 0, that is 0
1052 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001053 * This function can be used to write constant-time code by replacing branches
1054 * with bit operations using masks.
1055 *
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_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001060{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001061 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001062 const size_t sub = x - y;
1063
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001064 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001065 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1066
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001067 /* mask = (x < y) ? 0xff... : 0x00... */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001068 const size_t mask = mbedtls_cf_size_mask( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001069
1070 return( mask );
1071}
1072
1073/*
1074 * Constant-flow mask generation for "greater or equal" comparison:
1075 * - if x >= y, return all bits 1, that is (size_t) -1
1076 * - otherwise, return all bits 0, that is 0
1077 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001078 * This function can be used to write constant-time code by replacing branches
1079 * with bit operations using masks.
1080 *
1081 * This function is implemented without using comparison operators, as those
1082 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001083 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001084static size_t mbedtls_cf_size_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001085{
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001086 return( ~mbedtls_cf_size_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001087}
1088
1089/*
1090 * Constant-flow boolean "equal" comparison:
1091 * return x == y
1092 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001093 * This function can be used to write constant-time code by replacing branches
1094 * with bit operations - it can be used in conjunction with
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001095 * mbedtls_cf_size_mask().
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001096 *
1097 * This function is implemented without using comparison operators, as those
1098 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001099 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001100static size_t mbedtls_cf_size_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001101{
1102 /* diff = 0 if x == y, non-zero otherwise */
1103 const size_t diff = x ^ y;
1104
1105 /* MSVC has a warning about unary minus on unsigned integer types,
1106 * but this is well-defined and precisely what we want to do here. */
1107#if defined(_MSC_VER)
1108#pragma warning( push )
1109#pragma warning( disable : 4146 )
1110#endif
1111
1112 /* diff_msb's most significant bit is equal to x != y */
1113 const size_t diff_msb = ( diff | -diff );
1114
1115#if defined(_MSC_VER)
1116#pragma warning( pop )
1117#endif
1118
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001119 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001120 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1121
1122 return( 1 ^ diff1 );
1123}
1124
1125/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001126 * Constant-flow conditional memcpy:
1127 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1128 * - otherwise, a no-op,
1129 * but with execution flow independent of the values of c1 and c2.
1130 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001131 * This function is implemented without using comparison operators, as those
1132 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001133 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001134static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1135 const unsigned char *src,
1136 size_t len,
1137 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001138{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001139 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001140 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1141 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001142
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001143 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001144 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001145 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001146}
1147
1148/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001149 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001150 *
1151 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1152 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001153 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001154MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001155 mbedtls_md_context_t *ctx,
1156 const unsigned char *add_data, size_t add_data_len,
1157 const unsigned char *data, size_t data_len_secret,
1158 size_t min_data_len, size_t max_data_len,
1159 unsigned char *output )
1160{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001161 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001162 * This function breaks the HMAC abstraction and uses the md_clone()
1163 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001164 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001165 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001166 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001167 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001168 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001169 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1170 * minlen, then cloning the context, and for each byte up to maxlen
1171 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001172 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001173 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001174 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001175 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001176 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1177 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001178 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001179 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001180 const unsigned char * const okey = ikey + block_size;
1181 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001182
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001183 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1184 mbedtls_md_context_t aux;
1185 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001186 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001187
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001188 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001189
1190#define MD_CHK( func_call ) \
1191 do { \
1192 ret = (func_call); \
1193 if( ret != 0 ) \
1194 goto cleanup; \
1195 } while( 0 )
1196
1197 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001198
1199 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1200 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001201 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1202 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001203
1204 /* For each possible length, compute the hash up to that point */
1205 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001206 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001207 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1208 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001209 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001210 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1211 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001212
1213 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001214 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001215 }
1216
Manuel Pégourié-Gonnard21bfbdd2021-05-17 12:28:08 +02001217 /* The context needs to finish() before it starts() again */
1218 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1219
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001220 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001221 MD_CHK( mbedtls_md_starts( ctx ) );
1222 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1223 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1224 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001225
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001226 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001227 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001228
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001229#undef MD_CHK
1230
1231cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001232 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001233 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001234}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001235
1236/*
1237 * Constant-flow memcpy from variable position in buffer.
1238 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001239 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001240 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001241MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001242 unsigned char *dst,
1243 const unsigned char *src_base,
1244 size_t offset_secret,
1245 size_t offset_min, size_t offset_max,
1246 size_t len )
1247{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001248 size_t offset;
1249
1250 for( offset = offset_min; offset <= offset_max; offset++ )
1251 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001252 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1253 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001254 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001255}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001256#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001257
Hanno Becker605949f2019-07-12 08:23:59 +01001258int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001259 mbedtls_ssl_transform *transform,
1260 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001261{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001262 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001265#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001266 size_t padlen = 0, correct = 1;
1267#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001268 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001269 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001270 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271
Hanno Beckera18d1322018-01-03 14:27:32 +00001272#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001273 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001274 ((void) ssl);
1275#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001278 if( rec == NULL ||
1279 rec->buf == NULL ||
1280 rec->buf_len < rec->data_offset ||
1281 rec->buf_len - rec->data_offset < rec->data_len )
1282 {
1283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001285 }
1286
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 data = rec->buf + rec->data_offset;
1288 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001289
Hanno Beckera0e20d02019-05-15 14:03:01 +01001290#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001291 /*
1292 * Match record's CID with incoming CID.
1293 */
Hanno Becker938489a2019-05-08 13:02:22 +01001294 if( rec->cid_len != transform->in_cid_len ||
1295 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1296 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001297 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001298 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001299#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1302 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001303 {
1304 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001305 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1306 transform->iv_dec,
1307 transform->ivlen,
1308 data, rec->data_len,
1309 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001310 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001312 return( ret );
1313 }
1314
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001316 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1318 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001319 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001320 }
Paul Bakker68884e32013-01-07 18:20:04 +01001321 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001322#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001323#if defined(MBEDTLS_GCM_C) || \
1324 defined(MBEDTLS_CCM_C) || \
1325 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001327 mode == MBEDTLS_MODE_CCM ||
1328 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001329 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001330 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001331 unsigned char *dynamic_iv;
1332 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001333
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001334 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001335 * Extract dynamic part of nonce for AEAD decryption.
1336 *
1337 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1338 * part of the IV is prepended to the ciphertext and
1339 * can be chosen freely - in particular, it need not
1340 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001341 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001342 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001343 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001344 {
1345 if( rec->data_len < dynamic_iv_len )
1346 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001347 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1348 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001349 rec->data_len,
1350 dynamic_iv_len ) );
1351 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1352 }
1353 dynamic_iv = data;
1354
1355 data += dynamic_iv_len;
1356 rec->data_offset += dynamic_iv_len;
1357 rec->data_len -= dynamic_iv_len;
1358 }
Hanno Becker17263802020-05-28 07:05:48 +01001359 else
1360 {
1361 dynamic_iv = rec->ctr;
1362 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001363
1364 /* Check that there's space for the authentication tag. */
1365 if( rec->data_len < transform->taglen )
1366 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001367 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1368 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001369 rec->data_len,
1370 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001372 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001373 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001374
Hanno Beckerdf8be222020-05-21 15:30:57 +01001375 /*
1376 * Prepare nonce from dynamic and static parts.
1377 */
Hanno Becker17263802020-05-28 07:05:48 +01001378 ssl_build_record_nonce( iv, sizeof( iv ),
1379 transform->iv_dec,
1380 transform->fixed_ivlen,
1381 dynamic_iv,
1382 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001383
Hanno Beckerdf8be222020-05-21 15:30:57 +01001384 /*
1385 * Build additional data for AEAD encryption.
1386 * This depends on the TLS version.
1387 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001388 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1389 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001390 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001391 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001392
Hanno Beckerd96a6522019-07-10 13:55:25 +01001393 /* Because of the check above, we know that there are
1394 * explicit_iv_len Bytes preceeding data, and taglen
1395 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001396 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001397 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001398
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001399 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001400 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001401 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001402
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001403 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001404 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001405 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001406 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001408 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001409 data, rec->data_len + transform->taglen, /* src */
1410 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001411 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001415 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1416 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001417
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001418 return( ret );
1419 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001420 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001421
Hanno Beckerd96a6522019-07-10 13:55:25 +01001422 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001423 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001424 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1426 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001427 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001428 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001429 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001431#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001434 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001435
Paul Bakker5121ce52009-01-03 21:22:43 +00001436 /*
Paul Bakker45829992013-01-03 14:52:21 +01001437 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1441 {
1442 /* The ciphertext is prefixed with the CBC IV. */
1443 minlen += transform->ivlen;
1444 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001445#endif
Paul Bakker45829992013-01-03 14:52:21 +01001446
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001447 /* Size considerations:
1448 *
1449 * - The CBC cipher text must not be empty and hence
1450 * at least of size transform->ivlen.
1451 *
1452 * Together with the potential IV-prefix, this explains
1453 * the first of the two checks below.
1454 *
1455 * - The record must contain a MAC, either in plain or
1456 * encrypted, depending on whether Encrypt-then-MAC
1457 * is used or not.
1458 * - If it is, the message contains the IV-prefix,
1459 * the CBC ciphertext, and the MAC.
1460 * - If it is not, the padded plaintext, and hence
1461 * the CBC ciphertext, has at least length maclen + 1
1462 * because there is at least the padding length byte.
1463 *
1464 * As the CBC ciphertext is not empty, both cases give the
1465 * lower bound minlen + maclen + 1 on the record size, which
1466 * we test for in the second check below.
1467 */
1468 if( rec->data_len < minlen + transform->ivlen ||
1469 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001470 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1472 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1473 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001474 "+ 1 ) ( + expl IV )", rec->data_len,
1475 transform->ivlen,
1476 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001478 }
1479
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001480 /*
1481 * Authenticate before decrypt if enabled
1482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001485 {
Hanno Becker992b6872017-11-09 18:57:39 +00001486 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001487
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001489
Hanno Beckerd96a6522019-07-10 13:55:25 +01001490 /* Update data_len in tandem with add_data.
1491 *
1492 * The subtraction is safe because of the previous check
1493 * data_len >= minlen + maclen + 1.
1494 *
1495 * Afterwards, we know that data + data_len is followed by at
1496 * least maclen Bytes, which justifies the call to
1497 * mbedtls_ssl_safer_memcmp() below.
1498 *
1499 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001501 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1502 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001503
Hanno Beckerd96a6522019-07-10 13:55:25 +01001504 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001505 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1506 add_data_len );
1507 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1508 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001509 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1510 data, rec->data_len );
1511 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1512 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001513
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1515 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001516 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001518
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1521 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001522 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001525 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001526 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001527 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001529
1530 /*
1531 * Check length sanity
1532 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001533
1534 /* We know from above that data_len > minlen >= 0,
1535 * so the following check in particular implies that
1536 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001538 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1540 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001541 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001543 }
1544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001546 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001547 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001548 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001549 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001550 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001551 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001552 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001553
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001554 data += transform->ivlen;
1555 rec->data_offset += transform->ivlen;
1556 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001557 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001559
Hanno Beckerd96a6522019-07-10 13:55:25 +01001560 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1561
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001562 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1563 transform->iv_dec, transform->ivlen,
1564 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001565 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001567 return( ret );
1568 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001569
Hanno Beckerd96a6522019-07-10 13:55:25 +01001570 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001571 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001572 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1574 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001575 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001578 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001579 {
1580 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001581 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1582 * records is equivalent to CBC decryption of the concatenation
1583 * of the records; in other words, IVs are maintained across
1584 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001585 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1587 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001588 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001589#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001590
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001591 /* Safe since data_len >= minlen + maclen + 1, so after having
1592 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001593 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1594 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001595 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001596
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001597 if( auth_done == 1 )
1598 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001599 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001600 rec->data_len,
1601 padlen + 1 );
1602 correct &= mask;
1603 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001604 }
1605 else
Paul Bakker45829992013-01-03 14:52:21 +01001606 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001607#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001608 if( rec->data_len < transform->maclen + padlen + 1 )
1609 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1611 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1612 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001613 rec->data_len,
1614 transform->maclen,
1615 padlen + 1 ) );
1616 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001617#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001619 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001620 rec->data_len,
1621 transform->maclen + padlen + 1 );
1622 correct &= mask;
1623 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001624 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001625
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001626 padlen++;
1627
1628 /* Regardless of the validity of the padding,
1629 * we have data_len >= padlen here. */
1630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001633 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001634 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1635 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001636 * the protocol (known as part of POODLE), so we don't care if the
1637 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001638 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001639 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001640#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1642 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001643 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001644#endif
Paul Bakker45829992013-01-03 14:52:21 +01001645 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001646 }
1647 }
1648 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1650#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1651 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001652 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001653 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001654 /* The padding check involves a series of up to 256
1655 * consecutive memory reads at the end of the record
1656 * plaintext buffer. In order to hide the length and
1657 * validity of the padding, always perform exactly
1658 * `min(256,plaintext_len)` reads (but take into account
1659 * only the last `padlen` bytes for the padding check). */
1660 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001661 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001662
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001663 /* Index of first padding byte; it has been ensured above
1664 * that the subtraction is safe. */
1665 size_t const padding_idx = rec->data_len - padlen;
1666 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1667 size_t const start_idx = rec->data_len - num_checks;
1668 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001669
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001670 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001671 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001672 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001673 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001674 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001675 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1676 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1677 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001678 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001679 }
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001680 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001683 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001685#endif
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001686 padlen &= mbedtls_cf_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001687 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001688 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1690 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1693 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001694 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001695
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001696 /* If the padding was found to be invalid, padlen == 0
1697 * and the subtraction is safe. If the padding was found valid,
1698 * padlen hasn't been changed and the previous assertion
1699 * data_len >= padlen still holds. */
1700 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001701 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001702 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001703#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001707 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001708
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001709#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001711 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001712#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001713
1714 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001715 * Authenticate if not done yet.
1716 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001717 */
Hanno Becker52344c22018-01-03 15:24:20 +00001718#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001719 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001720 {
Hanno Becker992b6872017-11-09 18:57:39 +00001721 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001722 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001723
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001724 /* If the initial value of padlen was such that
1725 * data_len < maclen + padlen + 1, then padlen
1726 * got reset to 1, and the initial check
1727 * data_len >= minlen + maclen + 1
1728 * guarantees that at this point we still
1729 * have at least data_len >= maclen.
1730 *
1731 * If the initial value of padlen was such that
1732 * data_len >= maclen + padlen + 1, then we have
1733 * subtracted either padlen + 1 (if the padding was correct)
1734 * or 0 (if the padding was incorrect) since then,
1735 * hence data_len >= maclen in any case.
1736 */
1737 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001738 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1739 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001742 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001743 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001744 ssl_mac( &transform->md_ctx_dec,
1745 transform->mac_dec,
1746 data, rec->data_len,
1747 rec->ctr, rec->type,
1748 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001749 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001750 }
1751 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1753#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1754 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001755 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001756 {
1757 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001758 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001759 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001760 *
1761 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001762 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001763 *
1764 * Note that max_len + maclen is never more than the buffer
1765 * length, as we previously did in_msglen -= maclen too.
1766 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001767 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001768 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1769
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001770 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1771 add_data, add_data_len,
1772 data, rec->data_len, min_len, max_len,
1773 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001774 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001775 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1777 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001778 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001779
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001780 mbedtls_cf_memcpy_offset( mac_peer, data,
1781 rec->data_len,
1782 min_len, max_len,
1783 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001784 }
1785 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1787 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001788 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1790 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001791 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001792
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001793#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001794 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001795 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001796#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001797
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001798 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001799 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001800 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#if defined(MBEDTLS_SSL_DEBUG_ALL)
1802 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001803#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001804 correct = 0;
1805 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001806 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001807 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001808
1809 /*
1810 * Finally check the correct flag
1811 */
1812 if( correct == 0 )
1813 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001814#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001815
1816 /* Make extra sure authentication was performed, exactly once */
1817 if( auth_done != 1 )
1818 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1820 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001821 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001822
Hanno Beckerccc13d02020-05-04 12:30:04 +01001823#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1824 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1825 {
1826 /* Remove inner padding and infer true content type. */
1827 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1828 &rec->type );
1829
1830 if( ret != 0 )
1831 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1832 }
1833#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1834
Hanno Beckera0e20d02019-05-15 14:03:01 +01001835#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001836 if( rec->cid_len != 0 )
1837 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001838 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1839 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001840 if( ret != 0 )
1841 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1842 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001846
1847 return( 0 );
1848}
1849
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001850#undef MAC_NONE
1851#undef MAC_PLAINTEXT
1852#undef MAC_CIPHERTEXT
1853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001854#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001855/*
1856 * Compression/decompression functions
1857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001859{
Janos Follath865b3eb2019-12-16 11:46:15 +00001860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001861 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001862 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001863 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001864 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001865#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1866 size_t out_buf_len = ssl->out_buf_len;
1867#else
1868 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1869#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001872
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001873 if( len_pre == 0 )
1874 return( 0 );
1875
Paul Bakker2770fbd2012-07-03 13:30:23 +00001876 memcpy( msg_pre, ssl->out_msg, len_pre );
1877
Paul Elliottd48d5c62021-01-07 14:47:05 +00001878 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001879 ssl->out_msglen ) );
1880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001882 ssl->out_msg, ssl->out_msglen );
1883
Paul Bakker48916f92012-09-16 19:57:18 +00001884 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1885 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1886 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001887 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001888
Paul Bakker48916f92012-09-16 19:57:18 +00001889 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001890 if( ret != Z_OK )
1891 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1893 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001894 }
1895
Darryl Greenb33cc762019-11-28 14:29:44 +00001896 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001897 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001898
Paul Elliottd48d5c62021-01-07 14:47:05 +00001899 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001900 ssl->out_msglen ) );
1901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001903 ssl->out_msg, ssl->out_msglen );
1904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001906
1907 return( 0 );
1908}
1909
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001911{
Janos Follath865b3eb2019-12-16 11:46:15 +00001912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001913 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001914 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001915 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001916 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001917#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1918 size_t in_buf_len = ssl->in_buf_len;
1919#else
1920 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1921#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001924
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001925 if( len_pre == 0 )
1926 return( 0 );
1927
Paul Bakker2770fbd2012-07-03 13:30:23 +00001928 memcpy( msg_pre, ssl->in_msg, len_pre );
1929
Paul Elliottd48d5c62021-01-07 14:47:05 +00001930 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001931 ssl->in_msglen ) );
1932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001934 ssl->in_msg, ssl->in_msglen );
1935
Paul Bakker48916f92012-09-16 19:57:18 +00001936 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1937 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1938 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001939 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001940
Paul Bakker48916f92012-09-16 19:57:18 +00001941 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001942 if( ret != Z_OK )
1943 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1945 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001946 }
1947
Darryl Greenb33cc762019-11-28 14:29:44 +00001948 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001949 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001950
Paul Elliottd48d5c62021-01-07 14:47:05 +00001951 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001952 ssl->in_msglen ) );
1953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001955 ssl->in_msg, ssl->in_msglen );
1956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001958
1959 return( 0 );
1960}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001962
Paul Bakker5121ce52009-01-03 21:22:43 +00001963/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001964 * Fill the input message buffer by appending data to it.
1965 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001966 *
1967 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1968 * available (from this read and/or a previous one). Otherwise, an error code
1969 * is returned (possibly EOF or WANT_READ).
1970 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001971 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1972 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1973 * since we always read a whole datagram at once.
1974 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001975 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001976 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001979{
Janos Follath865b3eb2019-12-16 11:46:15 +00001980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001981 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001982#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1983 size_t in_buf_len = ssl->in_buf_len;
1984#else
1985 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1986#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001989
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001990 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1991 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001993 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001995 }
1996
Darryl Greenb33cc762019-11-28 14:29:44 +00001997 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001998 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
2000 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002001 }
2002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002004 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00002005 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002006 uint32_t timeout;
2007
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002008 /*
2009 * The point is, we need to always read a full datagram at once, so we
2010 * sometimes read more then requested, and handle the additional data.
2011 * It could be the rest of the current record (while fetching the
2012 * header) and/or some other records in the same datagram.
2013 */
2014
2015 /*
2016 * Move to the next record in the already read datagram if applicable
2017 */
2018 if( ssl->next_record_offset != 0 )
2019 {
2020 if( ssl->in_left < ssl->next_record_offset )
2021 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2023 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002024 }
2025
2026 ssl->in_left -= ssl->next_record_offset;
2027
2028 if( ssl->in_left != 0 )
2029 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
2031 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002032 ssl->next_record_offset ) );
2033 memmove( ssl->in_hdr,
2034 ssl->in_hdr + ssl->next_record_offset,
2035 ssl->in_left );
2036 }
2037
2038 ssl->next_record_offset = 0;
2039 }
2040
Paul Elliottd48d5c62021-01-07 14:47:05 +00002041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2042 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00002043 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002044
2045 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002046 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002047 */
2048 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002049 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002051 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002052 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002053
2054 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002055 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002056 * are not at the beginning of a new record, the caller did something
2057 * wrong.
2058 */
2059 if( ssl->in_left != 0 )
2060 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2062 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002063 }
2064
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002065 /*
2066 * Don't even try to read if time's out already.
2067 * This avoids by-passing the timer when repeatedly receiving messages
2068 * that will end up being dropped.
2069 */
Hanno Becker7876d122020-02-05 10:39:31 +00002070 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002071 {
2072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002073 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002074 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002075 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002076 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002077 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002080 timeout = ssl->handshake->retransmit_timeout;
2081 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002082 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002083
Paul Elliott9f352112020-12-09 14:55:45 +00002084 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002085
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002086 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002087 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2088 timeout );
2089 else
2090 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002093
2094 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002096 }
2097
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002098 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002099 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002101 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002104 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002105 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002108 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002109 }
2110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002114 return( ret );
2115 }
2116
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002117 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002118 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002120 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002122 {
Hanno Becker786300f2020-02-05 10:46:40 +00002123 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002124 {
Hanno Becker786300f2020-02-05 10:46:40 +00002125 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2126 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002127 return( ret );
2128 }
2129
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002130 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002131 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002133 }
2134
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 if( ret < 0 )
2136 return( ret );
2137
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002138 ssl->in_left = ret;
2139 }
2140 else
2141#endif
2142 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2144 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002145 ssl->in_left, nb_want ) );
2146
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002147 while( ssl->in_left < nb_want )
2148 {
2149 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002150
Hanno Becker7876d122020-02-05 10:39:31 +00002151 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002152 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2153 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002154 {
2155 if( ssl->f_recv_timeout != NULL )
2156 {
2157 ret = ssl->f_recv_timeout( ssl->p_bio,
2158 ssl->in_hdr + ssl->in_left, len,
2159 ssl->conf->read_timeout );
2160 }
2161 else
2162 {
2163 ret = ssl->f_recv( ssl->p_bio,
2164 ssl->in_hdr + ssl->in_left, len );
2165 }
2166 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002167
Paul Elliottd48d5c62021-01-07 14:47:05 +00002168 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2169 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002170 ssl->in_left, nb_want ) );
2171 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002172
2173 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002175
2176 if( ret < 0 )
2177 return( ret );
2178
makise-homuraaf9513b2020-08-24 18:26:27 +03002179 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002180 {
Darryl Green11999bb2018-03-13 15:22:58 +00002181 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002182 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002183 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002184 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2185 }
2186
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002187 ssl->in_left += ret;
2188 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002189 }
2190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002192
2193 return( 0 );
2194}
2195
2196/*
2197 * Flush any data not yet written
2198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002200{
Janos Follath865b3eb2019-12-16 11:46:15 +00002201 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002202 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002205
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002206 if( ssl->f_send == NULL )
2207 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002209 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002211 }
2212
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002213 /* Avoid incrementing counter if data is flushed */
2214 if( ssl->out_left == 0 )
2215 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002217 return( 0 );
2218 }
2219
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 while( ssl->out_left > 0 )
2221 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002222 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2223 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002224 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
Hanno Becker2b1e3542018-08-06 11:19:13 +01002226 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002227 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002228
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002230
2231 if( ret <= 0 )
2232 return( ret );
2233
makise-homuraaf9513b2020-08-24 18:26:27 +03002234 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002235 {
Darryl Green11999bb2018-03-13 15:22:58 +00002236 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002237 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002238 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002239 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2240 }
2241
Paul Bakker5121ce52009-01-03 21:22:43 +00002242 ssl->out_left -= ret;
2243 }
2244
Hanno Becker2b1e3542018-08-06 11:19:13 +01002245#if defined(MBEDTLS_SSL_PROTO_DTLS)
2246 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002247 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002248 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002249 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002250 else
2251#endif
2252 {
2253 ssl->out_hdr = ssl->out_buf + 8;
2254 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002255 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002258
2259 return( 0 );
2260}
2261
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002262/*
2263 * Functions to handle the DTLS retransmission state machine
2264 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002266/*
2267 * Append current handshake message to current outgoing flight
2268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002270{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2273 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2274 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002275
2276 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002277 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002278 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002279 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002281 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002282 }
2283
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002284 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002285 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002286 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2287 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002289 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002290 }
2291
2292 /* Copy current handshake message with headers */
2293 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2294 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002295 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296 msg->next = NULL;
2297
2298 /* Append to the current flight */
2299 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002300 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002301 else
2302 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002304 while( cur->next != NULL )
2305 cur = cur->next;
2306 cur->next = msg;
2307 }
2308
Hanno Becker3b235902018-08-06 09:54:53 +01002309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002310 return( 0 );
2311}
2312
2313/*
2314 * Free the current flight of handshake messages
2315 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002316void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002317{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002318 mbedtls_ssl_flight_item *cur = flight;
2319 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002320
2321 while( cur != NULL )
2322 {
2323 next = cur->next;
2324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325 mbedtls_free( cur->p );
2326 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002327
2328 cur = next;
2329 }
2330}
2331
2332/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002333 * Swap transform_out and out_ctr with the alternative ones
2334 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002335static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002336{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002338 unsigned char tmp_out_ctr[8];
2339
2340 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2341 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002343 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002344 }
2345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002347
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002348 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002349 tmp_transform = ssl->transform_out;
2350 ssl->transform_out = ssl->handshake->alt_transform_out;
2351 ssl->handshake->alt_transform_out = tmp_transform;
2352
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002353 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002354 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2355 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002356 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002357
2358 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002359 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2362 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002363 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002364 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2365 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002366 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2368 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002369 }
2370 }
2371#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002372
2373 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002374}
2375
2376/*
2377 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002378 */
2379int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2380{
2381 int ret = 0;
2382
2383 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2384
2385 ret = mbedtls_ssl_flight_transmit( ssl );
2386
2387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2388
2389 return( ret );
2390}
2391
2392/*
2393 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394 *
2395 * Need to remember the current message in case flush_output returns
2396 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002397 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002398 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002399int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400{
Janos Follath865b3eb2019-12-16 11:46:15 +00002401 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002402 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002405 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002407
2408 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002409 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002410 ret = ssl_swap_epochs( ssl );
2411 if( ret != 0 )
2412 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002413
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002415 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002416
2417 while( ssl->handshake->cur_msg != NULL )
2418 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002419 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002420 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002421
Hanno Beckere1dcb032018-08-17 16:47:58 +01002422 int const is_finished =
2423 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2424 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2425
Hanno Becker04da1892018-08-14 13:22:10 +01002426 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2427 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2428
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002429 /* Swap epochs before sending Finished: we can't do it after
2430 * sending ChangeCipherSpec, in case write returns WANT_READ.
2431 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002432 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002433 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002434 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002435 ret = ssl_swap_epochs( ssl );
2436 if( ret != 0 )
2437 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002438 }
2439
Hanno Becker67bc7c32018-08-06 11:33:50 +01002440 ret = ssl_get_remaining_payload_in_datagram( ssl );
2441 if( ret < 0 )
2442 return( ret );
2443 max_frag_len = (size_t) ret;
2444
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002445 /* CCS is copied as is, while HS messages may need fragmentation */
2446 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2447 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002448 if( max_frag_len == 0 )
2449 {
2450 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2451 return( ret );
2452
2453 continue;
2454 }
2455
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002456 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002457 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002458 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002459
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002460 /* Update position inside current message */
2461 ssl->handshake->cur_msg_p += cur->len;
2462 }
2463 else
2464 {
2465 const unsigned char * const p = ssl->handshake->cur_msg_p;
2466 const size_t hs_len = cur->len - 12;
2467 const size_t frag_off = p - ( cur->p + 12 );
2468 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002469 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002470
Hanno Beckere1dcb032018-08-17 16:47:58 +01002471 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002472 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002473 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002474 {
2475 ret = ssl_swap_epochs( ssl );
2476 if( ret != 0 )
2477 return( ret );
2478 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002479
Hanno Becker67bc7c32018-08-06 11:33:50 +01002480 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2481 return( ret );
2482
2483 continue;
2484 }
2485 max_hs_frag_len = max_frag_len - 12;
2486
2487 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2488 max_hs_frag_len : rem_len;
2489
2490 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002491 {
2492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002493 (unsigned) cur_hs_frag_len,
2494 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002495 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002496
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002497 /* Messages are stored with handshake headers as if not fragmented,
2498 * copy beginning of headers then fill fragmentation fields.
2499 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2500 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002501
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002502 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2503 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2504 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002505
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002506 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2507 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2508 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002509
2510 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2511
Hanno Becker3f7b9732018-08-28 09:53:25 +01002512 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002513 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2514 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002515 ssl->out_msgtype = cur->type;
2516
2517 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002518 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002519 }
2520
2521 /* If done with the current message move to the next one if any */
2522 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2523 {
2524 if( cur->next != NULL )
2525 {
2526 ssl->handshake->cur_msg = cur->next;
2527 ssl->handshake->cur_msg_p = cur->next->p + 12;
2528 }
2529 else
2530 {
2531 ssl->handshake->cur_msg = NULL;
2532 ssl->handshake->cur_msg_p = NULL;
2533 }
2534 }
2535
2536 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002537 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002538 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002540 return( ret );
2541 }
2542 }
2543
Hanno Becker67bc7c32018-08-06 11:33:50 +01002544 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2545 return( ret );
2546
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002547 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2549 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002550 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002553 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002554 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002555
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002557
2558 return( 0 );
2559}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002560
2561/*
2562 * To be called when the last message of an incoming flight is received.
2563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002565{
2566 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002567 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002568 ssl->handshake->flight = NULL;
2569 ssl->handshake->cur_msg = NULL;
2570
2571 /* The next incoming flight will start with this msg_seq */
2572 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2573
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002574 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002575 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002576
Hanno Becker0271f962018-08-16 13:23:47 +01002577 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002578 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002579
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002580 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002581 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2584 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002587 }
2588 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002590}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002591
2592/*
2593 * To be called when the last message of an outgoing flight is send.
2594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002596{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002597 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002598 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2601 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002602 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002604 }
2605 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002607}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002609
Paul Bakker5121ce52009-01-03 21:22:43 +00002610/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002611 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002612 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002613
2614/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002615 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002616 *
2617 * - fill in handshake headers
2618 * - update handshake checksum
2619 * - DTLS: save message for resending
2620 * - then pass to the record layer
2621 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002622 * DTLS: except for HelloRequest, messages are only queued, and will only be
2623 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002624 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002625 * Inputs:
2626 * - ssl->out_msglen: 4 + actual handshake message len
2627 * (4 is the size of handshake headers for TLS)
2628 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2629 * - ssl->out_msg + 4: the handshake message body
2630 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002631 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002632 * - ssl->out_msglen: the length of the record contents
2633 * (including handshake headers but excluding record headers)
2634 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002635 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002636int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002637{
Janos Follath865b3eb2019-12-16 11:46:15 +00002638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002639 const size_t hs_len = ssl->out_msglen - 4;
2640 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002641
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2643
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002644 /*
2645 * Sanity checks
2646 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002647 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002648 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2649 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002650 /* In SSLv3, the client might send a NoCertificate alert. */
2651#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2652 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2653 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2654 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2655#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2656 {
2657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2658 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2659 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002660 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002661
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002662 /* Whenever we send anything different from a
2663 * HelloRequest we should be in a handshake - double check. */
2664 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2665 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002666 ssl->handshake == NULL )
2667 {
2668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2669 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2670 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002673 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002674 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002676 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2678 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002679 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002680#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002681
Hanno Beckerb50a2532018-08-06 11:52:54 +01002682 /* Double-check that we did not exceed the bounds
2683 * of the outgoing record buffer.
2684 * This should never fail as the various message
2685 * writing functions must obey the bounds of the
2686 * outgoing record buffer, but better be safe.
2687 *
2688 * Note: We deliberately do not check for the MTU or MFL here.
2689 */
2690 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2691 {
2692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002693 "size %" MBEDTLS_PRINTF_SIZET
2694 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002695 ssl->out_msglen,
2696 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002697 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2698 }
2699
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002700 /*
2701 * Fill handshake headers
2702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002703 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002705 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2706 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2707 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002708
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002709 /*
2710 * DTLS has additional fields in the Handshake layer,
2711 * between the length field and the actual payload:
2712 * uint16 message_seq;
2713 * uint24 fragment_offset;
2714 * uint24 fragment_length;
2715 */
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 )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002718 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002719 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002720 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002721 {
2722 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002723 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002724 hs_len,
2725 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002726 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2727 }
2728
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002729 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002730 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002731
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002732 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002733 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002734 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002735 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002736 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002737 }
2738 else
2739 {
2740 ssl->out_msg[4] = 0;
2741 ssl->out_msg[5] = 0;
2742 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002743
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002744 /* Handshake hashes are computed without fragmentation,
2745 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002746 memset( ssl->out_msg + 6, 0x00, 3 );
2747 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002748 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002750
Hanno Becker0207e532018-08-28 10:28:28 +01002751 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002752 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2753 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002754 }
2755
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002756 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002758 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002759 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2760 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002761 {
2762 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002765 return( ret );
2766 }
2767 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002768 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002769#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002770 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002771 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002772 {
2773 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2774 return( ret );
2775 }
2776 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002777
2778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2779
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002780 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002781}
2782
2783/*
2784 * Record layer functions
2785 */
2786
2787/*
2788 * Write current record.
2789 *
2790 * Uses:
2791 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2792 * - ssl->out_msglen: length of the record content (excl headers)
2793 * - ssl->out_msg: record content
2794 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002795int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002796{
2797 int ret, done = 0;
2798 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002799 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002800
2801 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002804 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002806 {
2807 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2808 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002810 return( ret );
2811 }
2812
2813 len = ssl->out_msglen;
2814 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2818 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002819 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002821
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 ret = mbedtls_ssl_hw_record_write( ssl );
2823 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002824 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2826 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002827 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002828
2829 if( ret == 0 )
2830 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002831 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002833 if( !done )
2834 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002835 unsigned i;
2836 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002837#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2838 size_t out_buf_len = ssl->out_buf_len;
2839#else
2840 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2841#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002842 /* Skip writing the record content type to after the encryption,
2843 * as it may change when using the CID extension. */
2844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002846 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002847
Hanno Becker19859472018-08-06 09:40:20 +01002848 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002849 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002850
Paul Bakker48916f92012-09-16 19:57:18 +00002851 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002852 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002853 mbedtls_record rec;
2854
2855 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002856 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002857 rec.data_len = ssl->out_msglen;
2858 rec.data_offset = ssl->out_msg - rec.buf;
2859
2860 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2861 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2862 ssl->conf->transport, rec.ver );
2863 rec.type = ssl->out_msgtype;
2864
Hanno Beckera0e20d02019-05-15 14:03:01 +01002865#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002866 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002867 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002868#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002869
Hanno Beckera18d1322018-01-03 14:27:32 +00002870 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002871 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002872 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002874 return( ret );
2875 }
2876
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002877 if( rec.data_offset != 0 )
2878 {
2879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2880 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2881 }
2882
Hanno Becker6430faf2019-05-08 11:57:13 +01002883 /* Update the record content type and CID. */
2884 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002885#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002886 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002887#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002888 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002889 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002890 }
2891
Hanno Becker5903de42019-05-03 14:46:38 +01002892 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002893
2894#if defined(MBEDTLS_SSL_PROTO_DTLS)
2895 /* In case of DTLS, double-check that we don't exceed
2896 * the remaining space in the datagram. */
2897 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2898 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002899 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002900 if( ret < 0 )
2901 return( ret );
2902
2903 if( protected_record_size > (size_t) ret )
2904 {
2905 /* Should never happen */
2906 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2907 }
2908 }
2909#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002910
Hanno Becker6430faf2019-05-08 11:57:13 +01002911 /* Now write the potentially updated record content type. */
2912 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2913
Paul Elliott9f352112020-12-09 14:55:45 +00002914 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002915 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002916 ssl->out_hdr[0], ssl->out_hdr[1],
2917 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002919 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002920 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002921
2922 ssl->out_left += protected_record_size;
2923 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002924 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002925
Hanno Beckerdd772292020-02-05 10:38:31 +00002926 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002927 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2928 break;
2929
2930 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002931 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002932 {
2933 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2934 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2935 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002936 }
2937
Hanno Becker67bc7c32018-08-06 11:33:50 +01002938#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2940 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002941 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002942 size_t remaining;
2943 ret = ssl_get_remaining_payload_in_datagram( ssl );
2944 if( ret < 0 )
2945 {
2946 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2947 ret );
2948 return( ret );
2949 }
2950
2951 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002952 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002953 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002954 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002955 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002956 else
2957 {
Hanno Becker513815a2018-08-20 11:56:09 +01002958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002959 }
2960 }
2961#endif /* MBEDTLS_SSL_PROTO_DTLS */
2962
2963 if( ( flush == SSL_FORCE_FLUSH ) &&
2964 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002965 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002967 return( ret );
2968 }
2969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002971
2972 return( 0 );
2973}
2974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002976
2977static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2978{
2979 if( ssl->in_msglen < ssl->in_hslen ||
2980 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2981 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2982 {
2983 return( 1 );
2984 }
2985 return( 0 );
2986}
Hanno Becker44650b72018-08-16 12:51:11 +01002987
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002988static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002989{
2990 return( ( ssl->in_msg[9] << 16 ) |
2991 ( ssl->in_msg[10] << 8 ) |
2992 ssl->in_msg[11] );
2993}
2994
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002995static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002996{
2997 return( ( ssl->in_msg[6] << 16 ) |
2998 ( ssl->in_msg[7] << 8 ) |
2999 ssl->in_msg[8] );
3000}
3001
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003002static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003003{
3004 uint32_t msg_len, frag_off, frag_len;
3005
3006 msg_len = ssl_get_hs_total_len( ssl );
3007 frag_off = ssl_get_hs_frag_off( ssl );
3008 frag_len = ssl_get_hs_frag_len( ssl );
3009
3010 if( frag_off > msg_len )
3011 return( -1 );
3012
3013 if( frag_len > msg_len - frag_off )
3014 return( -1 );
3015
3016 if( frag_len + 12 > ssl->in_msglen )
3017 return( -1 );
3018
3019 return( 0 );
3020}
3021
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003022/*
3023 * Mark bits in bitmask (used for DTLS HS reassembly)
3024 */
3025static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
3026{
3027 unsigned int start_bits, end_bits;
3028
3029 start_bits = 8 - ( offset % 8 );
3030 if( start_bits != 8 )
3031 {
3032 size_t first_byte_idx = offset / 8;
3033
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003034 /* Special case */
3035 if( len <= start_bits )
3036 {
3037 for( ; len != 0; len-- )
3038 mask[first_byte_idx] |= 1 << ( start_bits - len );
3039
3040 /* Avoid potential issues with offset or len becoming invalid */
3041 return;
3042 }
3043
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003044 offset += start_bits; /* Now offset % 8 == 0 */
3045 len -= start_bits;
3046
3047 for( ; start_bits != 0; start_bits-- )
3048 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3049 }
3050
3051 end_bits = len % 8;
3052 if( end_bits != 0 )
3053 {
3054 size_t last_byte_idx = ( offset + len ) / 8;
3055
3056 len -= end_bits; /* Now len % 8 == 0 */
3057
3058 for( ; end_bits != 0; end_bits-- )
3059 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3060 }
3061
3062 memset( mask + offset / 8, 0xFF, len / 8 );
3063}
3064
3065/*
3066 * Check that bitmask is full
3067 */
3068static int ssl_bitmask_check( unsigned char *mask, size_t len )
3069{
3070 size_t i;
3071
3072 for( i = 0; i < len / 8; i++ )
3073 if( mask[i] != 0xFF )
3074 return( -1 );
3075
3076 for( i = 0; i < len % 8; i++ )
3077 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3078 return( -1 );
3079
3080 return( 0 );
3081}
3082
Hanno Becker56e205e2018-08-16 09:06:12 +01003083/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003084static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003085 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003086{
Hanno Becker56e205e2018-08-16 09:06:12 +01003087 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003088
Hanno Becker56e205e2018-08-16 09:06:12 +01003089 alloc_len = 12; /* Handshake header */
3090 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003091
Hanno Beckerd07df862018-08-16 09:14:58 +01003092 if( add_bitmap )
3093 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003094
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003095 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003096}
Hanno Becker56e205e2018-08-16 09:06:12 +01003097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003099
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003100static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003101{
3102 return( ( ssl->in_msg[1] << 16 ) |
3103 ( ssl->in_msg[2] << 8 ) |
3104 ssl->in_msg[3] );
3105}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003106
Simon Butcher99000142016-10-13 17:21:01 +01003107int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003108{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003110 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003111 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003112 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003114 }
3115
Hanno Becker12555c62018-08-16 12:47:53 +01003116 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003119 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003120 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003123 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003124 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003126 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003127
Hanno Becker44650b72018-08-16 12:51:11 +01003128 if( ssl_check_hs_header( ssl ) != 0 )
3129 {
3130 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3131 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3132 }
3133
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003134 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003135 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3136 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3137 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3138 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003139 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003140 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3141 {
3142 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3143 recv_msg_seq,
3144 ssl->handshake->in_msg_seq ) );
3145 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3146 }
3147
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003148 /* Retransmit only on last message from previous flight, to avoid
3149 * too many retransmissions.
3150 * Besides, No sane server ever retransmits HelloVerifyRequest */
3151 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003153 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003155 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003156 recv_msg_seq,
3157 ssl->handshake->in_flight_start_seq ) );
3158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003160 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003162 return( ret );
3163 }
3164 }
3165 else
3166 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003168 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003169 recv_msg_seq,
3170 ssl->handshake->in_msg_seq ) );
3171 }
3172
Hanno Becker90333da2017-10-10 11:27:13 +01003173 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003174 }
3175 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003176
Hanno Becker6d97ef52018-08-16 13:09:04 +01003177 /* Message reassembly is handled alongside buffering of future
3178 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003179 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003180 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003181 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003184 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003185 }
3186 }
3187 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003189 /* With TLS we don't handle fragmentation (for now) */
3190 if( ssl->in_msglen < ssl->in_hslen )
3191 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3193 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003194 }
3195
Simon Butcher99000142016-10-13 17:21:01 +01003196 return( 0 );
3197}
3198
3199void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3200{
Hanno Becker0271f962018-08-16 13:23:47 +01003201 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003202
Hanno Becker0271f962018-08-16 13:23:47 +01003203 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003204 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003205 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003206 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003207
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003208 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003210 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003211 ssl->handshake != NULL )
3212 {
Hanno Becker0271f962018-08-16 13:23:47 +01003213 unsigned offset;
3214 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003215
Hanno Becker0271f962018-08-16 13:23:47 +01003216 /* Increment handshake sequence number */
3217 hs->in_msg_seq++;
3218
3219 /*
3220 * Clear up handshake buffering and reassembly structure.
3221 */
3222
3223 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003224 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003225
3226 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003227 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3228 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003229 offset++, hs_buf++ )
3230 {
3231 *hs_buf = *(hs_buf + 1);
3232 }
3233
3234 /* Create a fresh last entry */
3235 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003236 }
3237#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003238}
3239
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003240/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003241 * DTLS anti-replay: RFC 6347 4.1.2.6
3242 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003243 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3244 * Bit n is set iff record number in_window_top - n has been seen.
3245 *
3246 * Usually, in_window_top is the last record number seen and the lsb of
3247 * in_window is set. The only exception is the initial state (record number 0
3248 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003249 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003251void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003252{
3253 ssl->in_window_top = 0;
3254 ssl->in_window = 0;
3255}
3256
3257static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3258{
3259 return( ( (uint64_t) buf[0] << 40 ) |
3260 ( (uint64_t) buf[1] << 32 ) |
3261 ( (uint64_t) buf[2] << 24 ) |
3262 ( (uint64_t) buf[3] << 16 ) |
3263 ( (uint64_t) buf[4] << 8 ) |
3264 ( (uint64_t) buf[5] ) );
3265}
3266
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003267static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3268{
Janos Follath865b3eb2019-12-16 11:46:15 +00003269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003270 unsigned char *original_in_ctr;
3271
3272 // save original in_ctr
3273 original_in_ctr = ssl->in_ctr;
3274
3275 // use counter from record
3276 ssl->in_ctr = record_in_ctr;
3277
3278 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3279
3280 // restore the counter
3281 ssl->in_ctr = original_in_ctr;
3282
3283 return ret;
3284}
3285
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003286/*
3287 * Return 0 if sequence number is acceptable, -1 otherwise
3288 */
Hanno Becker0183d692019-07-12 08:50:37 +01003289int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003290{
3291 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3292 uint64_t bit;
3293
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003294 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003295 return( 0 );
3296
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003297 if( rec_seqnum > ssl->in_window_top )
3298 return( 0 );
3299
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003300 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003301
3302 if( bit >= 64 )
3303 return( -1 );
3304
3305 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3306 return( -1 );
3307
3308 return( 0 );
3309}
3310
3311/*
3312 * Update replay window on new validated record
3313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003314void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003315{
3316 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3317
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003318 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003319 return;
3320
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003321 if( rec_seqnum > ssl->in_window_top )
3322 {
3323 /* Update window_top and the contents of the window */
3324 uint64_t shift = rec_seqnum - ssl->in_window_top;
3325
3326 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003327 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003328 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003329 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003330 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003331 ssl->in_window |= 1;
3332 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003333
3334 ssl->in_window_top = rec_seqnum;
3335 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003336 else
3337 {
3338 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003339 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003340
3341 if( bit < 64 ) /* Always true, but be extra sure */
3342 ssl->in_window |= (uint64_t) 1 << bit;
3343 }
3344}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003346
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003347#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003348/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003349 * Without any SSL context, check if a datagram looks like a ClientHello with
3350 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003351 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003352 *
3353 * - if cookie is valid, return 0
3354 * - if ClientHello looks superficially valid but cookie is not,
3355 * fill obuf and set olen, then
3356 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3357 * - otherwise return a specific error code
3358 */
3359static int ssl_check_dtls_clihlo_cookie(
3360 mbedtls_ssl_cookie_write_t *f_cookie_write,
3361 mbedtls_ssl_cookie_check_t *f_cookie_check,
3362 void *p_cookie,
3363 const unsigned char *cli_id, size_t cli_id_len,
3364 const unsigned char *in, size_t in_len,
3365 unsigned char *obuf, size_t buf_len, size_t *olen )
3366{
3367 size_t sid_len, cookie_len;
3368 unsigned char *p;
3369
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003370 /*
3371 * Structure of ClientHello with record and handshake headers,
3372 * and expected values. We don't need to check a lot, more checks will be
3373 * done when actually parsing the ClientHello - skipping those checks
3374 * avoids code duplication and does not make cookie forging any easier.
3375 *
3376 * 0-0 ContentType type; copied, must be handshake
3377 * 1-2 ProtocolVersion version; copied
3378 * 3-4 uint16 epoch; copied, must be 0
3379 * 5-10 uint48 sequence_number; copied
3380 * 11-12 uint16 length; (ignored)
3381 *
3382 * 13-13 HandshakeType msg_type; (ignored)
3383 * 14-16 uint24 length; (ignored)
3384 * 17-18 uint16 message_seq; copied
3385 * 19-21 uint24 fragment_offset; copied, must be 0
3386 * 22-24 uint24 fragment_length; (ignored)
3387 *
3388 * 25-26 ProtocolVersion client_version; (ignored)
3389 * 27-58 Random random; (ignored)
3390 * 59-xx SessionID session_id; 1 byte len + sid_len content
3391 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3392 * ...
3393 *
3394 * Minimum length is 61 bytes.
3395 */
3396 if( in_len < 61 ||
3397 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3398 in[3] != 0 || in[4] != 0 ||
3399 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3400 {
3401 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3402 }
3403
3404 sid_len = in[59];
3405 if( sid_len > in_len - 61 )
3406 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3407
3408 cookie_len = in[60 + sid_len];
3409 if( cookie_len > in_len - 60 )
3410 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3411
3412 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3413 cli_id, cli_id_len ) == 0 )
3414 {
3415 /* Valid cookie */
3416 return( 0 );
3417 }
3418
3419 /*
3420 * If we get here, we've got an invalid cookie, let's prepare HVR.
3421 *
3422 * 0-0 ContentType type; copied
3423 * 1-2 ProtocolVersion version; copied
3424 * 3-4 uint16 epoch; copied
3425 * 5-10 uint48 sequence_number; copied
3426 * 11-12 uint16 length; olen - 13
3427 *
3428 * 13-13 HandshakeType msg_type; hello_verify_request
3429 * 14-16 uint24 length; olen - 25
3430 * 17-18 uint16 message_seq; copied
3431 * 19-21 uint24 fragment_offset; copied
3432 * 22-24 uint24 fragment_length; olen - 25
3433 *
3434 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3435 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3436 *
3437 * Minimum length is 28.
3438 */
3439 if( buf_len < 28 )
3440 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3441
3442 /* Copy most fields and adapt others */
3443 memcpy( obuf, in, 25 );
3444 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3445 obuf[25] = 0xfe;
3446 obuf[26] = 0xff;
3447
3448 /* Generate and write actual cookie */
3449 p = obuf + 28;
3450 if( f_cookie_write( p_cookie,
3451 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3452 {
3453 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3454 }
3455
3456 *olen = p - obuf;
3457
3458 /* Go back and fill length fields */
3459 obuf[27] = (unsigned char)( *olen - 28 );
3460
Joe Subbianiad1115a2021-07-16 14:27:50 +01003461 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3462 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3463 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003464
Joe Subbianic54e9082021-07-19 11:56:54 +01003465 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003466
3467 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3468}
3469
3470/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003471 * Handle possible client reconnect with the same UDP quadruplet
3472 * (RFC 6347 Section 4.2.8).
3473 *
3474 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3475 * that looks like a ClientHello.
3476 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003477 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003478 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003479 * - if the input looks like a ClientHello with a valid cookie,
3480 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003481 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003482 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003483 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003484 * This function is called (through ssl_check_client_reconnect()) when an
3485 * unexpected record is found in ssl_get_next_record(), which will discard the
3486 * record if we return 0, and bubble up the return value otherwise (this
3487 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3488 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003489 */
3490static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3491{
Janos Follath865b3eb2019-12-16 11:46:15 +00003492 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003493 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003494
Hanno Becker2fddd372019-07-10 14:37:41 +01003495 if( ssl->conf->f_cookie_write == NULL ||
3496 ssl->conf->f_cookie_check == NULL )
3497 {
3498 /* If we can't use cookies to verify reachability of the peer,
3499 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003500 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3501 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003502 return( 0 );
3503 }
3504
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003505 ret = ssl_check_dtls_clihlo_cookie(
3506 ssl->conf->f_cookie_write,
3507 ssl->conf->f_cookie_check,
3508 ssl->conf->p_cookie,
3509 ssl->cli_id, ssl->cli_id_len,
3510 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003511 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003512
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003513 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3514
3515 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003516 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003517 int send_ret;
3518 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3519 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3520 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003521 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003522 * If the error is permanent we'll catch it later,
3523 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003524 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3525 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3526 (void) send_ret;
3527
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003528 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003529 }
3530
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003531 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003532 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003534 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003535 {
3536 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3537 return( ret );
3538 }
3539
3540 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003541 }
3542
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003543 return( ret );
3544}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003545#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003546
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003547static int ssl_check_record_type( uint8_t record_type )
3548{
3549 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3550 record_type != MBEDTLS_SSL_MSG_ALERT &&
3551 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3552 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3553 {
3554 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3555 }
3556
3557 return( 0 );
3558}
3559
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003560/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003561 * ContentType type;
3562 * ProtocolVersion version;
3563 * uint16 epoch; // DTLS only
3564 * uint48 sequence_number; // DTLS only
3565 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003566 *
3567 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003568 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003569 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3570 *
3571 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003572 * 1. proceed with the record if this function returns 0
3573 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3574 * 3. return CLIENT_RECONNECT if this function return that value
3575 * 4. drop the whole datagram if this function returns anything else.
3576 * Point 2 is needed when the peer is resending, and we have already received
3577 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003578 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003579static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580 unsigned char *buf,
3581 size_t len,
3582 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003583{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003584 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003585
Hanno Beckere5e7e782019-07-11 12:29:35 +01003586 size_t const rec_hdr_type_offset = 0;
3587 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003588
Hanno Beckere5e7e782019-07-11 12:29:35 +01003589 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3590 rec_hdr_type_len;
3591 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003592
Hanno Beckere5e7e782019-07-11 12:29:35 +01003593 size_t const rec_hdr_ctr_len = 8;
3594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003595 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3597 rec_hdr_version_len;
3598
Hanno Beckera0e20d02019-05-15 14:03:01 +01003599#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003600 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3601 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003602 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003603#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3604#endif /* MBEDTLS_SSL_PROTO_DTLS */
3605
3606 size_t rec_hdr_len_offset; /* To be determined */
3607 size_t const rec_hdr_len_len = 2;
3608
3609 /*
3610 * Check minimum lengths for record header.
3611 */
3612
3613#if defined(MBEDTLS_SSL_PROTO_DTLS)
3614 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3615 {
3616 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3617 }
3618 else
3619#endif /* MBEDTLS_SSL_PROTO_DTLS */
3620 {
3621 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3622 }
3623
3624 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3625 {
3626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3627 (unsigned) len,
3628 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3629 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3630 }
3631
3632 /*
3633 * Parse and validate record content type
3634 */
3635
3636 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003637
3638 /* Check record content type */
3639#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3640 rec->cid_len = 0;
3641
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003642 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003643 ssl->conf->cid_len != 0 &&
3644 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003645 {
3646 /* Shift pointers to account for record header including CID
3647 * struct {
3648 * ContentType special_type = tls12_cid;
3649 * ProtocolVersion version;
3650 * uint16 epoch;
3651 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003652 * opaque cid[cid_length]; // Additional field compared to
3653 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003654 * uint16 length;
3655 * opaque enc_content[DTLSCiphertext.length];
3656 * } DTLSCiphertext;
3657 */
3658
3659 /* So far, we only support static CID lengths
3660 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003661 rec_hdr_cid_len = ssl->conf->cid_len;
3662 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003663
Hanno Beckere5e7e782019-07-11 12:29:35 +01003664 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003665 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3667 (unsigned) len,
3668 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003669 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003670 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003671
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003672 /* configured CID len is guaranteed at most 255, see
3673 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3674 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003675 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003676 }
3677 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003678#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003679 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003680 if( ssl_check_record_type( rec->type ) )
3681 {
Hanno Becker54229812019-07-12 14:40:00 +01003682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3683 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003684 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3685 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003686 }
3687
Hanno Beckere5e7e782019-07-11 12:29:35 +01003688 /*
3689 * Parse and validate record version
3690 */
3691
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003692 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3693 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003694 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3695 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003696 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003697
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003698 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003700 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003702 }
3703
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003704 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003706 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3707 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003708 }
3709
Hanno Beckere5e7e782019-07-11 12:29:35 +01003710 /*
3711 * Parse/Copy record sequence number.
3712 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003713
Hanno Beckere5e7e782019-07-11 12:29:35 +01003714#if defined(MBEDTLS_SSL_PROTO_DTLS)
3715 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003716 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003717 /* Copy explicit record sequence number from input buffer. */
3718 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3719 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003720 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003721 else
3722#endif /* MBEDTLS_SSL_PROTO_DTLS */
3723 {
3724 /* Copy implicit record sequence number from SSL context structure. */
3725 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3726 }
Paul Bakker40e46942009-01-03 21:51:57 +00003727
Hanno Beckere5e7e782019-07-11 12:29:35 +01003728 /*
3729 * Parse record length.
3730 */
3731
Hanno Beckere5e7e782019-07-11 12:29:35 +01003732 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003733 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3734 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003735 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003736
Paul Elliott9f352112020-12-09 14:55:45 +00003737 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003738 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003739 rec->type,
3740 major_ver, minor_ver, rec->data_len ) );
3741
3742 rec->buf = buf;
3743 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003744
Hanno Beckerd417cc92019-07-26 08:20:27 +01003745 if( rec->data_len == 0 )
3746 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003747
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003748 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003749 * DTLS-related tests.
3750 * Check epoch before checking length constraint because
3751 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3752 * message gets duplicated before the corresponding Finished message,
3753 * the second ChangeCipherSpec should be discarded because it belongs
3754 * to an old epoch, but not because its length is shorter than
3755 * the minimum record length for packets using the new record transform.
3756 * Note that these two kinds of failures are handled differently,
3757 * as an unexpected record is silently skipped but an invalid
3758 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003759 */
3760#if defined(MBEDTLS_SSL_PROTO_DTLS)
3761 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3762 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003763 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003764
Hanno Becker955a5c92019-07-10 17:12:07 +01003765 /* Check that the datagram is large enough to contain a record
3766 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003767 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003768 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3770 (unsigned) len,
3771 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003772 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3773 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003774
Hanno Becker37cfe732019-07-10 17:20:01 +01003775 /* Records from other, non-matching epochs are silently discarded.
3776 * (The case of same-port Client reconnects must be considered in
3777 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003778 if( rec_epoch != ssl->in_epoch )
3779 {
3780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003781 "expected %u, received %lu",
3782 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003783
Hanno Becker552f7472019-07-19 10:59:12 +01003784 /* Records from the next epoch are considered for buffering
3785 * (concretely: early Finished messages). */
3786 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003787 {
Hanno Becker552f7472019-07-19 10:59:12 +01003788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3789 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003790 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003791
Hanno Becker2fddd372019-07-10 14:37:41 +01003792 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003793 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003794#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003795 /* For records from the correct epoch, check whether their
3796 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003797 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3798 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003799 {
3800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3801 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3802 }
3803#endif
3804 }
3805#endif /* MBEDTLS_SSL_PROTO_DTLS */
3806
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003807 return( 0 );
3808}
Paul Bakker5121ce52009-01-03 21:22:43 +00003809
Paul Bakker5121ce52009-01-03 21:22:43 +00003810
Hanno Becker2fddd372019-07-10 14:37:41 +01003811#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3812static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3813{
3814 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3815
3816 /*
3817 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3818 * access the first byte of record content (handshake type), as we
3819 * have an active transform (possibly iv_len != 0), so use the
3820 * fact that the record header len is 13 instead.
3821 */
3822 if( rec_epoch == 0 &&
3823 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3824 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3825 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3826 ssl->in_left > 13 &&
3827 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3828 {
3829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3830 "from the same port" ) );
3831 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003832 }
3833
3834 return( 0 );
3835}
Hanno Becker2fddd372019-07-10 14:37:41 +01003836#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003837
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003838/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003839 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003840 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003841static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3842 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003843{
3844 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003846 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003847 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3850 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003851 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003853
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003854 ret = mbedtls_ssl_hw_record_read( ssl );
3855 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003856 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003857 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3858 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003859 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003860
3861 if( ret == 0 )
3862 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003863 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003865 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003866 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003867 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003868
Hanno Beckera18d1322018-01-03 14:27:32 +00003869 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003870 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003872 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003873
Hanno Beckera0e20d02019-05-15 14:03:01 +01003874#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003875 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3876 ssl->conf->ignore_unexpected_cid
3877 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3878 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003879 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003880 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003881 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003882#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003883
Paul Bakker5121ce52009-01-03 21:22:43 +00003884 return( ret );
3885 }
3886
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003887 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003888 {
3889 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003890 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003891 }
3892
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003893 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003894 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003895
Hanno Beckera0e20d02019-05-15 14:03:01 +01003896#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003897 /* We have already checked the record content type
3898 * in ssl_parse_record_header(), failing or silently
3899 * dropping the record in the case of an unknown type.
3900 *
3901 * Since with the use of CIDs, the record content type
3902 * might change during decryption, re-check the record
3903 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003904 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003905 {
3906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3907 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3908 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003909#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003910
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003911 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003912 {
3913#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3914 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003915 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003916 {
3917 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3919 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3920 }
3921#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3922
3923 ssl->nb_zero++;
3924
3925 /*
3926 * Three or more empty messages may be a DoS attack
3927 * (excessive CPU consumption).
3928 */
3929 if( ssl->nb_zero > 3 )
3930 {
3931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003932 "messages, possible DoS attack" ) );
3933 /* Treat the records as if they were not properly authenticated,
3934 * thereby failing the connection if we see more than allowed
3935 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003936 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3937 }
3938 }
3939 else
3940 ssl->nb_zero = 0;
3941
3942#if defined(MBEDTLS_SSL_PROTO_DTLS)
3943 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3944 {
3945 ; /* in_ctr read from peer, not maintained internally */
3946 }
3947 else
3948#endif
3949 {
3950 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003951 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003952 if( ++ssl->in_ctr[i - 1] != 0 )
3953 break;
3954
3955 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003956 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003957 {
3958 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3959 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3960 }
3961 }
3962
Paul Bakker5121ce52009-01-03 21:22:43 +00003963 }
3964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003966 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003967 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003968 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003969 }
3970#endif
3971
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003972 /* Check actual (decrypted) record content length against
3973 * configured maximum. */
3974 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3975 {
3976 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3977 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3978 }
3979
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003980 return( 0 );
3981}
3982
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003983/*
3984 * Read a record.
3985 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003986 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3987 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3988 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003989 */
Hanno Becker1097b342018-08-15 14:09:41 +01003990
3991/* Helper functions for mbedtls_ssl_read_record(). */
3992static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003993static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3994static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003995
Hanno Becker327c93b2018-08-15 13:56:18 +01003996int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003997 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003998{
Janos Follath865b3eb2019-12-16 11:46:15 +00003999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004002
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004003 if( ssl->keep_current_message == 0 )
4004 {
4005 do {
Simon Butcher99000142016-10-13 17:21:01 +01004006
Hanno Becker26994592018-08-15 14:14:59 +01004007 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01004008 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004009 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01004010
Hanno Beckere74d5562018-08-15 14:26:08 +01004011 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004012 {
Hanno Becker40f50842018-08-15 14:48:01 +01004013#if defined(MBEDTLS_SSL_PROTO_DTLS)
4014 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004015
Hanno Becker40f50842018-08-15 14:48:01 +01004016 /* We only check for buffered messages if the
4017 * current datagram is fully consumed. */
4018 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004019 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004020 {
Hanno Becker40f50842018-08-15 14:48:01 +01004021 if( ssl_load_buffered_message( ssl ) == 0 )
4022 have_buffered = 1;
4023 }
4024
4025 if( have_buffered == 0 )
4026#endif /* MBEDTLS_SSL_PROTO_DTLS */
4027 {
4028 ret = ssl_get_next_record( ssl );
4029 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
4030 continue;
4031
4032 if( ret != 0 )
4033 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01004034 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004035 return( ret );
4036 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004037 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004038 }
4039
4040 ret = mbedtls_ssl_handle_message_type( ssl );
4041
Hanno Becker40f50842018-08-15 14:48:01 +01004042#if defined(MBEDTLS_SSL_PROTO_DTLS)
4043 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4044 {
4045 /* Buffer future message */
4046 ret = ssl_buffer_message( ssl );
4047 if( ret != 0 )
4048 return( ret );
4049
4050 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4051 }
4052#endif /* MBEDTLS_SSL_PROTO_DTLS */
4053
Hanno Becker90333da2017-10-10 11:27:13 +01004054 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4055 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004056
4057 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004058 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004059 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004060 return( ret );
4061 }
4062
Hanno Becker327c93b2018-08-15 13:56:18 +01004063 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004064 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004065 {
4066 mbedtls_ssl_update_handshake_status( ssl );
4067 }
Simon Butcher99000142016-10-13 17:21:01 +01004068 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004069 else
Simon Butcher99000142016-10-13 17:21:01 +01004070 {
Hanno Becker02f59072018-08-15 14:00:24 +01004071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004072 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004073 }
4074
4075 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4076
4077 return( 0 );
4078}
4079
Hanno Becker40f50842018-08-15 14:48:01 +01004080#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004081static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004082{
Hanno Becker40f50842018-08-15 14:48:01 +01004083 if( ssl->in_left > ssl->next_record_offset )
4084 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004085
Hanno Becker40f50842018-08-15 14:48:01 +01004086 return( 0 );
4087}
4088
4089static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4090{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004091 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004092 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004093 int ret = 0;
4094
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004095 if( hs == NULL )
4096 return( -1 );
4097
Hanno Beckere00ae372018-08-20 09:39:42 +01004098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4099
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004100 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4101 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4102 {
4103 /* Check if we have seen a ChangeCipherSpec before.
4104 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004105 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004106 {
4107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4108 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004109 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004110 }
4111
Hanno Becker39b8bc92018-08-28 17:17:13 +01004112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004113 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4114 ssl->in_msglen = 1;
4115 ssl->in_msg[0] = 1;
4116
4117 /* As long as they are equal, the exact value doesn't matter. */
4118 ssl->in_left = 0;
4119 ssl->next_record_offset = 0;
4120
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004121 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004122 goto exit;
4123 }
Hanno Becker37f95322018-08-16 13:55:32 +01004124
Hanno Beckerb8f50142018-08-28 10:01:34 +01004125#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004126 /* Debug only */
4127 {
4128 unsigned offset;
4129 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4130 {
4131 hs_buf = &hs->buffering.hs[offset];
4132 if( hs_buf->is_valid == 1 )
4133 {
4134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4135 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004136 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004137 }
4138 }
4139 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004140#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004141
4142 /* Check if we have buffered and/or fully reassembled the
4143 * next handshake message. */
4144 hs_buf = &hs->buffering.hs[0];
4145 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4146 {
4147 /* Synthesize a record containing the buffered HS message. */
4148 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4149 ( hs_buf->data[2] << 8 ) |
4150 hs_buf->data[3];
4151
4152 /* Double-check that we haven't accidentally buffered
4153 * a message that doesn't fit into the input buffer. */
4154 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4155 {
4156 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4157 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4158 }
4159
4160 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4161 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4162 hs_buf->data, msg_len + 12 );
4163
4164 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4165 ssl->in_hslen = msg_len + 12;
4166 ssl->in_msglen = msg_len + 12;
4167 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4168
4169 ret = 0;
4170 goto exit;
4171 }
4172 else
4173 {
4174 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4175 hs->in_msg_seq ) );
4176 }
4177
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004178 ret = -1;
4179
4180exit:
4181
4182 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4183 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004184}
4185
Hanno Beckera02b0b42018-08-21 17:20:27 +01004186static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4187 size_t desired )
4188{
4189 int offset;
4190 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4192 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004193
Hanno Becker01315ea2018-08-21 17:22:17 +01004194 /* Get rid of future records epoch first, if such exist. */
4195 ssl_free_buffered_record( ssl );
4196
4197 /* Check if we have enough space available now. */
4198 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4199 hs->buffering.total_bytes_buffered ) )
4200 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004202 return( 0 );
4203 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004204
Hanno Becker4f432ad2018-08-28 10:02:32 +01004205 /* We don't have enough space to buffer the next expected handshake
4206 * message. Remove buffers used for future messages to gain space,
4207 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004208 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4209 offset >= 0; offset-- )
4210 {
4211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4212 offset ) );
4213
Hanno Beckerb309b922018-08-23 13:18:05 +01004214 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004215
4216 /* Check if we have enough space available now. */
4217 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4218 hs->buffering.total_bytes_buffered ) )
4219 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004220 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004221 return( 0 );
4222 }
4223 }
4224
4225 return( -1 );
4226}
4227
Hanno Becker40f50842018-08-15 14:48:01 +01004228static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4229{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004230 int ret = 0;
4231 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4232
4233 if( hs == NULL )
4234 return( 0 );
4235
4236 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4237
4238 switch( ssl->in_msgtype )
4239 {
4240 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004242
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004243 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004244 break;
4245
4246 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004247 {
4248 unsigned recv_msg_seq_offset;
4249 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4250 mbedtls_ssl_hs_buffer *hs_buf;
4251 size_t msg_len = ssl->in_hslen - 12;
4252
4253 /* We should never receive an old handshake
4254 * message - double-check nonetheless. */
4255 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4256 {
4257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4258 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4259 }
4260
4261 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4262 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4263 {
4264 /* Silently ignore -- message too far in the future */
4265 MBEDTLS_SSL_DEBUG_MSG( 2,
4266 ( "Ignore future HS message with sequence number %u, "
4267 "buffering window %u - %u",
4268 recv_msg_seq, ssl->handshake->in_msg_seq,
4269 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4270
4271 goto exit;
4272 }
4273
4274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4275 recv_msg_seq, recv_msg_seq_offset ) );
4276
4277 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4278
4279 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004280 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004281 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004282 size_t reassembly_buf_sz;
4283
Hanno Becker37f95322018-08-16 13:55:32 +01004284 hs_buf->is_fragmented =
4285 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4286
4287 /* We copy the message back into the input buffer
4288 * after reassembly, so check that it's not too large.
4289 * This is an implementation-specific limitation
4290 * and not one from the standard, hence it is not
4291 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004292 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004293 {
4294 /* Ignore message */
4295 goto exit;
4296 }
4297
Hanno Beckere0b150f2018-08-21 15:51:03 +01004298 /* Check if we have enough space to buffer the message. */
4299 if( hs->buffering.total_bytes_buffered >
4300 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4301 {
4302 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4303 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4304 }
4305
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004306 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4307 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004308
4309 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4310 hs->buffering.total_bytes_buffered ) )
4311 {
4312 if( recv_msg_seq_offset > 0 )
4313 {
4314 /* If we can't buffer a future message because
4315 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4317 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4318 " (already %" MBEDTLS_PRINTF_SIZET
4319 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004320 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004321 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004322 goto exit;
4323 }
Hanno Beckere1801392018-08-21 16:51:05 +01004324 else
4325 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004326 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4327 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4328 " (already %" MBEDTLS_PRINTF_SIZET
4329 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004330 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004331 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004332 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004333
Hanno Beckera02b0b42018-08-21 17:20:27 +01004334 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004335 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004336 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4337 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4338 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4339 " (already %" MBEDTLS_PRINTF_SIZET
4340 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004341 msg_len,
4342 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004343 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004344 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004345 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4346 goto exit;
4347 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004348 }
4349
Paul Elliottd48d5c62021-01-07 14:47:05 +00004350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004351 msg_len ) );
4352
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004353 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4354 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004355 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004356 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004357 goto exit;
4358 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004359 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004360
4361 /* Prepare final header: copy msg_type, length and message_seq,
4362 * then add standardised fragment_offset and fragment_length */
4363 memcpy( hs_buf->data, ssl->in_msg, 6 );
4364 memset( hs_buf->data + 6, 0, 3 );
4365 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4366
4367 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004368
4369 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004370 }
4371 else
4372 {
4373 /* Make sure msg_type and length are consistent */
4374 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4375 {
4376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4377 /* Ignore */
4378 goto exit;
4379 }
4380 }
4381
Hanno Becker4422bbb2018-08-20 09:40:19 +01004382 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004383 {
4384 size_t frag_len, frag_off;
4385 unsigned char * const msg = hs_buf->data + 12;
4386
4387 /*
4388 * Check and copy current fragment
4389 */
4390
4391 /* Validation of header fields already done in
4392 * mbedtls_ssl_prepare_handshake_record(). */
4393 frag_off = ssl_get_hs_frag_off( ssl );
4394 frag_len = ssl_get_hs_frag_len( ssl );
4395
Paul Elliottd48d5c62021-01-07 14:47:05 +00004396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4397 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004398 frag_off, frag_len ) );
4399 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4400
4401 if( hs_buf->is_fragmented )
4402 {
4403 unsigned char * const bitmask = msg + msg_len;
4404 ssl_bitmask_set( bitmask, frag_off, frag_len );
4405 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4406 msg_len ) == 0 );
4407 }
4408 else
4409 {
4410 hs_buf->is_complete = 1;
4411 }
4412
4413 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4414 hs_buf->is_complete ? "" : "not yet " ) );
4415 }
4416
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004417 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004418 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004419
4420 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004421 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004422 break;
4423 }
4424
4425exit:
4426
4427 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4428 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004429}
4430#endif /* MBEDTLS_SSL_PROTO_DTLS */
4431
Hanno Becker1097b342018-08-15 14:09:41 +01004432static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004433{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004434 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004435 * Consume last content-layer message and potentially
4436 * update in_msglen which keeps track of the contents'
4437 * consumption state.
4438 *
4439 * (1) Handshake messages:
4440 * Remove last handshake message, move content
4441 * and adapt in_msglen.
4442 *
4443 * (2) Alert messages:
4444 * Consume whole record content, in_msglen = 0.
4445 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004446 * (3) Change cipher spec:
4447 * Consume whole record content, in_msglen = 0.
4448 *
4449 * (4) Application data:
4450 * Don't do anything - the record layer provides
4451 * the application data as a stream transport
4452 * and consumes through mbedtls_ssl_read only.
4453 *
4454 */
4455
4456 /* Case (1): Handshake messages */
4457 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004458 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004459 /* Hard assertion to be sure that no application data
4460 * is in flight, as corrupting ssl->in_msglen during
4461 * ssl->in_offt != NULL is fatal. */
4462 if( ssl->in_offt != NULL )
4463 {
4464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4465 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4466 }
4467
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004468 /*
4469 * Get next Handshake message in the current record
4470 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004471
Hanno Becker4a810fb2017-05-24 16:27:30 +01004472 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004473 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004474 * current handshake content: If DTLS handshake
4475 * fragmentation is used, that's the fragment
4476 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004477 * size here is faulty and should be changed at
4478 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004479 * (2) While it doesn't seem to cause problems, one
4480 * has to be very careful not to assume that in_hslen
4481 * is always <= in_msglen in a sensible communication.
4482 * Again, it's wrong for DTLS handshake fragmentation.
4483 * The following check is therefore mandatory, and
4484 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004485 * Additionally, ssl->in_hslen might be arbitrarily out of
4486 * bounds after handling a DTLS message with an unexpected
4487 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004488 */
4489 if( ssl->in_hslen < ssl->in_msglen )
4490 {
4491 ssl->in_msglen -= ssl->in_hslen;
4492 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4493 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004494
Hanno Becker4a810fb2017-05-24 16:27:30 +01004495 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4496 ssl->in_msg, ssl->in_msglen );
4497 }
4498 else
4499 {
4500 ssl->in_msglen = 0;
4501 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004502
Hanno Becker4a810fb2017-05-24 16:27:30 +01004503 ssl->in_hslen = 0;
4504 }
4505 /* Case (4): Application data */
4506 else if( ssl->in_offt != NULL )
4507 {
4508 return( 0 );
4509 }
4510 /* Everything else (CCS & Alerts) */
4511 else
4512 {
4513 ssl->in_msglen = 0;
4514 }
4515
Hanno Becker1097b342018-08-15 14:09:41 +01004516 return( 0 );
4517}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004518
Hanno Beckere74d5562018-08-15 14:26:08 +01004519static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4520{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004521 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004522 return( 1 );
4523
4524 return( 0 );
4525}
4526
Hanno Becker5f066e72018-08-16 14:56:31 +01004527#if defined(MBEDTLS_SSL_PROTO_DTLS)
4528
4529static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4530{
4531 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4532 if( hs == NULL )
4533 return;
4534
Hanno Becker01315ea2018-08-21 17:22:17 +01004535 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004536 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004537 hs->buffering.total_bytes_buffered -=
4538 hs->buffering.future_record.len;
4539
4540 mbedtls_free( hs->buffering.future_record.data );
4541 hs->buffering.future_record.data = NULL;
4542 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004543}
4544
4545static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4546{
4547 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4548 unsigned char * rec;
4549 size_t rec_len;
4550 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004551#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4552 size_t in_buf_len = ssl->in_buf_len;
4553#else
4554 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4555#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004556 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4557 return( 0 );
4558
4559 if( hs == NULL )
4560 return( 0 );
4561
Hanno Becker5f066e72018-08-16 14:56:31 +01004562 rec = hs->buffering.future_record.data;
4563 rec_len = hs->buffering.future_record.len;
4564 rec_epoch = hs->buffering.future_record.epoch;
4565
4566 if( rec == NULL )
4567 return( 0 );
4568
Hanno Becker4cb782d2018-08-20 11:19:05 +01004569 /* Only consider loading future records if the
4570 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004571 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004572 return( 0 );
4573
Hanno Becker5f066e72018-08-16 14:56:31 +01004574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4575
4576 if( rec_epoch != ssl->in_epoch )
4577 {
4578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4579 goto exit;
4580 }
4581
4582 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4583
4584 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004585 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004586 {
4587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4588 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4589 }
4590
4591 memcpy( ssl->in_hdr, rec, rec_len );
4592 ssl->in_left = rec_len;
4593 ssl->next_record_offset = 0;
4594
4595 ssl_free_buffered_record( ssl );
4596
4597exit:
4598 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4599 return( 0 );
4600}
4601
Hanno Becker519f15d2019-07-11 12:43:20 +01004602static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4603 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004604{
4605 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004606
4607 /* Don't buffer future records outside handshakes. */
4608 if( hs == NULL )
4609 return( 0 );
4610
4611 /* Only buffer handshake records (we are only interested
4612 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004613 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004614 return( 0 );
4615
4616 /* Don't buffer more than one future epoch record. */
4617 if( hs->buffering.future_record.data != NULL )
4618 return( 0 );
4619
Hanno Becker01315ea2018-08-21 17:22:17 +01004620 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004621 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004622 hs->buffering.total_bytes_buffered ) )
4623 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4625 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4626 " (already %" MBEDTLS_PRINTF_SIZET
4627 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004628 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004629 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004630 return( 0 );
4631 }
4632
Hanno Becker5f066e72018-08-16 14:56:31 +01004633 /* Buffer record */
4634 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004635 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004636 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004637
4638 /* ssl_parse_record_header() only considers records
4639 * of the next epoch as candidates for buffering. */
4640 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004641 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004642
4643 hs->buffering.future_record.data =
4644 mbedtls_calloc( 1, hs->buffering.future_record.len );
4645 if( hs->buffering.future_record.data == NULL )
4646 {
4647 /* If we run out of RAM trying to buffer a
4648 * record from the next epoch, just ignore. */
4649 return( 0 );
4650 }
4651
Hanno Becker519f15d2019-07-11 12:43:20 +01004652 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004653
Hanno Becker519f15d2019-07-11 12:43:20 +01004654 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004655 return( 0 );
4656}
4657
4658#endif /* MBEDTLS_SSL_PROTO_DTLS */
4659
Hanno Beckere74d5562018-08-15 14:26:08 +01004660static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004661{
Janos Follath865b3eb2019-12-16 11:46:15 +00004662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004663 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004664
Hanno Becker5f066e72018-08-16 14:56:31 +01004665#if defined(MBEDTLS_SSL_PROTO_DTLS)
4666 /* We might have buffered a future record; if so,
4667 * and if the epoch matches now, load it.
4668 * On success, this call will set ssl->in_left to
4669 * the length of the buffered record, so that
4670 * the calls to ssl_fetch_input() below will
4671 * essentially be no-ops. */
4672 ret = ssl_load_buffered_record( ssl );
4673 if( ret != 0 )
4674 return( ret );
4675#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004676
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004677 /* Ensure that we have enough space available for the default form
4678 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4679 * with no space for CIDs counted in). */
4680 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4681 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004682 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004683 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004684 return( ret );
4685 }
4686
Hanno Beckere5e7e782019-07-11 12:29:35 +01004687 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4688 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004689 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004691 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004692 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004693 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4694 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004695 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004696 if( ret != 0 )
4697 return( ret );
4698
4699 /* Fall through to handling of unexpected records */
4700 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4701 }
4702
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004703 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4704 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004705#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004706 /* Reset in pointers to default state for TLS/DTLS records,
4707 * assuming no CID and no offset between record content and
4708 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004709 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004710
Hanno Becker7ae20e02019-07-12 08:33:49 +01004711 /* Setup internal message pointers from record structure. */
4712 ssl->in_msgtype = rec.type;
4713#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4714 ssl->in_len = ssl->in_cid + rec.cid_len;
4715#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4716 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4717 ssl->in_msglen = rec.data_len;
4718
Hanno Becker2fddd372019-07-10 14:37:41 +01004719 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004720 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004721 if( ret != 0 )
4722 return( ret );
4723#endif
4724
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004725 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004726 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004727
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4729 "(header)" ) );
4730 }
4731 else
4732 {
4733 /* Skip invalid record and the rest of the datagram */
4734 ssl->next_record_offset = 0;
4735 ssl->in_left = 0;
4736
4737 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4738 "(header)" ) );
4739 }
4740
4741 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004742 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004743 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004744 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004745#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004746 {
4747 return( ret );
4748 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004749 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004751#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004752 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004753 {
Hanno Beckera8814792019-07-10 15:01:45 +01004754 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004755 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004756 if( ssl->next_record_offset < ssl->in_left )
4757 {
4758 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4759 }
4760 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004761 else
4762#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004763 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004764 /*
4765 * Fetch record contents from underlying transport.
4766 */
Hanno Beckera3175662019-07-11 12:50:29 +01004767 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004768 if( ret != 0 )
4769 {
4770 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4771 return( ret );
4772 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004773
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004774 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004775 }
4776
4777 /*
4778 * Decrypt record contents.
4779 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004780
Hanno Beckerfdf66042019-07-11 13:07:45 +01004781 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004782 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004783#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004784 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004785 {
4786 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004787 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004788 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004789 /* Except when waiting for Finished as a bad mac here
4790 * probably means something went wrong in the handshake
4791 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4792 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4793 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4794 {
4795#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4796 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4797 {
4798 mbedtls_ssl_send_alert_message( ssl,
4799 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4800 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4801 }
4802#endif
4803 return( ret );
4804 }
4805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004807 if( ssl->conf->badmac_limit != 0 &&
4808 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4811 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004812 }
4813#endif
4814
Hanno Becker4a810fb2017-05-24 16:27:30 +01004815 /* As above, invalid records cause
4816 * dismissal of the whole datagram. */
4817
4818 ssl->next_record_offset = 0;
4819 ssl->in_left = 0;
4820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004822 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004823 }
4824
4825 return( ret );
4826 }
4827 else
4828#endif
4829 {
4830 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4832 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004834 mbedtls_ssl_send_alert_message( ssl,
4835 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4836 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004837 }
4838#endif
4839 return( ret );
4840 }
4841 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004842
Hanno Becker44d89b22019-07-12 09:40:44 +01004843
4844 /* Reset in pointers to default state for TLS/DTLS records,
4845 * assuming no CID and no offset between record content and
4846 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004847 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004848#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4849 ssl->in_len = ssl->in_cid + rec.cid_len;
4850#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004851 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004852
Hanno Becker8685c822019-07-12 09:37:30 +01004853 /* The record content type may change during decryption,
4854 * so re-read it. */
4855 ssl->in_msgtype = rec.type;
4856 /* Also update the input buffer, because unfortunately
4857 * the server-side ssl_parse_client_hello() reparses the
4858 * record header when receiving a ClientHello initiating
4859 * a renegotiation. */
4860 ssl->in_hdr[0] = rec.type;
4861 ssl->in_msg = rec.buf + rec.data_offset;
4862 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004863 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004864
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004865#if defined(MBEDTLS_ZLIB_SUPPORT)
4866 if( ssl->transform_in != NULL &&
4867 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4868 {
4869 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4870 {
4871 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4872 return( ret );
4873 }
4874
4875 /* Check actual (decompress) record content length against
4876 * configured maximum. */
4877 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4878 {
4879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4880 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4881 }
4882 }
4883#endif /* MBEDTLS_ZLIB_SUPPORT */
4884
Simon Butcher99000142016-10-13 17:21:01 +01004885 return( 0 );
4886}
4887
4888int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4889{
Janos Follath865b3eb2019-12-16 11:46:15 +00004890 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004891
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004892 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004893 * Handle particular types of records
4894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004896 {
Simon Butcher99000142016-10-13 17:21:01 +01004897 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4898 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004899 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004900 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004901 }
4902
Hanno Beckere678eaa2018-08-21 14:57:46 +01004903 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004904 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004905 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004906 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004907 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004908 ssl->in_msglen ) );
4909 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004910 }
4911
Hanno Beckere678eaa2018-08-21 14:57:46 +01004912 if( ssl->in_msg[0] != 1 )
4913 {
4914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4915 ssl->in_msg[0] ) );
4916 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4917 }
4918
4919#if defined(MBEDTLS_SSL_PROTO_DTLS)
4920 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4921 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4922 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4923 {
4924 if( ssl->handshake == NULL )
4925 {
4926 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4927 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4928 }
4929
4930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4931 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4932 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004933#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004934 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004936 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004937 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004938 if( ssl->in_msglen != 2 )
4939 {
4940 /* Note: Standard allows for more than one 2 byte alert
4941 to be packed in a single message, but Mbed TLS doesn't
4942 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004944 ssl->in_msglen ) );
4945 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4946 }
4947
Paul Elliott9f352112020-12-09 14:55:45 +00004948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004949 ssl->in_msg[0], ssl->in_msg[1] ) );
4950
4951 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004952 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004954 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004955 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004956 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004957 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004958 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004959 }
4960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004961 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4962 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4965 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004966 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004967
4968#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4969 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4970 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4971 {
Hanno Becker90333da2017-10-10 11:27:13 +01004972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004973 /* Will be handled when trying to parse ServerHello */
4974 return( 0 );
4975 }
4976#endif
4977
4978#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4979 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4980 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4981 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4982 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4983 {
4984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4985 /* Will be handled in mbedtls_ssl_parse_certificate() */
4986 return( 0 );
4987 }
4988#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4989
4990 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004991 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004992 }
4993
Hanno Beckerc76c6192017-06-06 10:03:17 +01004994#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004995 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004996 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004997 /* Drop unexpected ApplicationData records,
4998 * except at the beginning of renegotiations */
4999 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5000 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
5001#if defined(MBEDTLS_SSL_RENEGOTIATION)
5002 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5003 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01005004#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01005005 )
5006 {
5007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
5008 return( MBEDTLS_ERR_SSL_NON_FATAL );
5009 }
5010
5011 if( ssl->handshake != NULL &&
5012 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
5013 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005014 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01005015 }
5016 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005017#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005018
Paul Bakker5121ce52009-01-03 21:22:43 +00005019 return( 0 );
5020}
5021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005023{
irwir6c0da642019-09-26 21:07:41 +03005024 return( mbedtls_ssl_send_alert_message( ssl,
5025 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5026 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005027}
5028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005029int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00005030 unsigned char level,
5031 unsigned char message )
5032{
Janos Follath865b3eb2019-12-16 11:46:15 +00005033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005034
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005035 if( ssl == NULL || ssl->conf == NULL )
5036 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005039 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00005040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005041 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005042 ssl->out_msglen = 2;
5043 ssl->out_msg[0] = level;
5044 ssl->out_msg[1] = message;
5045
Hanno Becker67bc7c32018-08-06 11:33:50 +01005046 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005048 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005049 return( ret );
5050 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005052
5053 return( 0 );
5054}
5055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005056int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005057{
Janos Follath865b3eb2019-12-16 11:46:15 +00005058 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005062 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005063 ssl->out_msglen = 1;
5064 ssl->out_msg[0] = 1;
5065
Paul Bakker5121ce52009-01-03 21:22:43 +00005066 ssl->state++;
5067
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005068 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005069 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005070 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005071 return( ret );
5072 }
5073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005075
5076 return( 0 );
5077}
5078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005079int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005080{
Janos Follath865b3eb2019-12-16 11:46:15 +00005081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005084
Hanno Becker327c93b2018-08-15 13:56:18 +01005085 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005086 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005087 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005088 return( ret );
5089 }
5090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005091 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005092 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005093 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005094 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5095 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005096 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005097 }
5098
Hanno Beckere678eaa2018-08-21 14:57:46 +01005099 /* CCS records are only accepted if they have length 1 and content '1',
5100 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005101
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005102 /*
5103 * Switch to our negotiated transform and session parameters for inbound
5104 * data.
5105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005106 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005107 ssl->transform_in = ssl->transform_negotiate;
5108 ssl->session_in = ssl->session_negotiate;
5109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005111 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005112 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005113#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005114 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005115#endif
5116
5117 /* Increment epoch */
5118 if( ++ssl->in_epoch == 0 )
5119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005121 /* This is highly unlikely to happen for legitimate reasons, so
5122 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005123 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005124 }
5125 }
5126 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005128 memset( ssl->in_ctr, 0, 8 );
5129
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005130 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5133 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005134 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005135 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005138 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5139 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005140 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005141 }
5142 }
5143#endif
5144
Paul Bakker5121ce52009-01-03 21:22:43 +00005145 ssl->state++;
5146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005148
5149 return( 0 );
5150}
5151
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005152/* Once ssl->out_hdr as the address of the beginning of the
5153 * next outgoing record is set, deduce the other pointers.
5154 *
5155 * Note: For TLS, we save the implicit record sequence number
5156 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5157 * and the caller has to make sure there's space for this.
5158 */
5159
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005160static size_t ssl_transform_get_explicit_iv_len(
5161 mbedtls_ssl_transform const *transform )
5162{
5163 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5164 return( 0 );
5165
5166 return( transform->ivlen - transform->fixed_ivlen );
5167}
5168
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005169void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5170 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005171{
5172#if defined(MBEDTLS_SSL_PROTO_DTLS)
5173 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5174 {
5175 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005176#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005177 ssl->out_cid = ssl->out_ctr + 8;
5178 ssl->out_len = ssl->out_cid;
5179 if( transform != NULL )
5180 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005181#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005182 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005183#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005184 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005185 }
5186 else
5187#endif
5188 {
5189 ssl->out_ctr = ssl->out_hdr - 8;
5190 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005191#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005192 ssl->out_cid = ssl->out_len;
5193#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005194 ssl->out_iv = ssl->out_hdr + 5;
5195 }
5196
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005197 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005198 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005199 if( transform != NULL )
5200 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005201}
5202
5203/* Once ssl->in_hdr as the address of the beginning of the
5204 * next incoming record is set, deduce the other pointers.
5205 *
5206 * Note: For TLS, we save the implicit record sequence number
5207 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5208 * and the caller has to make sure there's space for this.
5209 */
5210
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005211void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005212{
Hanno Becker79594fd2019-05-08 09:38:41 +01005213 /* This function sets the pointers to match the case
5214 * of unprotected TLS/DTLS records, with both ssl->in_iv
5215 * and ssl->in_msg pointing to the beginning of the record
5216 * content.
5217 *
5218 * When decrypting a protected record, ssl->in_msg
5219 * will be shifted to point to the beginning of the
5220 * record plaintext.
5221 */
5222
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005223#if defined(MBEDTLS_SSL_PROTO_DTLS)
5224 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5225 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005226 /* This sets the header pointers to match records
5227 * without CID. When we receive a record containing
5228 * a CID, the fields are shifted accordingly in
5229 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005230 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005231#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005232 ssl->in_cid = ssl->in_ctr + 8;
5233 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005234#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005235 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005236#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005237 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005238 }
5239 else
5240#endif
5241 {
5242 ssl->in_ctr = ssl->in_hdr - 8;
5243 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005244#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005245 ssl->in_cid = ssl->in_len;
5246#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005247 ssl->in_iv = ssl->in_hdr + 5;
5248 }
5249
Hanno Becker79594fd2019-05-08 09:38:41 +01005250 /* This will be adjusted at record decryption time. */
5251 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005252}
5253
Paul Bakker5121ce52009-01-03 21:22:43 +00005254/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005255 * Setup an SSL context
5256 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005257
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005258void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005259{
5260 /* Set the incoming and outgoing record pointers. */
5261#if defined(MBEDTLS_SSL_PROTO_DTLS)
5262 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5263 {
5264 ssl->out_hdr = ssl->out_buf;
5265 ssl->in_hdr = ssl->in_buf;
5266 }
5267 else
5268#endif /* MBEDTLS_SSL_PROTO_DTLS */
5269 {
5270 ssl->out_hdr = ssl->out_buf + 8;
5271 ssl->in_hdr = ssl->in_buf + 8;
5272 }
5273
5274 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005275 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5276 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005277}
5278
Paul Bakker5121ce52009-01-03 21:22:43 +00005279/*
5280 * SSL get accessors
5281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005282size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005283{
5284 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5285}
5286
Hanno Becker8b170a02017-10-10 11:51:19 +01005287int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5288{
5289 /*
5290 * Case A: We're currently holding back
5291 * a message for further processing.
5292 */
5293
5294 if( ssl->keep_current_message == 1 )
5295 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005296 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005297 return( 1 );
5298 }
5299
5300 /*
5301 * Case B: Further records are pending in the current datagram.
5302 */
5303
5304#if defined(MBEDTLS_SSL_PROTO_DTLS)
5305 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5306 ssl->in_left > ssl->next_record_offset )
5307 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005308 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005309 return( 1 );
5310 }
5311#endif /* MBEDTLS_SSL_PROTO_DTLS */
5312
5313 /*
5314 * Case C: A handshake message is being processed.
5315 */
5316
Hanno Becker8b170a02017-10-10 11:51:19 +01005317 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5318 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005319 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005320 return( 1 );
5321 }
5322
5323 /*
5324 * Case D: An application data message is being processed
5325 */
5326 if( ssl->in_offt != NULL )
5327 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005328 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005329 return( 1 );
5330 }
5331
5332 /*
5333 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005334 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005335 * we implement support for multiple alerts in single records.
5336 */
5337
5338 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5339 return( 0 );
5340}
5341
Paul Bakker43ca69c2011-01-15 17:35:19 +00005342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005344{
Hanno Becker3136ede2018-08-17 15:28:19 +01005345 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005347 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005348
Hanno Becker5903de42019-05-03 14:46:38 +01005349 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5350
Hanno Becker78640902018-08-13 16:35:15 +01005351 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005352 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354#if defined(MBEDTLS_ZLIB_SUPPORT)
5355 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5356 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005357#endif
5358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005359 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 case MBEDTLS_MODE_GCM:
5362 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005363 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005365 transform_expansion = transform->minlen;
5366 break;
5367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005368 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005369
5370 block_size = mbedtls_cipher_get_block_size(
5371 &transform->cipher_ctx_enc );
5372
Hanno Becker3136ede2018-08-17 15:28:19 +01005373 /* Expansion due to the addition of the MAC. */
5374 transform_expansion += transform->maclen;
5375
5376 /* Expansion due to the addition of CBC padding;
5377 * Theoretically up to 256 bytes, but we never use
5378 * more than the block size of the underlying cipher. */
5379 transform_expansion += block_size;
5380
5381 /* For TLS 1.1 or higher, an explicit IV is added
5382 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005383#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5384 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005385 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005386#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005387
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005388 break;
5389
5390 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005393 }
5394
Hanno Beckera0e20d02019-05-15 14:03:01 +01005395#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005396 if( transform->out_cid_len != 0 )
5397 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005398#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005399
Hanno Becker5903de42019-05-03 14:46:38 +01005400 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005401}
5402
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005404/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005405 * Check record counters and renegotiate if they're above the limit.
5406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005408{
Hanno Beckerdd772292020-02-05 10:38:31 +00005409 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005410 int in_ctr_cmp;
5411 int out_ctr_cmp;
5412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5414 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005415 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005416 {
5417 return( 0 );
5418 }
5419
Andres AG2196c7f2016-12-15 17:01:16 +00005420 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5421 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005422 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005423 ssl->conf->renego_period + ep_len, 8 - ep_len );
5424
5425 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005426 {
5427 return( 0 );
5428 }
5429
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005432}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005434
5435/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 * Receive application data decrypted from the SSL layer
5437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005439{
Janos Follath865b3eb2019-12-16 11:46:15 +00005440 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005441 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005442
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005443 if( ssl == NULL || ssl->conf == NULL )
5444 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005447
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005449 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005450 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005452 return( ret );
5453
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005454 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005456 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005457 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005458 return( ret );
5459 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005460 }
5461#endif
5462
Hanno Becker4a810fb2017-05-24 16:27:30 +01005463 /*
5464 * Check if renegotiation is necessary and/or handshake is
5465 * in process. If yes, perform/continue, and fall through
5466 * if an unexpected packet is received while the client
5467 * is waiting for the ServerHello.
5468 *
5469 * (There is no equivalent to the last condition on
5470 * the server-side as it is not treated as within
5471 * a handshake while waiting for the ClientHello
5472 * after a renegotiation request.)
5473 */
5474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005476 ret = ssl_check_ctr_renegotiate( ssl );
5477 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5478 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005479 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005481 return( ret );
5482 }
5483#endif
5484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005488 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5489 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005490 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005492 return( ret );
5493 }
5494 }
5495
Hanno Beckere41158b2017-10-23 13:30:32 +01005496 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005497 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005498 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005499 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005500 if( ssl->f_get_timer != NULL &&
5501 ssl->f_get_timer( ssl->p_timer ) == -1 )
5502 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005503 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005504 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005505
Hanno Becker327c93b2018-08-15 13:56:18 +01005506 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005507 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005508 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5509 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005510
Hanno Becker4a810fb2017-05-24 16:27:30 +01005511 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5512 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005513 }
5514
5515 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005517 {
5518 /*
5519 * OpenSSL sends empty messages to randomize the IV
5520 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005521 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005522 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005523 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005524 return( 0 );
5525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005527 return( ret );
5528 }
5529 }
5530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005531 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005534
Hanno Becker4a810fb2017-05-24 16:27:30 +01005535 /*
5536 * - For client-side, expect SERVER_HELLO_REQUEST.
5537 * - For server-side, expect CLIENT_HELLO.
5538 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5539 */
5540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005541#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005542 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005544 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005545 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005547
5548 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005550 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005551 {
5552 continue;
5553 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005554#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005555 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005556 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005557#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005558
Hanno Becker4a810fb2017-05-24 16:27:30 +01005559#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005560 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005561 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005564
5565 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005567 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005568 {
5569 continue;
5570 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005571#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005573 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005574#endif /* MBEDTLS_SSL_SRV_C */
5575
Hanno Becker21df7f92017-10-17 11:03:26 +01005576#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005577 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005578 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5579 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5580 ssl->conf->allow_legacy_renegotiation ==
5581 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5582 {
5583 /*
5584 * Accept renegotiation request
5585 */
Paul Bakker48916f92012-09-16 19:57:18 +00005586
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005587 /* DTLS clients need to know renego is server-initiated */
5588#if defined(MBEDTLS_SSL_PROTO_DTLS)
5589 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5590 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5591 {
5592 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5593 }
5594#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005595 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005596 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5597 ret != 0 )
5598 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005599 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5600 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005601 return( ret );
5602 }
5603 }
5604 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005605#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005606 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005607 /*
5608 * Refuse renegotiation
5609 */
5610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613#if defined(MBEDTLS_SSL_PROTO_SSL3)
5614 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005615 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005616 /* SSLv3 does not have a "no_renegotiation" warning, so
5617 we send a fatal alert and abort the connection. */
5618 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5619 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5620 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005621 }
5622 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005623#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5624#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5625 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5626 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005627 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005628 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5629 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5630 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005631 {
5632 return( ret );
5633 }
Paul Bakker48916f92012-09-16 19:57:18 +00005634 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005635 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005636#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5637 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005638 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005639 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5640 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005641 }
Paul Bakker48916f92012-09-16 19:57:18 +00005642 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005643
Hanno Becker90333da2017-10-10 11:27:13 +01005644 /* At this point, we don't know whether the renegotiation has been
5645 * completed or not. The cases to consider are the following:
5646 * 1) The renegotiation is complete. In this case, no new record
5647 * has been read yet.
5648 * 2) The renegotiation is incomplete because the client received
5649 * an application data record while awaiting the ServerHello.
5650 * 3) The renegotiation is incomplete because the client received
5651 * a non-handshake, non-application data message while awaiting
5652 * the ServerHello.
5653 * In each of these case, looping will be the proper action:
5654 * - For 1), the next iteration will read a new record and check
5655 * if it's application data.
5656 * - For 2), the loop condition isn't satisfied as application data
5657 * is present, hence continue is the same as break
5658 * - For 3), the loop condition is satisfied and read_record
5659 * will re-deliver the message that was held back by the client
5660 * when expecting the ServerHello.
5661 */
5662 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005663 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005664#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005665 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005666 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005667 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005668 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005669 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005670 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005672 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005674 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005675 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005676 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005677#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5680 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005683 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005684 }
5685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005686 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005688 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5689 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005690 }
5691
5692 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005693
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005694 /* We're going to return something now, cancel timer,
5695 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005697 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005698
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005699#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005700 /* If we requested renego but received AppData, resend HelloRequest.
5701 * Do it now, after setting in_offt, to avoid taking this branch
5702 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005703#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005704 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005706 {
Hanno Becker786300f2020-02-05 10:46:40 +00005707 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005708 {
Hanno Becker786300f2020-02-05 10:46:40 +00005709 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5710 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005711 return( ret );
5712 }
5713 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005715#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005716 }
5717
5718 n = ( len < ssl->in_msglen )
5719 ? len : ssl->in_msglen;
5720
5721 memcpy( buf, ssl->in_offt, n );
5722 ssl->in_msglen -= n;
5723
gabor-mezei-arma3214132020-07-15 10:55:00 +02005724 /* Zeroising the plaintext buffer to erase unused application data
5725 from the memory. */
5726 mbedtls_platform_zeroize( ssl->in_offt, n );
5727
Paul Bakker5121ce52009-01-03 21:22:43 +00005728 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005729 {
5730 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005731 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005732 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005733 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005734 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005735 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005736 /* more data available */
5737 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005738 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005741
Paul Bakker23986e52011-04-24 08:57:21 +00005742 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005743}
5744
5745/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005746 * Send application data to be encrypted by the SSL layer, taking care of max
5747 * fragment length and buffer size.
5748 *
5749 * According to RFC 5246 Section 6.2.1:
5750 *
5751 * Zero-length fragments of Application data MAY be sent as they are
5752 * potentially useful as a traffic analysis countermeasure.
5753 *
5754 * Therefore, it is possible that the input message length is 0 and the
5755 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005756 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005757static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005758 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005759{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005760 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5761 const size_t max_len = (size_t) ret;
5762
5763 if( ret < 0 )
5764 {
5765 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5766 return( ret );
5767 }
5768
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005769 if( len > max_len )
5770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005772 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005773 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005775 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5776 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005777 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005779 }
5780 else
5781#endif
5782 len = max_len;
5783 }
Paul Bakker887bd502011-06-08 13:10:54 +00005784
Paul Bakker5121ce52009-01-03 21:22:43 +00005785 if( ssl->out_left != 0 )
5786 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005787 /*
5788 * The user has previously tried to send the data and
5789 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5790 * written. In this case, we expect the high-level write function
5791 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005794 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005796 return( ret );
5797 }
5798 }
Paul Bakker887bd502011-06-08 13:10:54 +00005799 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005800 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005801 /*
5802 * The user is trying to send a message the first time, so we need to
5803 * copy the data into the internal buffers and setup the data structure
5804 * to keep track of partial writes
5805 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005806 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005807 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005808 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005809
Hanno Becker67bc7c32018-08-06 11:33:50 +01005810 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005811 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005813 return( ret );
5814 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005815 }
5816
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005817 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005818}
5819
5820/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005821 * Write application data, doing 1/n-1 splitting if necessary.
5822 *
5823 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005824 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005825 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005827#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005828static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005829 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005830{
Janos Follath865b3eb2019-12-16 11:46:15 +00005831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005832
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005833 if( ssl->conf->cbc_record_splitting ==
5834 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005835 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005836 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5837 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5838 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005839 {
5840 return( ssl_write_real( ssl, buf, len ) );
5841 }
5842
5843 if( ssl->split_done == 0 )
5844 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005845 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005846 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005847 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005848 }
5849
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005850 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5851 return( ret );
5852 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005853
5854 return( ret + 1 );
5855}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005856#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005857
5858/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005859 * Write application data (public-facing wrapper)
5860 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005861int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005862{
Janos Follath865b3eb2019-12-16 11:46:15 +00005863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005864
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005865 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005866
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005867 if( ssl == NULL || ssl->conf == NULL )
5868 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5869
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005870#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005871 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5872 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005873 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005874 return( ret );
5875 }
5876#endif
5877
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005878 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005880 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005881 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005882 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005883 return( ret );
5884 }
5885 }
5886
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005887#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005888 ret = ssl_write_split( ssl, buf, len );
5889#else
5890 ret = ssl_write_real( ssl, buf, len );
5891#endif
5892
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005894
5895 return( ret );
5896}
5897
5898/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005899 * Notify the peer that the connection is being closed
5900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005901int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005902{
Janos Follath865b3eb2019-12-16 11:46:15 +00005903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005904
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005905 if( ssl == NULL || ssl->conf == NULL )
5906 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005909
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005910 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005911 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005913 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005915 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5916 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5917 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005918 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005919 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005920 return( ret );
5921 }
5922 }
5923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005925
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005926 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005927}
5928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005929void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005930{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005931 if( transform == NULL )
5932 return;
5933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005934#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005935 deflateEnd( &transform->ctx_deflate );
5936 inflateEnd( &transform->ctx_inflate );
5937#endif
5938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005939 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5940 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005941
Hanno Beckerd56ed242018-01-03 15:32:51 +00005942#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005943 mbedtls_md_free( &transform->md_ctx_enc );
5944 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005945#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005946
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005947 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005948}
5949
Hanno Becker0271f962018-08-16 13:23:47 +01005950#if defined(MBEDTLS_SSL_PROTO_DTLS)
5951
Hanno Becker533ab5f2020-02-05 10:49:13 +00005952void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005953{
5954 unsigned offset;
5955 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5956
5957 if( hs == NULL )
5958 return;
5959
Hanno Becker283f5ef2018-08-24 09:34:47 +01005960 ssl_free_buffered_record( ssl );
5961
Hanno Becker0271f962018-08-16 13:23:47 +01005962 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005963 ssl_buffering_free_slot( ssl, offset );
5964}
5965
5966static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5967 uint8_t slot )
5968{
5969 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5970 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005971
5972 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5973 return;
5974
Hanno Beckere605b192018-08-21 15:59:07 +01005975 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005976 {
Hanno Beckere605b192018-08-21 15:59:07 +01005977 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005978 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005979 mbedtls_free( hs_buf->data );
5980 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005981 }
5982}
5983
5984#endif /* MBEDTLS_SSL_PROTO_DTLS */
5985
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005986/*
5987 * Convert version numbers to/from wire format
5988 * and, for DTLS, to/from TLS equivalent.
5989 *
5990 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005991 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005992 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5993 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005995void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005996 unsigned char ver[2] )
5997{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005998#if defined(MBEDTLS_SSL_PROTO_DTLS)
5999 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006001 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006002 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6003
6004 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
6005 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
6006 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006007 else
6008#else
6009 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006010#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006011 {
6012 ver[0] = (unsigned char) major;
6013 ver[1] = (unsigned char) minor;
6014 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006015}
6016
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006017void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006018 const unsigned char ver[2] )
6019{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006020#if defined(MBEDTLS_SSL_PROTO_DTLS)
6021 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006022 {
6023 *major = 255 - ver[0] + 2;
6024 *minor = 255 - ver[1] + 1;
6025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006026 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006027 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6028 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006029 else
6030#else
6031 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006032#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006033 {
6034 *major = ver[0];
6035 *minor = ver[1];
6036 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006037}
6038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006039#endif /* MBEDTLS_SSL_TLS_C */