blob: fe73130b237cf837c63acd07351c9eb75380c2c3 [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é-Gonnard2ddec432020-08-24 12:49:23 +02001048
1049/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001050 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001051 *
1052 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1053 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001054 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001055MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001056 mbedtls_md_context_t *ctx,
1057 const unsigned char *add_data, size_t add_data_len,
1058 const unsigned char *data, size_t data_len_secret,
1059 size_t min_data_len, size_t max_data_len,
1060 unsigned char *output )
1061{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001062 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001063 * This function breaks the HMAC abstraction and uses the md_clone()
1064 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001065 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001066 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001067 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001068 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001069 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001070 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1071 * minlen, then cloning the context, and for each byte up to maxlen
1072 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001073 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001074 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001075 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001076 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001077 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1078 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001079 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001080 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001081 const unsigned char * const okey = ikey + block_size;
1082 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001083
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001084 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1085 mbedtls_md_context_t aux;
1086 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001087 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001088
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001089 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001090
1091#define MD_CHK( func_call ) \
1092 do { \
1093 ret = (func_call); \
1094 if( ret != 0 ) \
1095 goto cleanup; \
1096 } while( 0 )
1097
1098 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001099
1100 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1101 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001102 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1103 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001104
1105 /* For each possible length, compute the hash up to that point */
1106 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001107 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001108 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1109 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001110 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001111 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1112 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001113
1114 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001115 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001116 }
1117
Manuel Pégourié-Gonnard21bfbdd2021-05-17 12:28:08 +02001118 /* The context needs to finish() before it starts() again */
1119 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1120
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001121 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001122 MD_CHK( mbedtls_md_starts( ctx ) );
1123 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1124 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1125 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001126
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001127 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001128 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001129
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001130#undef MD_CHK
1131
1132cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001133 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001134 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001135}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001136#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001137
Hanno Becker605949f2019-07-12 08:23:59 +01001138int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001139 mbedtls_ssl_transform *transform,
1140 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001141{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001142 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001144 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001145#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001146 size_t padlen = 0, correct = 1;
1147#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001148 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001149 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001150 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001151
Hanno Beckera18d1322018-01-03 14:27:32 +00001152#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001153 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001154 ((void) ssl);
1155#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001158 if( rec == NULL ||
1159 rec->buf == NULL ||
1160 rec->buf_len < rec->data_offset ||
1161 rec->buf_len - rec->data_offset < rec->data_len )
1162 {
1163 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001165 }
1166
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001167 data = rec->buf + rec->data_offset;
1168 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001169
Hanno Beckera0e20d02019-05-15 14:03:01 +01001170#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001171 /*
1172 * Match record's CID with incoming CID.
1173 */
Hanno Becker938489a2019-05-08 13:02:22 +01001174 if( rec->cid_len != transform->in_cid_len ||
1175 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1176 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001177 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001178 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001179#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1182 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001183 {
1184 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001185 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1186 transform->iv_dec,
1187 transform->ivlen,
1188 data, rec->data_len,
1189 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001190 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001192 return( ret );
1193 }
1194
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001195 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1198 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001199 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001200 }
Paul Bakker68884e32013-01-07 18:20:04 +01001201 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001203#if defined(MBEDTLS_GCM_C) || \
1204 defined(MBEDTLS_CCM_C) || \
1205 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001207 mode == MBEDTLS_MODE_CCM ||
1208 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001209 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001210 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001211 unsigned char *dynamic_iv;
1212 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001213
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001214 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001215 * Extract dynamic part of nonce for AEAD decryption.
1216 *
1217 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1218 * part of the IV is prepended to the ciphertext and
1219 * can be chosen freely - in particular, it need not
1220 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001221 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001222 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001223 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001224 {
1225 if( rec->data_len < dynamic_iv_len )
1226 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001227 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1228 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001229 rec->data_len,
1230 dynamic_iv_len ) );
1231 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1232 }
1233 dynamic_iv = data;
1234
1235 data += dynamic_iv_len;
1236 rec->data_offset += dynamic_iv_len;
1237 rec->data_len -= dynamic_iv_len;
1238 }
Hanno Becker17263802020-05-28 07:05:48 +01001239 else
1240 {
1241 dynamic_iv = rec->ctr;
1242 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001243
1244 /* Check that there's space for the authentication tag. */
1245 if( rec->data_len < transform->taglen )
1246 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001247 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1248 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001249 rec->data_len,
1250 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001251 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001252 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001253 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001254
Hanno Beckerdf8be222020-05-21 15:30:57 +01001255 /*
1256 * Prepare nonce from dynamic and static parts.
1257 */
Hanno Becker17263802020-05-28 07:05:48 +01001258 ssl_build_record_nonce( iv, sizeof( iv ),
1259 transform->iv_dec,
1260 transform->fixed_ivlen,
1261 dynamic_iv,
1262 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001263
Hanno Beckerdf8be222020-05-21 15:30:57 +01001264 /*
1265 * Build additional data for AEAD encryption.
1266 * This depends on the TLS version.
1267 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001268 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1269 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001270 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001271 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001272
Hanno Beckerd96a6522019-07-10 13:55:25 +01001273 /* Because of the check above, we know that there are
1274 * explicit_iv_len Bytes preceeding data, and taglen
1275 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001276 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001277 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001278
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001279 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001280 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001281 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001282
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001283 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001284 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001285 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001286 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001288 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001289 data, rec->data_len + transform->taglen, /* src */
1290 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001291 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001292 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1296 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001297
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001298 return( ret );
1299 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001300 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001301
Hanno Beckerd96a6522019-07-10 13:55:25 +01001302 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001303 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001304 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1306 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001307 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001308 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001309 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001311#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001313 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001314 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001315
Paul Bakker5121ce52009-01-03 21:22:43 +00001316 /*
Paul Bakker45829992013-01-03 14:52:21 +01001317 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001320 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1321 {
1322 /* The ciphertext is prefixed with the CBC IV. */
1323 minlen += transform->ivlen;
1324 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001325#endif
Paul Bakker45829992013-01-03 14:52:21 +01001326
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327 /* Size considerations:
1328 *
1329 * - The CBC cipher text must not be empty and hence
1330 * at least of size transform->ivlen.
1331 *
1332 * Together with the potential IV-prefix, this explains
1333 * the first of the two checks below.
1334 *
1335 * - The record must contain a MAC, either in plain or
1336 * encrypted, depending on whether Encrypt-then-MAC
1337 * is used or not.
1338 * - If it is, the message contains the IV-prefix,
1339 * the CBC ciphertext, and the MAC.
1340 * - If it is not, the padded plaintext, and hence
1341 * the CBC ciphertext, has at least length maclen + 1
1342 * because there is at least the padding length byte.
1343 *
1344 * As the CBC ciphertext is not empty, both cases give the
1345 * lower bound minlen + maclen + 1 on the record size, which
1346 * we test for in the second check below.
1347 */
1348 if( rec->data_len < minlen + transform->ivlen ||
1349 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001350 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1352 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1353 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 "+ 1 ) ( + expl IV )", rec->data_len,
1355 transform->ivlen,
1356 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001358 }
1359
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001360 /*
1361 * Authenticate before decrypt if enabled
1362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001364 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001365 {
Hanno Becker992b6872017-11-09 18:57:39 +00001366 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001369
Hanno Beckerd96a6522019-07-10 13:55:25 +01001370 /* Update data_len in tandem with add_data.
1371 *
1372 * The subtraction is safe because of the previous check
1373 * data_len >= minlen + maclen + 1.
1374 *
1375 * Afterwards, we know that data + data_len is followed by at
1376 * least maclen Bytes, which justifies the call to
1377 * mbedtls_ssl_safer_memcmp() below.
1378 *
1379 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001381 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1382 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001383
Hanno Beckerd96a6522019-07-10 13:55:25 +01001384 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001385 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1386 add_data_len );
1387 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1388 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1390 data, rec->data_len );
1391 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1392 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001393
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001394 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1395 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001396 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398
Hanno Beckerd96a6522019-07-10 13:55:25 +01001399 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001400 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1401 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001405 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001406 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001407 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001409
1410 /*
1411 * Check length sanity
1412 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001413
1414 /* We know from above that data_len > minlen >= 0,
1415 * so the following check in particular implies that
1416 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001417 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001418 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001419 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1420 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001421 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001423 }
1424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001426 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001427 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001428 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001429 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001430 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001431 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001432 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001433
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001434 data += transform->ivlen;
1435 rec->data_offset += transform->ivlen;
1436 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001437 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001439
Hanno Beckerd96a6522019-07-10 13:55:25 +01001440 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1441
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1443 transform->iv_dec, transform->ivlen,
1444 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001445 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001446 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001447 return( ret );
1448 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001449
Hanno Beckerd96a6522019-07-10 13:55:25 +01001450 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001451 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001453 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1454 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001455 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001459 {
1460 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001461 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1462 * records is equivalent to CBC decryption of the concatenation
1463 * of the records; in other words, IVs are maintained across
1464 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001465 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001466 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1467 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001468 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001469#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001470
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001471 /* Safe since data_len >= minlen + maclen + 1, so after having
1472 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001473 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1474 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001476
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001477 if( auth_done == 1 )
1478 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001479 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001480 rec->data_len,
1481 padlen + 1 );
1482 correct &= mask;
1483 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 }
1485 else
Paul Bakker45829992013-01-03 14:52:21 +01001486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001488 if( rec->data_len < transform->maclen + padlen + 1 )
1489 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1491 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1492 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001493 rec->data_len,
1494 transform->maclen,
1495 padlen + 1 ) );
1496 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001497#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001499 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001500 rec->data_len,
1501 transform->maclen + padlen + 1 );
1502 correct &= mask;
1503 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001504 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001505
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001506 padlen++;
1507
1508 /* Regardless of the validity of the padding,
1509 * we have data_len >= padlen here. */
1510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001513 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001514 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1515 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001516 * the protocol (known as part of POODLE), so we don't care if the
1517 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1522 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001523 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001524#endif
Paul Bakker45829992013-01-03 14:52:21 +01001525 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001526 }
1527 }
1528 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001529#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1530#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1531 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001533 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 /* The padding check involves a series of up to 256
1535 * consecutive memory reads at the end of the record
1536 * plaintext buffer. In order to hide the length and
1537 * validity of the padding, always perform exactly
1538 * `min(256,plaintext_len)` reads (but take into account
1539 * only the last `padlen` bytes for the padding check). */
1540 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001541 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001542
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001543 /* Index of first padding byte; it has been ensured above
1544 * that the subtraction is safe. */
1545 size_t const padding_idx = rec->data_len - padlen;
1546 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1547 size_t const start_idx = rec->data_len - num_checks;
1548 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001551 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001552 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001553 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001554 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001555 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1556 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1557 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001558 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001559 }
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001560 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001563 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001565#endif
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001566 padlen &= mbedtls_cf_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001567 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001568 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1570 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001571 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1573 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001574 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001575
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001576 /* If the padding was found to be invalid, padlen == 0
1577 * and the subtraction is safe. If the padding was found valid,
1578 * padlen hasn't been changed and the previous assertion
1579 * data_len >= padlen still holds. */
1580 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001581 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001582 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001583#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001584 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1586 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001587 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001588
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001589#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001591 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001592#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001593
1594 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001595 * Authenticate if not done yet.
1596 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001597 */
Hanno Becker52344c22018-01-03 15:24:20 +00001598#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001599 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001600 {
Hanno Becker992b6872017-11-09 18:57:39 +00001601 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001602 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001603
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001604 /* If the initial value of padlen was such that
1605 * data_len < maclen + padlen + 1, then padlen
1606 * got reset to 1, and the initial check
1607 * data_len >= minlen + maclen + 1
1608 * guarantees that at this point we still
1609 * have at least data_len >= maclen.
1610 *
1611 * If the initial value of padlen was such that
1612 * data_len >= maclen + padlen + 1, then we have
1613 * subtracted either padlen + 1 (if the padding was correct)
1614 * or 0 (if the padding was incorrect) since then,
1615 * hence data_len >= maclen in any case.
1616 */
1617 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001618 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1619 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001622 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001623 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001624 ssl_mac( &transform->md_ctx_dec,
1625 transform->mac_dec,
1626 data, rec->data_len,
1627 rec->ctr, rec->type,
1628 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001629 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001630 }
1631 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1633#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1634 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001635 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 {
1637 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001638 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001639 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001640 *
1641 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001642 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001643 *
1644 * Note that max_len + maclen is never more than the buffer
1645 * length, as we previously did in_msglen -= maclen too.
1646 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001647 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001648 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1649
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001650 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1651 add_data, add_data_len,
1652 data, rec->data_len, min_len, max_len,
1653 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001654 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001655 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001656 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1657 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001658 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001659
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001660 mbedtls_cf_memcpy_offset( mac_peer, data,
1661 rec->data_len,
1662 min_len, max_len,
1663 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001664 }
1665 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1667 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1670 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001671 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001672
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001673#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001675 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001676#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001677
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001678 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001679 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681#if defined(MBEDTLS_SSL_DEBUG_ALL)
1682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001683#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001684 correct = 0;
1685 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001686 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001687 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001688
1689 /*
1690 * Finally check the correct flag
1691 */
1692 if( correct == 0 )
1693 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001694#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001695
1696 /* Make extra sure authentication was performed, exactly once */
1697 if( auth_done != 1 )
1698 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1700 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001701 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001702
Hanno Beckerccc13d02020-05-04 12:30:04 +01001703#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1704 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1705 {
1706 /* Remove inner padding and infer true content type. */
1707 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1708 &rec->type );
1709
1710 if( ret != 0 )
1711 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1712 }
1713#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1714
Hanno Beckera0e20d02019-05-15 14:03:01 +01001715#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001716 if( rec->cid_len != 0 )
1717 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001718 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1719 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001720 if( ret != 0 )
1721 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1722 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001723#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
1727 return( 0 );
1728}
1729
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001730#undef MAC_NONE
1731#undef MAC_PLAINTEXT
1732#undef MAC_CIPHERTEXT
1733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001735/*
1736 * Compression/decompression functions
1737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001739{
Janos Follath865b3eb2019-12-16 11:46:15 +00001740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001741 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001742 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001743 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001744 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001745#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1746 size_t out_buf_len = ssl->out_buf_len;
1747#else
1748 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1749#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001752
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001753 if( len_pre == 0 )
1754 return( 0 );
1755
Paul Bakker2770fbd2012-07-03 13:30:23 +00001756 memcpy( msg_pre, ssl->out_msg, len_pre );
1757
Paul Elliottd48d5c62021-01-07 14:47:05 +00001758 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001759 ssl->out_msglen ) );
1760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001762 ssl->out_msg, ssl->out_msglen );
1763
Paul Bakker48916f92012-09-16 19:57:18 +00001764 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1765 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1766 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001767 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001768
Paul Bakker48916f92012-09-16 19:57:18 +00001769 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001770 if( ret != Z_OK )
1771 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1773 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001774 }
1775
Darryl Greenb33cc762019-11-28 14:29:44 +00001776 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001777 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001778
Paul Elliottd48d5c62021-01-07 14:47:05 +00001779 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001780 ssl->out_msglen ) );
1781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783 ssl->out_msg, ssl->out_msglen );
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786
1787 return( 0 );
1788}
1789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001791{
Janos Follath865b3eb2019-12-16 11:46:15 +00001792 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001793 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001794 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001795 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001796 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001797#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1798 size_t in_buf_len = ssl->in_buf_len;
1799#else
1800 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1801#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001804
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001805 if( len_pre == 0 )
1806 return( 0 );
1807
Paul Bakker2770fbd2012-07-03 13:30:23 +00001808 memcpy( msg_pre, ssl->in_msg, len_pre );
1809
Paul Elliottd48d5c62021-01-07 14:47:05 +00001810 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001811 ssl->in_msglen ) );
1812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814 ssl->in_msg, ssl->in_msglen );
1815
Paul Bakker48916f92012-09-16 19:57:18 +00001816 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1817 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1818 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001819 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001820
Paul Bakker48916f92012-09-16 19:57:18 +00001821 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001822 if( ret != Z_OK )
1823 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1825 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001826 }
1827
Darryl Greenb33cc762019-11-28 14:29:44 +00001828 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001829 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001830
Paul Elliottd48d5c62021-01-07 14:47:05 +00001831 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001832 ssl->in_msglen ) );
1833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835 ssl->in_msg, ssl->in_msglen );
1836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838
1839 return( 0 );
1840}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001841#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001842
Paul Bakker5121ce52009-01-03 21:22:43 +00001843/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001844 * Fill the input message buffer by appending data to it.
1845 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001846 *
1847 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1848 * available (from this read and/or a previous one). Otherwise, an error code
1849 * is returned (possibly EOF or WANT_READ).
1850 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001851 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1852 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1853 * since we always read a whole datagram at once.
1854 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001855 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001856 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001859{
Janos Follath865b3eb2019-12-16 11:46:15 +00001860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001861 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001862#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1863 size_t in_buf_len = ssl->in_buf_len;
1864#else
1865 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1866#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001869
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001870 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001873 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001875 }
1876
Darryl Greenb33cc762019-11-28 14:29:44 +00001877 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001878 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1880 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001881 }
1882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001884 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001885 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001886 uint32_t timeout;
1887
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001888 /*
1889 * The point is, we need to always read a full datagram at once, so we
1890 * sometimes read more then requested, and handle the additional data.
1891 * It could be the rest of the current record (while fetching the
1892 * header) and/or some other records in the same datagram.
1893 */
1894
1895 /*
1896 * Move to the next record in the already read datagram if applicable
1897 */
1898 if( ssl->next_record_offset != 0 )
1899 {
1900 if( ssl->in_left < ssl->next_record_offset )
1901 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1903 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001904 }
1905
1906 ssl->in_left -= ssl->next_record_offset;
1907
1908 if( ssl->in_left != 0 )
1909 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1911 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001912 ssl->next_record_offset ) );
1913 memmove( ssl->in_hdr,
1914 ssl->in_hdr + ssl->next_record_offset,
1915 ssl->in_left );
1916 }
1917
1918 ssl->next_record_offset = 0;
1919 }
1920
Paul Elliottd48d5c62021-01-07 14:47:05 +00001921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1922 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001923 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001924
1925 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001926 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001927 */
1928 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001929 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001931 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001932 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
1934 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001935 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001936 * are not at the beginning of a new record, the caller did something
1937 * wrong.
1938 */
1939 if( ssl->in_left != 0 )
1940 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1942 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001943 }
1944
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001945 /*
1946 * Don't even try to read if time's out already.
1947 * This avoids by-passing the timer when repeatedly receiving messages
1948 * that will end up being dropped.
1949 */
Hanno Becker7876d122020-02-05 10:39:31 +00001950 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001951 {
1952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001953 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001954 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001955 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001956 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001957 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001960 timeout = ssl->handshake->retransmit_timeout;
1961 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001962 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963
Paul Elliott9f352112020-12-09 14:55:45 +00001964 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001965
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001966 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001967 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1968 timeout );
1969 else
1970 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001973
1974 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001976 }
1977
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001978 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001979 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001981 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001984 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001985 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001988 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001989 }
1990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001994 return( ret );
1995 }
1996
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001997 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001998 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001999#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002000 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002002 {
Hanno Becker786300f2020-02-05 10:46:40 +00002003 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002004 {
Hanno Becker786300f2020-02-05 10:46:40 +00002005 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2006 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002007 return( ret );
2008 }
2009
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002010 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002011 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002013 }
2014
Paul Bakker5121ce52009-01-03 21:22:43 +00002015 if( ret < 0 )
2016 return( ret );
2017
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002018 ssl->in_left = ret;
2019 }
2020 else
2021#endif
2022 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2024 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002025 ssl->in_left, nb_want ) );
2026
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002027 while( ssl->in_left < nb_want )
2028 {
2029 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002030
Hanno Becker7876d122020-02-05 10:39:31 +00002031 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002032 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2033 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002034 {
2035 if( ssl->f_recv_timeout != NULL )
2036 {
2037 ret = ssl->f_recv_timeout( ssl->p_bio,
2038 ssl->in_hdr + ssl->in_left, len,
2039 ssl->conf->read_timeout );
2040 }
2041 else
2042 {
2043 ret = ssl->f_recv( ssl->p_bio,
2044 ssl->in_hdr + ssl->in_left, len );
2045 }
2046 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002047
Paul Elliottd48d5c62021-01-07 14:47:05 +00002048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2049 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002050 ssl->in_left, nb_want ) );
2051 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002052
2053 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
2056 if( ret < 0 )
2057 return( ret );
2058
makise-homuraaf9513b2020-08-24 18:26:27 +03002059 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002060 {
Darryl Green11999bb2018-03-13 15:22:58 +00002061 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002062 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002063 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002064 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2065 }
2066
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002067 ssl->in_left += ret;
2068 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002069 }
2070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002072
2073 return( 0 );
2074}
2075
2076/*
2077 * Flush any data not yet written
2078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002080{
Janos Follath865b3eb2019-12-16 11:46:15 +00002081 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002082 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002085
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002086 if( ssl->f_send == NULL )
2087 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002089 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002091 }
2092
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002093 /* Avoid incrementing counter if data is flushed */
2094 if( ssl->out_left == 0 )
2095 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002097 return( 0 );
2098 }
2099
Paul Bakker5121ce52009-01-03 21:22:43 +00002100 while( ssl->out_left > 0 )
2101 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2103 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002104 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002105
Hanno Becker2b1e3542018-08-06 11:19:13 +01002106 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002107 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002110
2111 if( ret <= 0 )
2112 return( ret );
2113
makise-homuraaf9513b2020-08-24 18:26:27 +03002114 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002115 {
Darryl Green11999bb2018-03-13 15:22:58 +00002116 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002117 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002118 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002119 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2120 }
2121
Paul Bakker5121ce52009-01-03 21:22:43 +00002122 ssl->out_left -= ret;
2123 }
2124
Hanno Becker2b1e3542018-08-06 11:19:13 +01002125#if defined(MBEDTLS_SSL_PROTO_DTLS)
2126 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002127 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002128 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002129 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002130 else
2131#endif
2132 {
2133 ssl->out_hdr = ssl->out_buf + 8;
2134 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002135 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002138
2139 return( 0 );
2140}
2141
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002142/*
2143 * Functions to handle the DTLS retransmission state machine
2144 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146/*
2147 * Append current handshake message to current outgoing flight
2148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2153 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2154 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002155
2156 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002157 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002158 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002159 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002161 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002162 }
2163
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002164 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2167 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002169 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002170 }
2171
2172 /* Copy current handshake message with headers */
2173 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2174 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002175 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002176 msg->next = NULL;
2177
2178 /* Append to the current flight */
2179 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002180 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181 else
2182 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184 while( cur->next != NULL )
2185 cur = cur->next;
2186 cur->next = msg;
2187 }
2188
Hanno Becker3b235902018-08-06 09:54:53 +01002189 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190 return( 0 );
2191}
2192
2193/*
2194 * Free the current flight of handshake messages
2195 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002196void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002197{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 mbedtls_ssl_flight_item *cur = flight;
2199 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002200
2201 while( cur != NULL )
2202 {
2203 next = cur->next;
2204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205 mbedtls_free( cur->p );
2206 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002207
2208 cur = next;
2209 }
2210}
2211
2212/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002213 * Swap transform_out and out_ctr with the alternative ones
2214 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002215static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002216{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002218 unsigned char tmp_out_ctr[8];
2219
2220 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2221 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002223 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002224 }
2225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002228 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002229 tmp_transform = ssl->transform_out;
2230 ssl->transform_out = ssl->handshake->alt_transform_out;
2231 ssl->handshake->alt_transform_out = tmp_transform;
2232
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002233 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002234 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2235 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002236 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002237
2238 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002239 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2242 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002243 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002244 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2245 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002246 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2248 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002249 }
2250 }
2251#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002252
2253 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254}
2255
2256/*
2257 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002258 */
2259int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2260{
2261 int ret = 0;
2262
2263 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2264
2265 ret = mbedtls_ssl_flight_transmit( ssl );
2266
2267 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2268
2269 return( ret );
2270}
2271
2272/*
2273 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274 *
2275 * Need to remember the current message in case flush_output returns
2276 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002277 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002278 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002279int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002280{
Janos Follath865b3eb2019-12-16 11:46:15 +00002281 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002282 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002285 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002287
2288 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002289 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002290 ret = ssl_swap_epochs( ssl );
2291 if( ret != 0 )
2292 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002294 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002295 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002296
2297 while( ssl->handshake->cur_msg != NULL )
2298 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002299 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002300 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002301
Hanno Beckere1dcb032018-08-17 16:47:58 +01002302 int const is_finished =
2303 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2304 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2305
Hanno Becker04da1892018-08-14 13:22:10 +01002306 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2307 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2308
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002309 /* Swap epochs before sending Finished: we can't do it after
2310 * sending ChangeCipherSpec, in case write returns WANT_READ.
2311 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002312 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002313 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002314 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002315 ret = ssl_swap_epochs( ssl );
2316 if( ret != 0 )
2317 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002318 }
2319
Hanno Becker67bc7c32018-08-06 11:33:50 +01002320 ret = ssl_get_remaining_payload_in_datagram( ssl );
2321 if( ret < 0 )
2322 return( ret );
2323 max_frag_len = (size_t) ret;
2324
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002325 /* CCS is copied as is, while HS messages may need fragmentation */
2326 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2327 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002328 if( max_frag_len == 0 )
2329 {
2330 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2331 return( ret );
2332
2333 continue;
2334 }
2335
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002336 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002337 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002338 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002339
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002340 /* Update position inside current message */
2341 ssl->handshake->cur_msg_p += cur->len;
2342 }
2343 else
2344 {
2345 const unsigned char * const p = ssl->handshake->cur_msg_p;
2346 const size_t hs_len = cur->len - 12;
2347 const size_t frag_off = p - ( cur->p + 12 );
2348 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002349 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002350
Hanno Beckere1dcb032018-08-17 16:47:58 +01002351 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002352 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002353 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002354 {
2355 ret = ssl_swap_epochs( ssl );
2356 if( ret != 0 )
2357 return( ret );
2358 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002359
Hanno Becker67bc7c32018-08-06 11:33:50 +01002360 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2361 return( ret );
2362
2363 continue;
2364 }
2365 max_hs_frag_len = max_frag_len - 12;
2366
2367 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2368 max_hs_frag_len : rem_len;
2369
2370 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002371 {
2372 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002373 (unsigned) cur_hs_frag_len,
2374 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002375 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002376
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002377 /* Messages are stored with handshake headers as if not fragmented,
2378 * copy beginning of headers then fill fragmentation fields.
2379 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2380 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002381
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002382 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2383 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2384 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002385
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002386 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2387 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2388 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002389
2390 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2391
Hanno Becker3f7b9732018-08-28 09:53:25 +01002392 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002393 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2394 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002395 ssl->out_msgtype = cur->type;
2396
2397 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002398 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002399 }
2400
2401 /* If done with the current message move to the next one if any */
2402 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2403 {
2404 if( cur->next != NULL )
2405 {
2406 ssl->handshake->cur_msg = cur->next;
2407 ssl->handshake->cur_msg_p = cur->next->p + 12;
2408 }
2409 else
2410 {
2411 ssl->handshake->cur_msg = NULL;
2412 ssl->handshake->cur_msg_p = NULL;
2413 }
2414 }
2415
2416 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002417 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002418 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002420 return( ret );
2421 }
2422 }
2423
Hanno Becker67bc7c32018-08-06 11:33:50 +01002424 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2425 return( ret );
2426
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002427 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2429 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002430 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002433 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002434 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002435
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002436 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002437
2438 return( 0 );
2439}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002440
2441/*
2442 * To be called when the last message of an incoming flight is received.
2443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002445{
2446 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002447 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002448 ssl->handshake->flight = NULL;
2449 ssl->handshake->cur_msg = NULL;
2450
2451 /* The next incoming flight will start with this msg_seq */
2452 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2453
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002454 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002455 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002456
Hanno Becker0271f962018-08-16 13:23:47 +01002457 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002458 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002459
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002460 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002461 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2464 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002465 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002467 }
2468 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002470}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002471
2472/*
2473 * To be called when the last message of an outgoing flight is send.
2474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002476{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002477 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002478 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2481 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002482 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002484 }
2485 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002487}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002489
Paul Bakker5121ce52009-01-03 21:22:43 +00002490/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002491 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002493
2494/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002495 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002496 *
2497 * - fill in handshake headers
2498 * - update handshake checksum
2499 * - DTLS: save message for resending
2500 * - then pass to the record layer
2501 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002502 * DTLS: except for HelloRequest, messages are only queued, and will only be
2503 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002504 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002505 * Inputs:
2506 * - ssl->out_msglen: 4 + actual handshake message len
2507 * (4 is the size of handshake headers for TLS)
2508 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2509 * - ssl->out_msg + 4: the handshake message body
2510 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002511 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002512 * - ssl->out_msglen: the length of the record contents
2513 * (including handshake headers but excluding record headers)
2514 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002515 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002516int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002517{
Janos Follath865b3eb2019-12-16 11:46:15 +00002518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002519 const size_t hs_len = ssl->out_msglen - 4;
2520 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002521
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2523
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002524 /*
2525 * Sanity checks
2526 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002527 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002528 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2529 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002530 /* In SSLv3, the client might send a NoCertificate alert. */
2531#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2532 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2533 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2534 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2535#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2536 {
2537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2538 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2539 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002540 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002541
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002542 /* Whenever we send anything different from a
2543 * HelloRequest we should be in a handshake - double check. */
2544 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2545 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002546 ssl->handshake == NULL )
2547 {
2548 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2549 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2550 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002553 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002554 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002556 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2558 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002560#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002561
Hanno Beckerb50a2532018-08-06 11:52:54 +01002562 /* Double-check that we did not exceed the bounds
2563 * of the outgoing record buffer.
2564 * This should never fail as the various message
2565 * writing functions must obey the bounds of the
2566 * outgoing record buffer, but better be safe.
2567 *
2568 * Note: We deliberately do not check for the MTU or MFL here.
2569 */
2570 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2571 {
2572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002573 "size %" MBEDTLS_PRINTF_SIZET
2574 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002575 ssl->out_msglen,
2576 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002577 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2578 }
2579
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002580 /*
2581 * Fill handshake headers
2582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002584 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002585 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2586 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2587 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002588
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002589 /*
2590 * DTLS has additional fields in the Handshake layer,
2591 * between the length field and the actual payload:
2592 * uint16 message_seq;
2593 * uint24 fragment_offset;
2594 * uint24 fragment_length;
2595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002597 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002598 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002599 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002600 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002601 {
2602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002603 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002604 hs_len,
2605 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002606 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2607 }
2608
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002609 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002610 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002611
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002612 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002613 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002614 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002615 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002616 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002617 }
2618 else
2619 {
2620 ssl->out_msg[4] = 0;
2621 ssl->out_msg[5] = 0;
2622 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002623
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002624 /* Handshake hashes are computed without fragmentation,
2625 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002626 memset( ssl->out_msg + 6, 0x00, 3 );
2627 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002628 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002630
Hanno Becker0207e532018-08-28 10:28:28 +01002631 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002632 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2633 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002634 }
2635
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002636 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002638 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002639 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2640 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002641 {
2642 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2643 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002645 return( ret );
2646 }
2647 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002648 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002649#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002650 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002651 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002652 {
2653 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2654 return( ret );
2655 }
2656 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002657
2658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2659
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002660 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002661}
2662
2663/*
2664 * Record layer functions
2665 */
2666
2667/*
2668 * Write current record.
2669 *
2670 * Uses:
2671 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2672 * - ssl->out_msglen: length of the record content (excl headers)
2673 * - ssl->out_msg: record content
2674 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002675int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002676{
2677 int ret, done = 0;
2678 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002679 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002680
2681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002684 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002686 {
2687 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002690 return( ret );
2691 }
2692
2693 len = ssl->out_msglen;
2694 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002697#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2698 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002699 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 ret = mbedtls_ssl_hw_record_write( ssl );
2703 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2706 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002707 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002708
2709 if( ret == 0 )
2710 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002711 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002713 if( !done )
2714 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002715 unsigned i;
2716 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002717#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2718 size_t out_buf_len = ssl->out_buf_len;
2719#else
2720 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2721#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002722 /* Skip writing the record content type to after the encryption,
2723 * as it may change when using the CID extension. */
2724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002726 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002727
Hanno Becker19859472018-08-06 09:40:20 +01002728 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002729 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002730
Paul Bakker48916f92012-09-16 19:57:18 +00002731 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002732 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002733 mbedtls_record rec;
2734
2735 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002736 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002737 rec.data_len = ssl->out_msglen;
2738 rec.data_offset = ssl->out_msg - rec.buf;
2739
2740 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2741 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2742 ssl->conf->transport, rec.ver );
2743 rec.type = ssl->out_msgtype;
2744
Hanno Beckera0e20d02019-05-15 14:03:01 +01002745#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002746 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002747 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002748#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002749
Hanno Beckera18d1322018-01-03 14:27:32 +00002750 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002751 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002752 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002754 return( ret );
2755 }
2756
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002757 if( rec.data_offset != 0 )
2758 {
2759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2760 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2761 }
2762
Hanno Becker6430faf2019-05-08 11:57:13 +01002763 /* Update the record content type and CID. */
2764 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002765#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002766 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002767#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002768 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002769 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002770 }
2771
Hanno Becker5903de42019-05-03 14:46:38 +01002772 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002773
2774#if defined(MBEDTLS_SSL_PROTO_DTLS)
2775 /* In case of DTLS, double-check that we don't exceed
2776 * the remaining space in the datagram. */
2777 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2778 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002779 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002780 if( ret < 0 )
2781 return( ret );
2782
2783 if( protected_record_size > (size_t) ret )
2784 {
2785 /* Should never happen */
2786 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2787 }
2788 }
2789#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002790
Hanno Becker6430faf2019-05-08 11:57:13 +01002791 /* Now write the potentially updated record content type. */
2792 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2793
Paul Elliott9f352112020-12-09 14:55:45 +00002794 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002795 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002796 ssl->out_hdr[0], ssl->out_hdr[1],
2797 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002800 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002801
2802 ssl->out_left += protected_record_size;
2803 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002804 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002805
Hanno Beckerdd772292020-02-05 10:38:31 +00002806 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002807 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2808 break;
2809
2810 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002811 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002812 {
2813 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2814 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2815 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002816 }
2817
Hanno Becker67bc7c32018-08-06 11:33:50 +01002818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002819 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2820 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002821 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002822 size_t remaining;
2823 ret = ssl_get_remaining_payload_in_datagram( ssl );
2824 if( ret < 0 )
2825 {
2826 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2827 ret );
2828 return( ret );
2829 }
2830
2831 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002832 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002833 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002834 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002835 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002836 else
2837 {
Hanno Becker513815a2018-08-20 11:56:09 +01002838 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002839 }
2840 }
2841#endif /* MBEDTLS_SSL_PROTO_DTLS */
2842
2843 if( ( flush == SSL_FORCE_FLUSH ) &&
2844 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002845 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002847 return( ret );
2848 }
2849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002851
2852 return( 0 );
2853}
2854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002856
2857static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2858{
2859 if( ssl->in_msglen < ssl->in_hslen ||
2860 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2861 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2862 {
2863 return( 1 );
2864 }
2865 return( 0 );
2866}
Hanno Becker44650b72018-08-16 12:51:11 +01002867
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002868static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002869{
2870 return( ( ssl->in_msg[9] << 16 ) |
2871 ( ssl->in_msg[10] << 8 ) |
2872 ssl->in_msg[11] );
2873}
2874
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002875static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002876{
2877 return( ( ssl->in_msg[6] << 16 ) |
2878 ( ssl->in_msg[7] << 8 ) |
2879 ssl->in_msg[8] );
2880}
2881
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002882static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002883{
2884 uint32_t msg_len, frag_off, frag_len;
2885
2886 msg_len = ssl_get_hs_total_len( ssl );
2887 frag_off = ssl_get_hs_frag_off( ssl );
2888 frag_len = ssl_get_hs_frag_len( ssl );
2889
2890 if( frag_off > msg_len )
2891 return( -1 );
2892
2893 if( frag_len > msg_len - frag_off )
2894 return( -1 );
2895
2896 if( frag_len + 12 > ssl->in_msglen )
2897 return( -1 );
2898
2899 return( 0 );
2900}
2901
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002902/*
2903 * Mark bits in bitmask (used for DTLS HS reassembly)
2904 */
2905static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2906{
2907 unsigned int start_bits, end_bits;
2908
2909 start_bits = 8 - ( offset % 8 );
2910 if( start_bits != 8 )
2911 {
2912 size_t first_byte_idx = offset / 8;
2913
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002914 /* Special case */
2915 if( len <= start_bits )
2916 {
2917 for( ; len != 0; len-- )
2918 mask[first_byte_idx] |= 1 << ( start_bits - len );
2919
2920 /* Avoid potential issues with offset or len becoming invalid */
2921 return;
2922 }
2923
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002924 offset += start_bits; /* Now offset % 8 == 0 */
2925 len -= start_bits;
2926
2927 for( ; start_bits != 0; start_bits-- )
2928 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2929 }
2930
2931 end_bits = len % 8;
2932 if( end_bits != 0 )
2933 {
2934 size_t last_byte_idx = ( offset + len ) / 8;
2935
2936 len -= end_bits; /* Now len % 8 == 0 */
2937
2938 for( ; end_bits != 0; end_bits-- )
2939 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2940 }
2941
2942 memset( mask + offset / 8, 0xFF, len / 8 );
2943}
2944
2945/*
2946 * Check that bitmask is full
2947 */
2948static int ssl_bitmask_check( unsigned char *mask, size_t len )
2949{
2950 size_t i;
2951
2952 for( i = 0; i < len / 8; i++ )
2953 if( mask[i] != 0xFF )
2954 return( -1 );
2955
2956 for( i = 0; i < len % 8; i++ )
2957 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2958 return( -1 );
2959
2960 return( 0 );
2961}
2962
Hanno Becker56e205e2018-08-16 09:06:12 +01002963/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002964static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002965 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002966{
Hanno Becker56e205e2018-08-16 09:06:12 +01002967 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002968
Hanno Becker56e205e2018-08-16 09:06:12 +01002969 alloc_len = 12; /* Handshake header */
2970 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002971
Hanno Beckerd07df862018-08-16 09:14:58 +01002972 if( add_bitmap )
2973 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002974
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002975 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002976}
Hanno Becker56e205e2018-08-16 09:06:12 +01002977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002979
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002980static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002981{
2982 return( ( ssl->in_msg[1] << 16 ) |
2983 ( ssl->in_msg[2] << 8 ) |
2984 ssl->in_msg[3] );
2985}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002986
Simon Butcher99000142016-10-13 17:21:01 +01002987int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002988{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002990 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002991 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002992 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002994 }
2995
Hanno Becker12555c62018-08-16 12:47:53 +01002996 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00002999 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003000 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003003 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003004 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003006 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003007
Hanno Becker44650b72018-08-16 12:51:11 +01003008 if( ssl_check_hs_header( ssl ) != 0 )
3009 {
3010 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3011 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3012 }
3013
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003014 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003015 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3016 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3017 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3018 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003019 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003020 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3021 {
3022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3023 recv_msg_seq,
3024 ssl->handshake->in_msg_seq ) );
3025 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3026 }
3027
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003028 /* Retransmit only on last message from previous flight, to avoid
3029 * too many retransmissions.
3030 * Besides, No sane server ever retransmits HelloVerifyRequest */
3031 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003033 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003035 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003036 recv_msg_seq,
3037 ssl->handshake->in_flight_start_seq ) );
3038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003040 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003042 return( ret );
3043 }
3044 }
3045 else
3046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003048 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003049 recv_msg_seq,
3050 ssl->handshake->in_msg_seq ) );
3051 }
3052
Hanno Becker90333da2017-10-10 11:27:13 +01003053 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003054 }
3055 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003056
Hanno Becker6d97ef52018-08-16 13:09:04 +01003057 /* Message reassembly is handled alongside buffering of future
3058 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003059 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003060 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003061 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003064 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003065 }
3066 }
3067 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003069 /* With TLS we don't handle fragmentation (for now) */
3070 if( ssl->in_msglen < ssl->in_hslen )
3071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3073 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003074 }
3075
Simon Butcher99000142016-10-13 17:21:01 +01003076 return( 0 );
3077}
3078
3079void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3080{
Hanno Becker0271f962018-08-16 13:23:47 +01003081 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003082
Hanno Becker0271f962018-08-16 13:23:47 +01003083 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003084 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003085 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003086 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003087
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003088 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003090 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003091 ssl->handshake != NULL )
3092 {
Hanno Becker0271f962018-08-16 13:23:47 +01003093 unsigned offset;
3094 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003095
Hanno Becker0271f962018-08-16 13:23:47 +01003096 /* Increment handshake sequence number */
3097 hs->in_msg_seq++;
3098
3099 /*
3100 * Clear up handshake buffering and reassembly structure.
3101 */
3102
3103 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003104 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003105
3106 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003107 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3108 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003109 offset++, hs_buf++ )
3110 {
3111 *hs_buf = *(hs_buf + 1);
3112 }
3113
3114 /* Create a fresh last entry */
3115 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003116 }
3117#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003118}
3119
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003120/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003121 * DTLS anti-replay: RFC 6347 4.1.2.6
3122 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003123 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3124 * Bit n is set iff record number in_window_top - n has been seen.
3125 *
3126 * Usually, in_window_top is the last record number seen and the lsb of
3127 * in_window is set. The only exception is the initial state (record number 0
3128 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003131void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003132{
3133 ssl->in_window_top = 0;
3134 ssl->in_window = 0;
3135}
3136
3137static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3138{
3139 return( ( (uint64_t) buf[0] << 40 ) |
3140 ( (uint64_t) buf[1] << 32 ) |
3141 ( (uint64_t) buf[2] << 24 ) |
3142 ( (uint64_t) buf[3] << 16 ) |
3143 ( (uint64_t) buf[4] << 8 ) |
3144 ( (uint64_t) buf[5] ) );
3145}
3146
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003147static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3148{
Janos Follath865b3eb2019-12-16 11:46:15 +00003149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003150 unsigned char *original_in_ctr;
3151
3152 // save original in_ctr
3153 original_in_ctr = ssl->in_ctr;
3154
3155 // use counter from record
3156 ssl->in_ctr = record_in_ctr;
3157
3158 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3159
3160 // restore the counter
3161 ssl->in_ctr = original_in_ctr;
3162
3163 return ret;
3164}
3165
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003166/*
3167 * Return 0 if sequence number is acceptable, -1 otherwise
3168 */
Hanno Becker0183d692019-07-12 08:50:37 +01003169int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003170{
3171 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3172 uint64_t bit;
3173
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003174 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003175 return( 0 );
3176
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003177 if( rec_seqnum > ssl->in_window_top )
3178 return( 0 );
3179
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003180 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003181
3182 if( bit >= 64 )
3183 return( -1 );
3184
3185 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3186 return( -1 );
3187
3188 return( 0 );
3189}
3190
3191/*
3192 * Update replay window on new validated record
3193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003195{
3196 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3197
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003198 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003199 return;
3200
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003201 if( rec_seqnum > ssl->in_window_top )
3202 {
3203 /* Update window_top and the contents of the window */
3204 uint64_t shift = rec_seqnum - ssl->in_window_top;
3205
3206 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003207 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003208 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003209 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003210 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003211 ssl->in_window |= 1;
3212 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003213
3214 ssl->in_window_top = rec_seqnum;
3215 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003216 else
3217 {
3218 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003219 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003220
3221 if( bit < 64 ) /* Always true, but be extra sure */
3222 ssl->in_window |= (uint64_t) 1 << bit;
3223 }
3224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003226
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003227#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003228/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003229 * Without any SSL context, check if a datagram looks like a ClientHello with
3230 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003231 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003232 *
3233 * - if cookie is valid, return 0
3234 * - if ClientHello looks superficially valid but cookie is not,
3235 * fill obuf and set olen, then
3236 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3237 * - otherwise return a specific error code
3238 */
3239static int ssl_check_dtls_clihlo_cookie(
3240 mbedtls_ssl_cookie_write_t *f_cookie_write,
3241 mbedtls_ssl_cookie_check_t *f_cookie_check,
3242 void *p_cookie,
3243 const unsigned char *cli_id, size_t cli_id_len,
3244 const unsigned char *in, size_t in_len,
3245 unsigned char *obuf, size_t buf_len, size_t *olen )
3246{
3247 size_t sid_len, cookie_len;
3248 unsigned char *p;
3249
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003250 /*
3251 * Structure of ClientHello with record and handshake headers,
3252 * and expected values. We don't need to check a lot, more checks will be
3253 * done when actually parsing the ClientHello - skipping those checks
3254 * avoids code duplication and does not make cookie forging any easier.
3255 *
3256 * 0-0 ContentType type; copied, must be handshake
3257 * 1-2 ProtocolVersion version; copied
3258 * 3-4 uint16 epoch; copied, must be 0
3259 * 5-10 uint48 sequence_number; copied
3260 * 11-12 uint16 length; (ignored)
3261 *
3262 * 13-13 HandshakeType msg_type; (ignored)
3263 * 14-16 uint24 length; (ignored)
3264 * 17-18 uint16 message_seq; copied
3265 * 19-21 uint24 fragment_offset; copied, must be 0
3266 * 22-24 uint24 fragment_length; (ignored)
3267 *
3268 * 25-26 ProtocolVersion client_version; (ignored)
3269 * 27-58 Random random; (ignored)
3270 * 59-xx SessionID session_id; 1 byte len + sid_len content
3271 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3272 * ...
3273 *
3274 * Minimum length is 61 bytes.
3275 */
3276 if( in_len < 61 ||
3277 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3278 in[3] != 0 || in[4] != 0 ||
3279 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3280 {
3281 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3282 }
3283
3284 sid_len = in[59];
3285 if( sid_len > in_len - 61 )
3286 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3287
3288 cookie_len = in[60 + sid_len];
3289 if( cookie_len > in_len - 60 )
3290 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3291
3292 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3293 cli_id, cli_id_len ) == 0 )
3294 {
3295 /* Valid cookie */
3296 return( 0 );
3297 }
3298
3299 /*
3300 * If we get here, we've got an invalid cookie, let's prepare HVR.
3301 *
3302 * 0-0 ContentType type; copied
3303 * 1-2 ProtocolVersion version; copied
3304 * 3-4 uint16 epoch; copied
3305 * 5-10 uint48 sequence_number; copied
3306 * 11-12 uint16 length; olen - 13
3307 *
3308 * 13-13 HandshakeType msg_type; hello_verify_request
3309 * 14-16 uint24 length; olen - 25
3310 * 17-18 uint16 message_seq; copied
3311 * 19-21 uint24 fragment_offset; copied
3312 * 22-24 uint24 fragment_length; olen - 25
3313 *
3314 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3315 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3316 *
3317 * Minimum length is 28.
3318 */
3319 if( buf_len < 28 )
3320 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3321
3322 /* Copy most fields and adapt others */
3323 memcpy( obuf, in, 25 );
3324 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3325 obuf[25] = 0xfe;
3326 obuf[26] = 0xff;
3327
3328 /* Generate and write actual cookie */
3329 p = obuf + 28;
3330 if( f_cookie_write( p_cookie,
3331 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3332 {
3333 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3334 }
3335
3336 *olen = p - obuf;
3337
3338 /* Go back and fill length fields */
3339 obuf[27] = (unsigned char)( *olen - 28 );
3340
Joe Subbianiad1115a2021-07-16 14:27:50 +01003341 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3342 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3343 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003344
Joe Subbianic54e9082021-07-19 11:56:54 +01003345 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003346
3347 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3348}
3349
3350/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003351 * Handle possible client reconnect with the same UDP quadruplet
3352 * (RFC 6347 Section 4.2.8).
3353 *
3354 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3355 * that looks like a ClientHello.
3356 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003357 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003358 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003359 * - if the input looks like a ClientHello with a valid cookie,
3360 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003361 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003363 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003364 * This function is called (through ssl_check_client_reconnect()) when an
3365 * unexpected record is found in ssl_get_next_record(), which will discard the
3366 * record if we return 0, and bubble up the return value otherwise (this
3367 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3368 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003369 */
3370static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3371{
Janos Follath865b3eb2019-12-16 11:46:15 +00003372 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003373 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003374
Hanno Becker2fddd372019-07-10 14:37:41 +01003375 if( ssl->conf->f_cookie_write == NULL ||
3376 ssl->conf->f_cookie_check == NULL )
3377 {
3378 /* If we can't use cookies to verify reachability of the peer,
3379 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003380 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3381 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003382 return( 0 );
3383 }
3384
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003385 ret = ssl_check_dtls_clihlo_cookie(
3386 ssl->conf->f_cookie_write,
3387 ssl->conf->f_cookie_check,
3388 ssl->conf->p_cookie,
3389 ssl->cli_id, ssl->cli_id_len,
3390 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003391 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003392
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003393 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3394
3395 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003396 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003397 int send_ret;
3398 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3399 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3400 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003401 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003402 * If the error is permanent we'll catch it later,
3403 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003404 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3405 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3406 (void) send_ret;
3407
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003408 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003409 }
3410
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003411 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003412 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003414 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003415 {
3416 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3417 return( ret );
3418 }
3419
3420 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003421 }
3422
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003423 return( ret );
3424}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003425#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003426
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003427static int ssl_check_record_type( uint8_t record_type )
3428{
3429 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3430 record_type != MBEDTLS_SSL_MSG_ALERT &&
3431 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3432 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3433 {
3434 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3435 }
3436
3437 return( 0 );
3438}
3439
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003440/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003441 * ContentType type;
3442 * ProtocolVersion version;
3443 * uint16 epoch; // DTLS only
3444 * uint48 sequence_number; // DTLS only
3445 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003446 *
3447 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003448 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003449 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3450 *
3451 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003452 * 1. proceed with the record if this function returns 0
3453 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3454 * 3. return CLIENT_RECONNECT if this function return that value
3455 * 4. drop the whole datagram if this function returns anything else.
3456 * Point 2 is needed when the peer is resending, and we have already received
3457 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003458 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003459static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003460 unsigned char *buf,
3461 size_t len,
3462 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003463{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003464 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003465
Hanno Beckere5e7e782019-07-11 12:29:35 +01003466 size_t const rec_hdr_type_offset = 0;
3467 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003468
Hanno Beckere5e7e782019-07-11 12:29:35 +01003469 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3470 rec_hdr_type_len;
3471 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003472
Hanno Beckere5e7e782019-07-11 12:29:35 +01003473 size_t const rec_hdr_ctr_len = 8;
3474#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003475 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003476 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3477 rec_hdr_version_len;
3478
Hanno Beckera0e20d02019-05-15 14:03:01 +01003479#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003480 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3481 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003482 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003483#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3484#endif /* MBEDTLS_SSL_PROTO_DTLS */
3485
3486 size_t rec_hdr_len_offset; /* To be determined */
3487 size_t const rec_hdr_len_len = 2;
3488
3489 /*
3490 * Check minimum lengths for record header.
3491 */
3492
3493#if defined(MBEDTLS_SSL_PROTO_DTLS)
3494 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3495 {
3496 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3497 }
3498 else
3499#endif /* MBEDTLS_SSL_PROTO_DTLS */
3500 {
3501 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3502 }
3503
3504 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3505 {
3506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3507 (unsigned) len,
3508 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3509 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3510 }
3511
3512 /*
3513 * Parse and validate record content type
3514 */
3515
3516 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517
3518 /* Check record content type */
3519#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3520 rec->cid_len = 0;
3521
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003522 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003523 ssl->conf->cid_len != 0 &&
3524 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003525 {
3526 /* Shift pointers to account for record header including CID
3527 * struct {
3528 * ContentType special_type = tls12_cid;
3529 * ProtocolVersion version;
3530 * uint16 epoch;
3531 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003532 * opaque cid[cid_length]; // Additional field compared to
3533 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003534 * uint16 length;
3535 * opaque enc_content[DTLSCiphertext.length];
3536 * } DTLSCiphertext;
3537 */
3538
3539 /* So far, we only support static CID lengths
3540 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003541 rec_hdr_cid_len = ssl->conf->cid_len;
3542 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003543
Hanno Beckere5e7e782019-07-11 12:29:35 +01003544 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003545 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3547 (unsigned) len,
3548 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003549 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003550 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003551
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003552 /* configured CID len is guaranteed at most 255, see
3553 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3554 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003556 }
3557 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003558#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003559 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003560 if( ssl_check_record_type( rec->type ) )
3561 {
Hanno Becker54229812019-07-12 14:40:00 +01003562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3563 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3565 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003566 }
3567
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568 /*
3569 * Parse and validate record version
3570 */
3571
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003572 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3573 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003574 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3575 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003576 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003577
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003578 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003579 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3581 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003582 }
3583
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003584 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003585 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3587 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003588 }
3589
Hanno Beckere5e7e782019-07-11 12:29:35 +01003590 /*
3591 * Parse/Copy record sequence number.
3592 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003593
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594#if defined(MBEDTLS_SSL_PROTO_DTLS)
3595 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003596 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003597 /* Copy explicit record sequence number from input buffer. */
3598 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3599 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003600 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003601 else
3602#endif /* MBEDTLS_SSL_PROTO_DTLS */
3603 {
3604 /* Copy implicit record sequence number from SSL context structure. */
3605 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3606 }
Paul Bakker40e46942009-01-03 21:51:57 +00003607
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 /*
3609 * Parse record length.
3610 */
3611
Hanno Beckere5e7e782019-07-11 12:29:35 +01003612 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003613 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3614 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003615 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003616
Paul Elliott9f352112020-12-09 14:55:45 +00003617 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003618 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003619 rec->type,
3620 major_ver, minor_ver, rec->data_len ) );
3621
3622 rec->buf = buf;
3623 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003624
Hanno Beckerd417cc92019-07-26 08:20:27 +01003625 if( rec->data_len == 0 )
3626 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003627
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003628 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003629 * DTLS-related tests.
3630 * Check epoch before checking length constraint because
3631 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3632 * message gets duplicated before the corresponding Finished message,
3633 * the second ChangeCipherSpec should be discarded because it belongs
3634 * to an old epoch, but not because its length is shorter than
3635 * the minimum record length for packets using the new record transform.
3636 * Note that these two kinds of failures are handled differently,
3637 * as an unexpected record is silently skipped but an invalid
3638 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003639 */
3640#if defined(MBEDTLS_SSL_PROTO_DTLS)
3641 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3642 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003643 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003644
Hanno Becker955a5c92019-07-10 17:12:07 +01003645 /* Check that the datagram is large enough to contain a record
3646 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003648 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3650 (unsigned) len,
3651 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003652 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3653 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003654
Hanno Becker37cfe732019-07-10 17:20:01 +01003655 /* Records from other, non-matching epochs are silently discarded.
3656 * (The case of same-port Client reconnects must be considered in
3657 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003658 if( rec_epoch != ssl->in_epoch )
3659 {
3660 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003661 "expected %u, received %lu",
3662 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003663
Hanno Becker552f7472019-07-19 10:59:12 +01003664 /* Records from the next epoch are considered for buffering
3665 * (concretely: early Finished messages). */
3666 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003667 {
Hanno Becker552f7472019-07-19 10:59:12 +01003668 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3669 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003670 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003671
Hanno Becker2fddd372019-07-10 14:37:41 +01003672 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003673 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003674#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003675 /* For records from the correct epoch, check whether their
3676 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003677 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3678 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003679 {
3680 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3681 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3682 }
3683#endif
3684 }
3685#endif /* MBEDTLS_SSL_PROTO_DTLS */
3686
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003687 return( 0 );
3688}
Paul Bakker5121ce52009-01-03 21:22:43 +00003689
Paul Bakker5121ce52009-01-03 21:22:43 +00003690
Hanno Becker2fddd372019-07-10 14:37:41 +01003691#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3692static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3693{
3694 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3695
3696 /*
3697 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3698 * access the first byte of record content (handshake type), as we
3699 * have an active transform (possibly iv_len != 0), so use the
3700 * fact that the record header len is 13 instead.
3701 */
3702 if( rec_epoch == 0 &&
3703 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3704 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3705 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3706 ssl->in_left > 13 &&
3707 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3708 {
3709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3710 "from the same port" ) );
3711 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003712 }
3713
3714 return( 0 );
3715}
Hanno Becker2fddd372019-07-10 14:37:41 +01003716#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003717
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003718/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003719 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003720 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003721static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3722 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003723{
3724 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003727 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003729#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3730 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734 ret = mbedtls_ssl_hw_record_read( ssl );
3735 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003736 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003737 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3738 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003739 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003740
3741 if( ret == 0 )
3742 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003743 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003744#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003745 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003746 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003747 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003748
Hanno Beckera18d1322018-01-03 14:27:32 +00003749 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003750 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003751 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003752 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003753
Hanno Beckera0e20d02019-05-15 14:03:01 +01003754#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003755 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3756 ssl->conf->ignore_unexpected_cid
3757 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3758 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003759 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003760 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003761 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003762#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003763
Paul Bakker5121ce52009-01-03 21:22:43 +00003764 return( ret );
3765 }
3766
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003767 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003768 {
3769 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003770 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003771 }
3772
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003773 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003774 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003775
Hanno Beckera0e20d02019-05-15 14:03:01 +01003776#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003777 /* We have already checked the record content type
3778 * in ssl_parse_record_header(), failing or silently
3779 * dropping the record in the case of an unknown type.
3780 *
3781 * Since with the use of CIDs, the record content type
3782 * might change during decryption, re-check the record
3783 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003784 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003785 {
3786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3787 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3788 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003789#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003790
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003791 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003792 {
3793#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3794 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003795 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003796 {
3797 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3799 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3800 }
3801#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3802
3803 ssl->nb_zero++;
3804
3805 /*
3806 * Three or more empty messages may be a DoS attack
3807 * (excessive CPU consumption).
3808 */
3809 if( ssl->nb_zero > 3 )
3810 {
3811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003812 "messages, possible DoS attack" ) );
3813 /* Treat the records as if they were not properly authenticated,
3814 * thereby failing the connection if we see more than allowed
3815 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003816 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3817 }
3818 }
3819 else
3820 ssl->nb_zero = 0;
3821
3822#if defined(MBEDTLS_SSL_PROTO_DTLS)
3823 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3824 {
3825 ; /* in_ctr read from peer, not maintained internally */
3826 }
3827 else
3828#endif
3829 {
3830 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003831 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003832 if( ++ssl->in_ctr[i - 1] != 0 )
3833 break;
3834
3835 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003836 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003837 {
3838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3839 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3840 }
3841 }
3842
Paul Bakker5121ce52009-01-03 21:22:43 +00003843 }
3844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003845#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003846 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003848 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003849 }
3850#endif
3851
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003852 /* Check actual (decrypted) record content length against
3853 * configured maximum. */
3854 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3855 {
3856 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3857 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3858 }
3859
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003860 return( 0 );
3861}
3862
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003863/*
3864 * Read a record.
3865 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003866 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3867 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3868 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003869 */
Hanno Becker1097b342018-08-15 14:09:41 +01003870
3871/* Helper functions for mbedtls_ssl_read_record(). */
3872static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003873static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3874static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003875
Hanno Becker327c93b2018-08-15 13:56:18 +01003876int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003877 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003878{
Janos Follath865b3eb2019-12-16 11:46:15 +00003879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003882
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003883 if( ssl->keep_current_message == 0 )
3884 {
3885 do {
Simon Butcher99000142016-10-13 17:21:01 +01003886
Hanno Becker26994592018-08-15 14:14:59 +01003887 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003888 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003889 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003890
Hanno Beckere74d5562018-08-15 14:26:08 +01003891 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003892 {
Hanno Becker40f50842018-08-15 14:48:01 +01003893#if defined(MBEDTLS_SSL_PROTO_DTLS)
3894 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003895
Hanno Becker40f50842018-08-15 14:48:01 +01003896 /* We only check for buffered messages if the
3897 * current datagram is fully consumed. */
3898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003899 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003900 {
Hanno Becker40f50842018-08-15 14:48:01 +01003901 if( ssl_load_buffered_message( ssl ) == 0 )
3902 have_buffered = 1;
3903 }
3904
3905 if( have_buffered == 0 )
3906#endif /* MBEDTLS_SSL_PROTO_DTLS */
3907 {
3908 ret = ssl_get_next_record( ssl );
3909 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3910 continue;
3911
3912 if( ret != 0 )
3913 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003914 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003915 return( ret );
3916 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003917 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003918 }
3919
3920 ret = mbedtls_ssl_handle_message_type( ssl );
3921
Hanno Becker40f50842018-08-15 14:48:01 +01003922#if defined(MBEDTLS_SSL_PROTO_DTLS)
3923 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3924 {
3925 /* Buffer future message */
3926 ret = ssl_buffer_message( ssl );
3927 if( ret != 0 )
3928 return( ret );
3929
3930 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3931 }
3932#endif /* MBEDTLS_SSL_PROTO_DTLS */
3933
Hanno Becker90333da2017-10-10 11:27:13 +01003934 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3935 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003936
3937 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003938 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003939 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003940 return( ret );
3941 }
3942
Hanno Becker327c93b2018-08-15 13:56:18 +01003943 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003944 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003945 {
3946 mbedtls_ssl_update_handshake_status( ssl );
3947 }
Simon Butcher99000142016-10-13 17:21:01 +01003948 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003949 else
Simon Butcher99000142016-10-13 17:21:01 +01003950 {
Hanno Becker02f59072018-08-15 14:00:24 +01003951 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003952 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003953 }
3954
3955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3956
3957 return( 0 );
3958}
3959
Hanno Becker40f50842018-08-15 14:48:01 +01003960#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003961static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003962{
Hanno Becker40f50842018-08-15 14:48:01 +01003963 if( ssl->in_left > ssl->next_record_offset )
3964 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003965
Hanno Becker40f50842018-08-15 14:48:01 +01003966 return( 0 );
3967}
3968
3969static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3970{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003971 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003972 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003973 int ret = 0;
3974
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003975 if( hs == NULL )
3976 return( -1 );
3977
Hanno Beckere00ae372018-08-20 09:39:42 +01003978 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3979
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003980 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3981 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3982 {
3983 /* Check if we have seen a ChangeCipherSpec before.
3984 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003985 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003986 {
3987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3988 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003989 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003990 }
3991
Hanno Becker39b8bc92018-08-28 17:17:13 +01003992 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003993 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3994 ssl->in_msglen = 1;
3995 ssl->in_msg[0] = 1;
3996
3997 /* As long as they are equal, the exact value doesn't matter. */
3998 ssl->in_left = 0;
3999 ssl->next_record_offset = 0;
4000
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004001 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004002 goto exit;
4003 }
Hanno Becker37f95322018-08-16 13:55:32 +01004004
Hanno Beckerb8f50142018-08-28 10:01:34 +01004005#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004006 /* Debug only */
4007 {
4008 unsigned offset;
4009 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4010 {
4011 hs_buf = &hs->buffering.hs[offset];
4012 if( hs_buf->is_valid == 1 )
4013 {
4014 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4015 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004016 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004017 }
4018 }
4019 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004020#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004021
4022 /* Check if we have buffered and/or fully reassembled the
4023 * next handshake message. */
4024 hs_buf = &hs->buffering.hs[0];
4025 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4026 {
4027 /* Synthesize a record containing the buffered HS message. */
4028 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4029 ( hs_buf->data[2] << 8 ) |
4030 hs_buf->data[3];
4031
4032 /* Double-check that we haven't accidentally buffered
4033 * a message that doesn't fit into the input buffer. */
4034 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4035 {
4036 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4037 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4038 }
4039
4040 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4041 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4042 hs_buf->data, msg_len + 12 );
4043
4044 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4045 ssl->in_hslen = msg_len + 12;
4046 ssl->in_msglen = msg_len + 12;
4047 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4048
4049 ret = 0;
4050 goto exit;
4051 }
4052 else
4053 {
4054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4055 hs->in_msg_seq ) );
4056 }
4057
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004058 ret = -1;
4059
4060exit:
4061
4062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4063 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004064}
4065
Hanno Beckera02b0b42018-08-21 17:20:27 +01004066static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4067 size_t desired )
4068{
4069 int offset;
4070 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4072 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004073
Hanno Becker01315ea2018-08-21 17:22:17 +01004074 /* Get rid of future records epoch first, if such exist. */
4075 ssl_free_buffered_record( ssl );
4076
4077 /* Check if we have enough space available now. */
4078 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4079 hs->buffering.total_bytes_buffered ) )
4080 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004082 return( 0 );
4083 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004084
Hanno Becker4f432ad2018-08-28 10:02:32 +01004085 /* We don't have enough space to buffer the next expected handshake
4086 * message. Remove buffers used for future messages to gain space,
4087 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004088 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4089 offset >= 0; offset-- )
4090 {
4091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4092 offset ) );
4093
Hanno Beckerb309b922018-08-23 13:18:05 +01004094 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004095
4096 /* Check if we have enough space available now. */
4097 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4098 hs->buffering.total_bytes_buffered ) )
4099 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004100 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004101 return( 0 );
4102 }
4103 }
4104
4105 return( -1 );
4106}
4107
Hanno Becker40f50842018-08-15 14:48:01 +01004108static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4109{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004110 int ret = 0;
4111 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4112
4113 if( hs == NULL )
4114 return( 0 );
4115
4116 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4117
4118 switch( ssl->in_msgtype )
4119 {
4120 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4121 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004122
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004123 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004124 break;
4125
4126 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004127 {
4128 unsigned recv_msg_seq_offset;
4129 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4130 mbedtls_ssl_hs_buffer *hs_buf;
4131 size_t msg_len = ssl->in_hslen - 12;
4132
4133 /* We should never receive an old handshake
4134 * message - double-check nonetheless. */
4135 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4136 {
4137 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4138 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4139 }
4140
4141 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4142 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4143 {
4144 /* Silently ignore -- message too far in the future */
4145 MBEDTLS_SSL_DEBUG_MSG( 2,
4146 ( "Ignore future HS message with sequence number %u, "
4147 "buffering window %u - %u",
4148 recv_msg_seq, ssl->handshake->in_msg_seq,
4149 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4150
4151 goto exit;
4152 }
4153
4154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4155 recv_msg_seq, recv_msg_seq_offset ) );
4156
4157 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4158
4159 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004160 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004161 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004162 size_t reassembly_buf_sz;
4163
Hanno Becker37f95322018-08-16 13:55:32 +01004164 hs_buf->is_fragmented =
4165 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4166
4167 /* We copy the message back into the input buffer
4168 * after reassembly, so check that it's not too large.
4169 * This is an implementation-specific limitation
4170 * and not one from the standard, hence it is not
4171 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004172 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004173 {
4174 /* Ignore message */
4175 goto exit;
4176 }
4177
Hanno Beckere0b150f2018-08-21 15:51:03 +01004178 /* Check if we have enough space to buffer the message. */
4179 if( hs->buffering.total_bytes_buffered >
4180 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4181 {
4182 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4183 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4184 }
4185
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004186 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4187 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004188
4189 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4190 hs->buffering.total_bytes_buffered ) )
4191 {
4192 if( recv_msg_seq_offset > 0 )
4193 {
4194 /* If we can't buffer a future message because
4195 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4197 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4198 " (already %" MBEDTLS_PRINTF_SIZET
4199 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004200 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004201 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004202 goto exit;
4203 }
Hanno Beckere1801392018-08-21 16:51:05 +01004204 else
4205 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004206 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4207 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4208 " (already %" MBEDTLS_PRINTF_SIZET
4209 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004210 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004211 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004212 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004213
Hanno Beckera02b0b42018-08-21 17:20:27 +01004214 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004215 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004216 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4217 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4218 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4219 " (already %" MBEDTLS_PRINTF_SIZET
4220 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004221 msg_len,
4222 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004223 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004224 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004225 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4226 goto exit;
4227 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004228 }
4229
Paul Elliottd48d5c62021-01-07 14:47:05 +00004230 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004231 msg_len ) );
4232
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004233 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4234 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004235 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004236 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004237 goto exit;
4238 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004239 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004240
4241 /* Prepare final header: copy msg_type, length and message_seq,
4242 * then add standardised fragment_offset and fragment_length */
4243 memcpy( hs_buf->data, ssl->in_msg, 6 );
4244 memset( hs_buf->data + 6, 0, 3 );
4245 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4246
4247 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004248
4249 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004250 }
4251 else
4252 {
4253 /* Make sure msg_type and length are consistent */
4254 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4255 {
4256 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4257 /* Ignore */
4258 goto exit;
4259 }
4260 }
4261
Hanno Becker4422bbb2018-08-20 09:40:19 +01004262 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004263 {
4264 size_t frag_len, frag_off;
4265 unsigned char * const msg = hs_buf->data + 12;
4266
4267 /*
4268 * Check and copy current fragment
4269 */
4270
4271 /* Validation of header fields already done in
4272 * mbedtls_ssl_prepare_handshake_record(). */
4273 frag_off = ssl_get_hs_frag_off( ssl );
4274 frag_len = ssl_get_hs_frag_len( ssl );
4275
Paul Elliottd48d5c62021-01-07 14:47:05 +00004276 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4277 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004278 frag_off, frag_len ) );
4279 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4280
4281 if( hs_buf->is_fragmented )
4282 {
4283 unsigned char * const bitmask = msg + msg_len;
4284 ssl_bitmask_set( bitmask, frag_off, frag_len );
4285 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4286 msg_len ) == 0 );
4287 }
4288 else
4289 {
4290 hs_buf->is_complete = 1;
4291 }
4292
4293 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4294 hs_buf->is_complete ? "" : "not yet " ) );
4295 }
4296
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004297 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004298 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004299
4300 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004301 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004302 break;
4303 }
4304
4305exit:
4306
4307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4308 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004309}
4310#endif /* MBEDTLS_SSL_PROTO_DTLS */
4311
Hanno Becker1097b342018-08-15 14:09:41 +01004312static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004313{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004314 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004315 * Consume last content-layer message and potentially
4316 * update in_msglen which keeps track of the contents'
4317 * consumption state.
4318 *
4319 * (1) Handshake messages:
4320 * Remove last handshake message, move content
4321 * and adapt in_msglen.
4322 *
4323 * (2) Alert messages:
4324 * Consume whole record content, in_msglen = 0.
4325 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004326 * (3) Change cipher spec:
4327 * Consume whole record content, in_msglen = 0.
4328 *
4329 * (4) Application data:
4330 * Don't do anything - the record layer provides
4331 * the application data as a stream transport
4332 * and consumes through mbedtls_ssl_read only.
4333 *
4334 */
4335
4336 /* Case (1): Handshake messages */
4337 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004338 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004339 /* Hard assertion to be sure that no application data
4340 * is in flight, as corrupting ssl->in_msglen during
4341 * ssl->in_offt != NULL is fatal. */
4342 if( ssl->in_offt != NULL )
4343 {
4344 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4345 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4346 }
4347
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004348 /*
4349 * Get next Handshake message in the current record
4350 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004351
Hanno Becker4a810fb2017-05-24 16:27:30 +01004352 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004353 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004354 * current handshake content: If DTLS handshake
4355 * fragmentation is used, that's the fragment
4356 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004357 * size here is faulty and should be changed at
4358 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004359 * (2) While it doesn't seem to cause problems, one
4360 * has to be very careful not to assume that in_hslen
4361 * is always <= in_msglen in a sensible communication.
4362 * Again, it's wrong for DTLS handshake fragmentation.
4363 * The following check is therefore mandatory, and
4364 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004365 * Additionally, ssl->in_hslen might be arbitrarily out of
4366 * bounds after handling a DTLS message with an unexpected
4367 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004368 */
4369 if( ssl->in_hslen < ssl->in_msglen )
4370 {
4371 ssl->in_msglen -= ssl->in_hslen;
4372 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4373 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004374
Hanno Becker4a810fb2017-05-24 16:27:30 +01004375 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4376 ssl->in_msg, ssl->in_msglen );
4377 }
4378 else
4379 {
4380 ssl->in_msglen = 0;
4381 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004382
Hanno Becker4a810fb2017-05-24 16:27:30 +01004383 ssl->in_hslen = 0;
4384 }
4385 /* Case (4): Application data */
4386 else if( ssl->in_offt != NULL )
4387 {
4388 return( 0 );
4389 }
4390 /* Everything else (CCS & Alerts) */
4391 else
4392 {
4393 ssl->in_msglen = 0;
4394 }
4395
Hanno Becker1097b342018-08-15 14:09:41 +01004396 return( 0 );
4397}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004398
Hanno Beckere74d5562018-08-15 14:26:08 +01004399static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4400{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004401 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004402 return( 1 );
4403
4404 return( 0 );
4405}
4406
Hanno Becker5f066e72018-08-16 14:56:31 +01004407#if defined(MBEDTLS_SSL_PROTO_DTLS)
4408
4409static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4410{
4411 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4412 if( hs == NULL )
4413 return;
4414
Hanno Becker01315ea2018-08-21 17:22:17 +01004415 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004416 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004417 hs->buffering.total_bytes_buffered -=
4418 hs->buffering.future_record.len;
4419
4420 mbedtls_free( hs->buffering.future_record.data );
4421 hs->buffering.future_record.data = NULL;
4422 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004423}
4424
4425static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4426{
4427 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4428 unsigned char * rec;
4429 size_t rec_len;
4430 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004431#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4432 size_t in_buf_len = ssl->in_buf_len;
4433#else
4434 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4435#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004436 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4437 return( 0 );
4438
4439 if( hs == NULL )
4440 return( 0 );
4441
Hanno Becker5f066e72018-08-16 14:56:31 +01004442 rec = hs->buffering.future_record.data;
4443 rec_len = hs->buffering.future_record.len;
4444 rec_epoch = hs->buffering.future_record.epoch;
4445
4446 if( rec == NULL )
4447 return( 0 );
4448
Hanno Becker4cb782d2018-08-20 11:19:05 +01004449 /* Only consider loading future records if the
4450 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004451 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004452 return( 0 );
4453
Hanno Becker5f066e72018-08-16 14:56:31 +01004454 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4455
4456 if( rec_epoch != ssl->in_epoch )
4457 {
4458 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4459 goto exit;
4460 }
4461
4462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4463
4464 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004465 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004466 {
4467 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4468 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4469 }
4470
4471 memcpy( ssl->in_hdr, rec, rec_len );
4472 ssl->in_left = rec_len;
4473 ssl->next_record_offset = 0;
4474
4475 ssl_free_buffered_record( ssl );
4476
4477exit:
4478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4479 return( 0 );
4480}
4481
Hanno Becker519f15d2019-07-11 12:43:20 +01004482static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4483 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004484{
4485 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004486
4487 /* Don't buffer future records outside handshakes. */
4488 if( hs == NULL )
4489 return( 0 );
4490
4491 /* Only buffer handshake records (we are only interested
4492 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004493 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004494 return( 0 );
4495
4496 /* Don't buffer more than one future epoch record. */
4497 if( hs->buffering.future_record.data != NULL )
4498 return( 0 );
4499
Hanno Becker01315ea2018-08-21 17:22:17 +01004500 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004501 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004502 hs->buffering.total_bytes_buffered ) )
4503 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4505 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4506 " (already %" MBEDTLS_PRINTF_SIZET
4507 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004508 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004509 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004510 return( 0 );
4511 }
4512
Hanno Becker5f066e72018-08-16 14:56:31 +01004513 /* Buffer record */
4514 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004515 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004516 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004517
4518 /* ssl_parse_record_header() only considers records
4519 * of the next epoch as candidates for buffering. */
4520 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004521 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004522
4523 hs->buffering.future_record.data =
4524 mbedtls_calloc( 1, hs->buffering.future_record.len );
4525 if( hs->buffering.future_record.data == NULL )
4526 {
4527 /* If we run out of RAM trying to buffer a
4528 * record from the next epoch, just ignore. */
4529 return( 0 );
4530 }
4531
Hanno Becker519f15d2019-07-11 12:43:20 +01004532 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004533
Hanno Becker519f15d2019-07-11 12:43:20 +01004534 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004535 return( 0 );
4536}
4537
4538#endif /* MBEDTLS_SSL_PROTO_DTLS */
4539
Hanno Beckere74d5562018-08-15 14:26:08 +01004540static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004541{
Janos Follath865b3eb2019-12-16 11:46:15 +00004542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004543 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004544
Hanno Becker5f066e72018-08-16 14:56:31 +01004545#if defined(MBEDTLS_SSL_PROTO_DTLS)
4546 /* We might have buffered a future record; if so,
4547 * and if the epoch matches now, load it.
4548 * On success, this call will set ssl->in_left to
4549 * the length of the buffered record, so that
4550 * the calls to ssl_fetch_input() below will
4551 * essentially be no-ops. */
4552 ret = ssl_load_buffered_record( ssl );
4553 if( ret != 0 )
4554 return( ret );
4555#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004556
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004557 /* Ensure that we have enough space available for the default form
4558 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4559 * with no space for CIDs counted in). */
4560 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4561 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004563 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004564 return( ret );
4565 }
4566
Hanno Beckere5e7e782019-07-11 12:29:35 +01004567 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4568 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004569 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004571 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004572 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004573 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4574 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004575 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004576 if( ret != 0 )
4577 return( ret );
4578
4579 /* Fall through to handling of unexpected records */
4580 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4581 }
4582
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004583 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4584 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004585#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004586 /* Reset in pointers to default state for TLS/DTLS records,
4587 * assuming no CID and no offset between record content and
4588 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004589 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004590
Hanno Becker7ae20e02019-07-12 08:33:49 +01004591 /* Setup internal message pointers from record structure. */
4592 ssl->in_msgtype = rec.type;
4593#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4594 ssl->in_len = ssl->in_cid + rec.cid_len;
4595#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4596 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4597 ssl->in_msglen = rec.data_len;
4598
Hanno Becker2fddd372019-07-10 14:37:41 +01004599 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004600 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004601 if( ret != 0 )
4602 return( ret );
4603#endif
4604
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004605 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004606 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004607
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4609 "(header)" ) );
4610 }
4611 else
4612 {
4613 /* Skip invalid record and the rest of the datagram */
4614 ssl->next_record_offset = 0;
4615 ssl->in_left = 0;
4616
4617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4618 "(header)" ) );
4619 }
4620
4621 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004622 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004623 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004624 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004625#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004626 {
4627 return( ret );
4628 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004629 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004632 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004633 {
Hanno Beckera8814792019-07-10 15:01:45 +01004634 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004635 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004636 if( ssl->next_record_offset < ssl->in_left )
4637 {
4638 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4639 }
4640 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004641 else
4642#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004643 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004644 /*
4645 * Fetch record contents from underlying transport.
4646 */
Hanno Beckera3175662019-07-11 12:50:29 +01004647 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004648 if( ret != 0 )
4649 {
4650 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4651 return( ret );
4652 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004653
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004654 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004655 }
4656
4657 /*
4658 * Decrypt record contents.
4659 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004660
Hanno Beckerfdf66042019-07-11 13:07:45 +01004661 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004663#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004664 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004665 {
4666 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004667 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004668 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004669 /* Except when waiting for Finished as a bad mac here
4670 * probably means something went wrong in the handshake
4671 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4672 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4673 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4674 {
4675#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4676 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4677 {
4678 mbedtls_ssl_send_alert_message( ssl,
4679 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4680 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4681 }
4682#endif
4683 return( ret );
4684 }
4685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004687 if( ssl->conf->badmac_limit != 0 &&
4688 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004689 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4691 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004692 }
4693#endif
4694
Hanno Becker4a810fb2017-05-24 16:27:30 +01004695 /* As above, invalid records cause
4696 * dismissal of the whole datagram. */
4697
4698 ssl->next_record_offset = 0;
4699 ssl->in_left = 0;
4700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004702 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004703 }
4704
4705 return( ret );
4706 }
4707 else
4708#endif
4709 {
4710 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4712 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 mbedtls_ssl_send_alert_message( ssl,
4715 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4716 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004717 }
4718#endif
4719 return( ret );
4720 }
4721 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004722
Hanno Becker44d89b22019-07-12 09:40:44 +01004723
4724 /* Reset in pointers to default state for TLS/DTLS records,
4725 * assuming no CID and no offset between record content and
4726 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004727 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004728#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4729 ssl->in_len = ssl->in_cid + rec.cid_len;
4730#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004731 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004732
Hanno Becker8685c822019-07-12 09:37:30 +01004733 /* The record content type may change during decryption,
4734 * so re-read it. */
4735 ssl->in_msgtype = rec.type;
4736 /* Also update the input buffer, because unfortunately
4737 * the server-side ssl_parse_client_hello() reparses the
4738 * record header when receiving a ClientHello initiating
4739 * a renegotiation. */
4740 ssl->in_hdr[0] = rec.type;
4741 ssl->in_msg = rec.buf + rec.data_offset;
4742 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004743 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004744
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004745#if defined(MBEDTLS_ZLIB_SUPPORT)
4746 if( ssl->transform_in != NULL &&
4747 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4748 {
4749 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4750 {
4751 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4752 return( ret );
4753 }
4754
4755 /* Check actual (decompress) record content length against
4756 * configured maximum. */
4757 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4758 {
4759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4760 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4761 }
4762 }
4763#endif /* MBEDTLS_ZLIB_SUPPORT */
4764
Simon Butcher99000142016-10-13 17:21:01 +01004765 return( 0 );
4766}
4767
4768int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4769{
Janos Follath865b3eb2019-12-16 11:46:15 +00004770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004771
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004772 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004773 * Handle particular types of records
4774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004776 {
Simon Butcher99000142016-10-13 17:21:01 +01004777 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4778 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004779 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004780 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004781 }
4782
Hanno Beckere678eaa2018-08-21 14:57:46 +01004783 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004784 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004785 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004786 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004788 ssl->in_msglen ) );
4789 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004790 }
4791
Hanno Beckere678eaa2018-08-21 14:57:46 +01004792 if( ssl->in_msg[0] != 1 )
4793 {
4794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4795 ssl->in_msg[0] ) );
4796 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4797 }
4798
4799#if defined(MBEDTLS_SSL_PROTO_DTLS)
4800 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4801 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4802 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4803 {
4804 if( ssl->handshake == NULL )
4805 {
4806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4807 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4808 }
4809
4810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4811 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4812 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004813#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004814 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004816 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004817 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004818 if( ssl->in_msglen != 2 )
4819 {
4820 /* Note: Standard allows for more than one 2 byte alert
4821 to be packed in a single message, but Mbed TLS doesn't
4822 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004823 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004824 ssl->in_msglen ) );
4825 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4826 }
4827
Paul Elliott9f352112020-12-09 14:55:45 +00004828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004829 ssl->in_msg[0], ssl->in_msg[1] ) );
4830
4831 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004832 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004834 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004835 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004837 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004838 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004839 }
4840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004841 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4842 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004843 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4845 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004846 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004847
4848#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4849 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4850 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4851 {
Hanno Becker90333da2017-10-10 11:27:13 +01004852 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004853 /* Will be handled when trying to parse ServerHello */
4854 return( 0 );
4855 }
4856#endif
4857
4858#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4859 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4860 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4861 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4862 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4863 {
4864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4865 /* Will be handled in mbedtls_ssl_parse_certificate() */
4866 return( 0 );
4867 }
4868#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4869
4870 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004871 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004872 }
4873
Hanno Beckerc76c6192017-06-06 10:03:17 +01004874#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004875 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004876 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004877 /* Drop unexpected ApplicationData records,
4878 * except at the beginning of renegotiations */
4879 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4880 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4881#if defined(MBEDTLS_SSL_RENEGOTIATION)
4882 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4883 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004884#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004885 )
4886 {
4887 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4888 return( MBEDTLS_ERR_SSL_NON_FATAL );
4889 }
4890
4891 if( ssl->handshake != NULL &&
4892 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4893 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004894 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004895 }
4896 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004897#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004898
Paul Bakker5121ce52009-01-03 21:22:43 +00004899 return( 0 );
4900}
4901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004902int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004903{
irwir6c0da642019-09-26 21:07:41 +03004904 return( mbedtls_ssl_send_alert_message( ssl,
4905 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4906 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004907}
4908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004909int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004910 unsigned char level,
4911 unsigned char message )
4912{
Janos Follath865b3eb2019-12-16 11:46:15 +00004913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004914
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004915 if( ssl == NULL || ssl->conf == NULL )
4916 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004919 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004922 ssl->out_msglen = 2;
4923 ssl->out_msg[0] = level;
4924 ssl->out_msg[1] = message;
4925
Hanno Becker67bc7c32018-08-06 11:33:50 +01004926 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004927 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004928 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004929 return( ret );
4930 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004932
4933 return( 0 );
4934}
4935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004936int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004937{
Janos Follath865b3eb2019-12-16 11:46:15 +00004938 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004942 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004943 ssl->out_msglen = 1;
4944 ssl->out_msg[0] = 1;
4945
Paul Bakker5121ce52009-01-03 21:22:43 +00004946 ssl->state++;
4947
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004948 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004949 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004950 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004951 return( ret );
4952 }
4953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004955
4956 return( 0 );
4957}
4958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004959int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004960{
Janos Follath865b3eb2019-12-16 11:46:15 +00004961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004964
Hanno Becker327c93b2018-08-15 13:56:18 +01004965 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004968 return( ret );
4969 }
4970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004971 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004972 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004974 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4975 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004976 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004977 }
4978
Hanno Beckere678eaa2018-08-21 14:57:46 +01004979 /* CCS records are only accepted if they have length 1 and content '1',
4980 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004981
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004982 /*
4983 * Switch to our negotiated transform and session parameters for inbound
4984 * data.
4985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004987 ssl->transform_in = ssl->transform_negotiate;
4988 ssl->session_in = ssl->session_negotiate;
4989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004991 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004992 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004993#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004994 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004995#endif
4996
4997 /* Increment epoch */
4998 if( ++ssl->in_epoch == 0 )
4999 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005000 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005001 /* This is highly unlikely to happen for legitimate reasons, so
5002 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005004 }
5005 }
5006 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005008 memset( ssl->in_ctr, 0, 8 );
5009
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005010 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005012#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5013 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005014 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005016 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005018 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5019 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005020 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005021 }
5022 }
5023#endif
5024
Paul Bakker5121ce52009-01-03 21:22:43 +00005025 ssl->state++;
5026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005028
5029 return( 0 );
5030}
5031
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005032/* Once ssl->out_hdr as the address of the beginning of the
5033 * next outgoing record is set, deduce the other pointers.
5034 *
5035 * Note: For TLS, we save the implicit record sequence number
5036 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5037 * and the caller has to make sure there's space for this.
5038 */
5039
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005040static size_t ssl_transform_get_explicit_iv_len(
5041 mbedtls_ssl_transform const *transform )
5042{
5043 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5044 return( 0 );
5045
5046 return( transform->ivlen - transform->fixed_ivlen );
5047}
5048
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005049void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5050 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005051{
5052#if defined(MBEDTLS_SSL_PROTO_DTLS)
5053 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5054 {
5055 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005056#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005057 ssl->out_cid = ssl->out_ctr + 8;
5058 ssl->out_len = ssl->out_cid;
5059 if( transform != NULL )
5060 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005061#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005062 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005063#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005064 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005065 }
5066 else
5067#endif
5068 {
5069 ssl->out_ctr = ssl->out_hdr - 8;
5070 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005071#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005072 ssl->out_cid = ssl->out_len;
5073#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005074 ssl->out_iv = ssl->out_hdr + 5;
5075 }
5076
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005077 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005078 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005079 if( transform != NULL )
5080 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005081}
5082
5083/* Once ssl->in_hdr as the address of the beginning of the
5084 * next incoming record is set, deduce the other pointers.
5085 *
5086 * Note: For TLS, we save the implicit record sequence number
5087 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5088 * and the caller has to make sure there's space for this.
5089 */
5090
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005091void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005092{
Hanno Becker79594fd2019-05-08 09:38:41 +01005093 /* This function sets the pointers to match the case
5094 * of unprotected TLS/DTLS records, with both ssl->in_iv
5095 * and ssl->in_msg pointing to the beginning of the record
5096 * content.
5097 *
5098 * When decrypting a protected record, ssl->in_msg
5099 * will be shifted to point to the beginning of the
5100 * record plaintext.
5101 */
5102
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005103#if defined(MBEDTLS_SSL_PROTO_DTLS)
5104 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5105 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005106 /* This sets the header pointers to match records
5107 * without CID. When we receive a record containing
5108 * a CID, the fields are shifted accordingly in
5109 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005110 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005111#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005112 ssl->in_cid = ssl->in_ctr + 8;
5113 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005114#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005115 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005116#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005117 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005118 }
5119 else
5120#endif
5121 {
5122 ssl->in_ctr = ssl->in_hdr - 8;
5123 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005124#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005125 ssl->in_cid = ssl->in_len;
5126#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005127 ssl->in_iv = ssl->in_hdr + 5;
5128 }
5129
Hanno Becker79594fd2019-05-08 09:38:41 +01005130 /* This will be adjusted at record decryption time. */
5131 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005132}
5133
Paul Bakker5121ce52009-01-03 21:22:43 +00005134/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005135 * Setup an SSL context
5136 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005137
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005138void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005139{
5140 /* Set the incoming and outgoing record pointers. */
5141#if defined(MBEDTLS_SSL_PROTO_DTLS)
5142 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5143 {
5144 ssl->out_hdr = ssl->out_buf;
5145 ssl->in_hdr = ssl->in_buf;
5146 }
5147 else
5148#endif /* MBEDTLS_SSL_PROTO_DTLS */
5149 {
5150 ssl->out_hdr = ssl->out_buf + 8;
5151 ssl->in_hdr = ssl->in_buf + 8;
5152 }
5153
5154 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005155 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5156 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005157}
5158
Paul Bakker5121ce52009-01-03 21:22:43 +00005159/*
5160 * SSL get accessors
5161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005162size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005163{
5164 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5165}
5166
Hanno Becker8b170a02017-10-10 11:51:19 +01005167int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5168{
5169 /*
5170 * Case A: We're currently holding back
5171 * a message for further processing.
5172 */
5173
5174 if( ssl->keep_current_message == 1 )
5175 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005176 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005177 return( 1 );
5178 }
5179
5180 /*
5181 * Case B: Further records are pending in the current datagram.
5182 */
5183
5184#if defined(MBEDTLS_SSL_PROTO_DTLS)
5185 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5186 ssl->in_left > ssl->next_record_offset )
5187 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005188 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005189 return( 1 );
5190 }
5191#endif /* MBEDTLS_SSL_PROTO_DTLS */
5192
5193 /*
5194 * Case C: A handshake message is being processed.
5195 */
5196
Hanno Becker8b170a02017-10-10 11:51:19 +01005197 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5198 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005199 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005200 return( 1 );
5201 }
5202
5203 /*
5204 * Case D: An application data message is being processed
5205 */
5206 if( ssl->in_offt != NULL )
5207 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005208 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005209 return( 1 );
5210 }
5211
5212 /*
5213 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005214 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005215 * we implement support for multiple alerts in single records.
5216 */
5217
5218 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5219 return( 0 );
5220}
5221
Paul Bakker43ca69c2011-01-15 17:35:19 +00005222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005223int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005224{
Hanno Becker3136ede2018-08-17 15:28:19 +01005225 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005226 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005227 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005228
Hanno Becker5903de42019-05-03 14:46:38 +01005229 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5230
Hanno Becker78640902018-08-13 16:35:15 +01005231 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005232 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005234#if defined(MBEDTLS_ZLIB_SUPPORT)
5235 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5236 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005237#endif
5238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005239 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005241 case MBEDTLS_MODE_GCM:
5242 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005243 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005244 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005245 transform_expansion = transform->minlen;
5246 break;
5247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005248 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005249
5250 block_size = mbedtls_cipher_get_block_size(
5251 &transform->cipher_ctx_enc );
5252
Hanno Becker3136ede2018-08-17 15:28:19 +01005253 /* Expansion due to the addition of the MAC. */
5254 transform_expansion += transform->maclen;
5255
5256 /* Expansion due to the addition of CBC padding;
5257 * Theoretically up to 256 bytes, but we never use
5258 * more than the block size of the underlying cipher. */
5259 transform_expansion += block_size;
5260
5261 /* For TLS 1.1 or higher, an explicit IV is added
5262 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005263#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5264 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005265 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005266#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005267
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005268 break;
5269
5270 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005272 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005273 }
5274
Hanno Beckera0e20d02019-05-15 14:03:01 +01005275#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005276 if( transform->out_cid_len != 0 )
5277 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005278#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005279
Hanno Becker5903de42019-05-03 14:46:38 +01005280 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005281}
5282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005283#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005284/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005285 * Check record counters and renegotiate if they're above the limit.
5286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005287static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005288{
Hanno Beckerdd772292020-02-05 10:38:31 +00005289 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005290 int in_ctr_cmp;
5291 int out_ctr_cmp;
5292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5294 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005295 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005296 {
5297 return( 0 );
5298 }
5299
Andres AG2196c7f2016-12-15 17:01:16 +00005300 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5301 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005302 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005303 ssl->conf->renego_period + ep_len, 8 - ep_len );
5304
5305 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005306 {
5307 return( 0 );
5308 }
5309
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005312}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005313#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005314
5315/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005316 * Receive application data decrypted from the SSL layer
5317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005319{
Janos Follath865b3eb2019-12-16 11:46:15 +00005320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005321 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005322
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005323 if( ssl == NULL || ssl->conf == NULL )
5324 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005326 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005328#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005329 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005330 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005332 return( ret );
5333
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005334 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005336 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005337 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005338 return( ret );
5339 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005340 }
5341#endif
5342
Hanno Becker4a810fb2017-05-24 16:27:30 +01005343 /*
5344 * Check if renegotiation is necessary and/or handshake is
5345 * in process. If yes, perform/continue, and fall through
5346 * if an unexpected packet is received while the client
5347 * is waiting for the ServerHello.
5348 *
5349 * (There is no equivalent to the last condition on
5350 * the server-side as it is not treated as within
5351 * a handshake while waiting for the ClientHello
5352 * after a renegotiation request.)
5353 */
5354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005356 ret = ssl_check_ctr_renegotiate( ssl );
5357 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5358 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005361 return( ret );
5362 }
5363#endif
5364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005365 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005366 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005368 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5369 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005370 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005372 return( ret );
5373 }
5374 }
5375
Hanno Beckere41158b2017-10-23 13:30:32 +01005376 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005377 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005378 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005379 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005380 if( ssl->f_get_timer != NULL &&
5381 ssl->f_get_timer( ssl->p_timer ) == -1 )
5382 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005383 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005384 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005385
Hanno Becker327c93b2018-08-15 13:56:18 +01005386 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005387 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005388 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5389 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005390
Hanno Becker4a810fb2017-05-24 16:27:30 +01005391 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5392 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005393 }
5394
5395 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005397 {
5398 /*
5399 * OpenSSL sends empty messages to randomize the IV
5400 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005401 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005404 return( 0 );
5405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005406 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005407 return( ret );
5408 }
5409 }
5410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005414
Hanno Becker4a810fb2017-05-24 16:27:30 +01005415 /*
5416 * - For client-side, expect SERVER_HELLO_REQUEST.
5417 * - For server-side, expect CLIENT_HELLO.
5418 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5419 */
5420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005421#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005422 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005424 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005425 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005427
5428 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005429#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005430 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005431 {
5432 continue;
5433 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005434#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005436 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005437#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005438
Hanno Becker4a810fb2017-05-24 16:27:30 +01005439#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005440 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005442 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005444
5445 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005447 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005448 {
5449 continue;
5450 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005451#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005453 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005454#endif /* MBEDTLS_SSL_SRV_C */
5455
Hanno Becker21df7f92017-10-17 11:03:26 +01005456#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005457 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005458 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5459 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5460 ssl->conf->allow_legacy_renegotiation ==
5461 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5462 {
5463 /*
5464 * Accept renegotiation request
5465 */
Paul Bakker48916f92012-09-16 19:57:18 +00005466
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005467 /* DTLS clients need to know renego is server-initiated */
5468#if defined(MBEDTLS_SSL_PROTO_DTLS)
5469 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5470 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5471 {
5472 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5473 }
5474#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005475 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005476 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5477 ret != 0 )
5478 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005479 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5480 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005481 return( ret );
5482 }
5483 }
5484 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005485#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005486 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005487 /*
5488 * Refuse renegotiation
5489 */
5490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005491 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493#if defined(MBEDTLS_SSL_PROTO_SSL3)
5494 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005495 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005496 /* SSLv3 does not have a "no_renegotiation" warning, so
5497 we send a fatal alert and abort the connection. */
5498 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5499 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5500 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005501 }
5502 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005503#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5504#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5505 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5506 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005507 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5509 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5510 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005511 {
5512 return( ret );
5513 }
Paul Bakker48916f92012-09-16 19:57:18 +00005514 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005515 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005516#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5517 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005518 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5520 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005521 }
Paul Bakker48916f92012-09-16 19:57:18 +00005522 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005523
Hanno Becker90333da2017-10-10 11:27:13 +01005524 /* At this point, we don't know whether the renegotiation has been
5525 * completed or not. The cases to consider are the following:
5526 * 1) The renegotiation is complete. In this case, no new record
5527 * has been read yet.
5528 * 2) The renegotiation is incomplete because the client received
5529 * an application data record while awaiting the ServerHello.
5530 * 3) The renegotiation is incomplete because the client received
5531 * a non-handshake, non-application data message while awaiting
5532 * the ServerHello.
5533 * In each of these case, looping will be the proper action:
5534 * - For 1), the next iteration will read a new record and check
5535 * if it's application data.
5536 * - For 2), the loop condition isn't satisfied as application data
5537 * is present, hence continue is the same as break
5538 * - For 3), the loop condition is satisfied and read_record
5539 * will re-deliver the message that was held back by the client
5540 * when expecting the ServerHello.
5541 */
5542 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005543 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005544#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005545 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005546 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005547 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005548 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005549 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005550 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005551 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005552 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005553 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005554 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005555 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005556 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005559 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5560 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005562 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005563 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005564 }
5565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005567 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005568 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5569 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005570 }
5571
5572 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005573
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005574 /* We're going to return something now, cancel timer,
5575 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005577 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005578
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005579#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005580 /* If we requested renego but received AppData, resend HelloRequest.
5581 * Do it now, after setting in_offt, to avoid taking this branch
5582 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005583#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005584 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005585 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005586 {
Hanno Becker786300f2020-02-05 10:46:40 +00005587 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005588 {
Hanno Becker786300f2020-02-05 10:46:40 +00005589 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5590 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005591 return( ret );
5592 }
5593 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005595#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005596 }
5597
5598 n = ( len < ssl->in_msglen )
5599 ? len : ssl->in_msglen;
5600
5601 memcpy( buf, ssl->in_offt, n );
5602 ssl->in_msglen -= n;
5603
gabor-mezei-arma3214132020-07-15 10:55:00 +02005604 /* Zeroising the plaintext buffer to erase unused application data
5605 from the memory. */
5606 mbedtls_platform_zeroize( ssl->in_offt, n );
5607
Paul Bakker5121ce52009-01-03 21:22:43 +00005608 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005609 {
5610 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005611 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005612 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005613 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005614 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005615 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005616 /* more data available */
5617 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005618 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005621
Paul Bakker23986e52011-04-24 08:57:21 +00005622 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005623}
5624
5625/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005626 * Send application data to be encrypted by the SSL layer, taking care of max
5627 * fragment length and buffer size.
5628 *
5629 * According to RFC 5246 Section 6.2.1:
5630 *
5631 * Zero-length fragments of Application data MAY be sent as they are
5632 * potentially useful as a traffic analysis countermeasure.
5633 *
5634 * Therefore, it is possible that the input message length is 0 and the
5635 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005636 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005637static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005638 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005639{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005640 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5641 const size_t max_len = (size_t) ret;
5642
5643 if( ret < 0 )
5644 {
5645 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5646 return( ret );
5647 }
5648
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005649 if( len > max_len )
5650 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005651#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005652 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005653 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005655 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5656 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005657 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005658 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005659 }
5660 else
5661#endif
5662 len = max_len;
5663 }
Paul Bakker887bd502011-06-08 13:10:54 +00005664
Paul Bakker5121ce52009-01-03 21:22:43 +00005665 if( ssl->out_left != 0 )
5666 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005667 /*
5668 * The user has previously tried to send the data and
5669 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5670 * written. In this case, we expect the high-level write function
5671 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005673 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005674 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005676 return( ret );
5677 }
5678 }
Paul Bakker887bd502011-06-08 13:10:54 +00005679 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005680 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005681 /*
5682 * The user is trying to send a message the first time, so we need to
5683 * copy the data into the internal buffers and setup the data structure
5684 * to keep track of partial writes
5685 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005686 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005688 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005689
Hanno Becker67bc7c32018-08-06 11:33:50 +01005690 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005693 return( ret );
5694 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005695 }
5696
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005697 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005698}
5699
5700/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005701 * Write application data, doing 1/n-1 splitting if necessary.
5702 *
5703 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005704 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005705 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005707#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005708static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005709 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005710{
Janos Follath865b3eb2019-12-16 11:46:15 +00005711 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005712
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005713 if( ssl->conf->cbc_record_splitting ==
5714 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005715 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005716 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5717 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5718 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005719 {
5720 return( ssl_write_real( ssl, buf, len ) );
5721 }
5722
5723 if( ssl->split_done == 0 )
5724 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005725 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005726 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005727 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005728 }
5729
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005730 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5731 return( ret );
5732 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005733
5734 return( ret + 1 );
5735}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005736#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005737
5738/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005739 * Write application data (public-facing wrapper)
5740 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005741int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005742{
Janos Follath865b3eb2019-12-16 11:46:15 +00005743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005744
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005746
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005747 if( ssl == NULL || ssl->conf == NULL )
5748 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5749
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005750#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005751 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5752 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005753 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005754 return( ret );
5755 }
5756#endif
5757
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005758 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005759 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005760 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005761 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005762 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005763 return( ret );
5764 }
5765 }
5766
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005767#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005768 ret = ssl_write_split( ssl, buf, len );
5769#else
5770 ret = ssl_write_real( ssl, buf, len );
5771#endif
5772
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005773 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005774
5775 return( ret );
5776}
5777
5778/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005779 * Notify the peer that the connection is being closed
5780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005781int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005782{
Janos Follath865b3eb2019-12-16 11:46:15 +00005783 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005784
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005785 if( ssl == NULL || ssl->conf == NULL )
5786 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005789
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005790 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005793 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005794 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5796 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5797 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005799 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005800 return( ret );
5801 }
5802 }
5803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005805
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005806 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005807}
5808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005810{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005811 if( transform == NULL )
5812 return;
5813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005814#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005815 deflateEnd( &transform->ctx_deflate );
5816 inflateEnd( &transform->ctx_inflate );
5817#endif
5818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005819 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5820 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005821
Hanno Beckerd56ed242018-01-03 15:32:51 +00005822#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823 mbedtls_md_free( &transform->md_ctx_enc );
5824 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005825#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005826
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005827 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005828}
5829
Hanno Becker0271f962018-08-16 13:23:47 +01005830#if defined(MBEDTLS_SSL_PROTO_DTLS)
5831
Hanno Becker533ab5f2020-02-05 10:49:13 +00005832void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005833{
5834 unsigned offset;
5835 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5836
5837 if( hs == NULL )
5838 return;
5839
Hanno Becker283f5ef2018-08-24 09:34:47 +01005840 ssl_free_buffered_record( ssl );
5841
Hanno Becker0271f962018-08-16 13:23:47 +01005842 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005843 ssl_buffering_free_slot( ssl, offset );
5844}
5845
5846static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5847 uint8_t slot )
5848{
5849 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5850 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005851
5852 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5853 return;
5854
Hanno Beckere605b192018-08-21 15:59:07 +01005855 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005856 {
Hanno Beckere605b192018-08-21 15:59:07 +01005857 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005858 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005859 mbedtls_free( hs_buf->data );
5860 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005861 }
5862}
5863
5864#endif /* MBEDTLS_SSL_PROTO_DTLS */
5865
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005866/*
5867 * Convert version numbers to/from wire format
5868 * and, for DTLS, to/from TLS equivalent.
5869 *
5870 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005871 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005872 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5873 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5874 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005875void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005876 unsigned char ver[2] )
5877{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005878#if defined(MBEDTLS_SSL_PROTO_DTLS)
5879 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005881 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005882 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5883
5884 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5885 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5886 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005887 else
5888#else
5889 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005890#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005891 {
5892 ver[0] = (unsigned char) major;
5893 ver[1] = (unsigned char) minor;
5894 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005895}
5896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005897void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005898 const unsigned char ver[2] )
5899{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005900#if defined(MBEDTLS_SSL_PROTO_DTLS)
5901 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005902 {
5903 *major = 255 - ver[0] + 2;
5904 *minor = 255 - ver[1] + 1;
5905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005906 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005907 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5908 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005909 else
5910#else
5911 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005912#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005913 {
5914 *major = ver[0];
5915 *minor = ver[1];
5916 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005917}
5918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005919#endif /* MBEDTLS_SSL_TLS_C */