blob: 7c478ca651b613a1cf84fcf94269aa4cc99633f5 [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 Mezeic0ae1cf2021-10-20 12:09:35 +020047#include "constant_time_internal.h"
Gabor Mezeie24dea82021-10-19 12:22:25 +020048#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Hanno Beckercd9dcda2018-08-28 17:18:56 +010061static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010062
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063/*
64 * Start a timer.
65 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020066 */
Hanno Becker0f57a652020-02-05 10:37:26 +000067void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020069 if( ssl->f_set_timer == NULL )
70 return;
71
72 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
73 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020074}
75
76/*
77 * Return -1 is timer is expired, 0 if it isn't.
78 */
Hanno Becker7876d122020-02-05 10:39:31 +000079int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020080{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020081 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020082 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020083
84 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 {
86 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020087 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020088 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
90 return( 0 );
91}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020092
Hanno Beckercfe45792019-07-03 16:13:00 +010093#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010094static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t len,
97 mbedtls_record *rec );
98
Hanno Beckercfe45792019-07-03 16:13:00 +010099int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
100 unsigned char *buf,
101 size_t buflen )
102{
Hanno Becker54229812019-07-12 14:40:00 +0100103 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
105 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
106
107 /* We don't support record checking in TLS because
108 * (a) there doesn't seem to be a usecase for it, and
109 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
110 * and we'd need to backup the transform here.
111 */
112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
113 {
114 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
115 goto exit;
116 }
117#if defined(MBEDTLS_SSL_PROTO_DTLS)
118 else
119 {
irwir734f0cf2019-09-26 21:03:24 +0300120 mbedtls_record rec;
121
Hanno Becker54229812019-07-12 14:40:00 +0100122 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
123 if( ret != 0 )
124 {
125 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
126 goto exit;
127 }
128
129 if( ssl->transform_in != NULL )
130 {
131 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
132 if( ret != 0 )
133 {
134 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
135 goto exit;
136 }
137 }
138 }
139#endif /* MBEDTLS_SSL_PROTO_DTLS */
140
141exit:
142 /* On success, we have decrypted the buffer in-place, so make
143 * sure we don't leak any plaintext data. */
144 mbedtls_platform_zeroize( buf, buflen );
145
146 /* For the purpose of this API, treat messages with unexpected CID
147 * as well as such from future epochs as unexpected. */
148 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
149 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
150 {
151 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
152 }
153
154 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
155 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100156}
157#endif /* MBEDTLS_SSL_RECORD_CHECKING */
158
Hanno Becker67bc7c32018-08-06 11:33:50 +0100159#define SSL_DONT_FORCE_FLUSH 0
160#define SSL_FORCE_FLUSH 1
161
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100163
Hanno Beckerd5847772018-08-28 10:09:23 +0100164/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100165static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
166 uint8_t slot );
167static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
168static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
170static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100171static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
172 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100173static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100174
Hanno Becker11682cc2018-08-22 14:41:02 +0100175static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176{
Hanno Becker89490712020-02-05 10:50:12 +0000177 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000178#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
179 size_t out_buf_len = ssl->out_buf_len;
180#else
181 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
182#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183
Darryl Greenb33cc762019-11-28 14:29:44 +0000184 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186
Darryl Greenb33cc762019-11-28 14:29:44 +0000187 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188}
189
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
191{
Hanno Becker11682cc2018-08-22 14:41:02 +0100192 size_t const bytes_written = ssl->out_left;
193 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194
195 /* Double-check that the write-index hasn't gone
196 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100197 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198 {
199 /* Should never happen... */
200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
201 }
202
203 return( (int) ( mtu - bytes_written ) );
204}
205
206static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
207{
Janos Follath865b3eb2019-12-16 11:46:15 +0000208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400210 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211
212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400213 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100214
215 if( max_len > mfl )
216 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100217
218 /* By the standard (RFC 6066 Sect. 4), the MFL extension
219 * only limits the maximum record payload size, so in theory
220 * we would be allowed to pack multiple records of payload size
221 * MFL into a single datagram. However, this would mean that there's
222 * no way to explicitly communicate MTU restrictions to the peer.
223 *
224 * The following reduction of max_len makes sure that we never
225 * write datagrams larger than MFL + Record Expansion Overhead.
226 */
227 if( max_len <= ssl->out_left )
228 return( 0 );
229
230 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100231#endif
232
233 ret = ssl_get_remaining_space_in_datagram( ssl );
234 if( ret < 0 )
235 return( ret );
236 remaining = (size_t) ret;
237
238 ret = mbedtls_ssl_get_record_expansion( ssl );
239 if( ret < 0 )
240 return( ret );
241 expansion = (size_t) ret;
242
243 if( remaining <= expansion )
244 return( 0 );
245
246 remaining -= expansion;
247 if( remaining >= max_len )
248 remaining = max_len;
249
250 return( (int) remaining );
251}
252
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253/*
254 * Double the retransmit timeout value, within the allowed range,
255 * returning -1 if the maximum value has already been reached.
256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200258{
259 uint32_t new_timeout;
260
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200261 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200262 return( -1 );
263
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
265 * in the following way: after the initial transmission and a first
266 * retransmission, back off to a temporary estimated MTU of 508 bytes.
267 * This value is guaranteed to be deliverable (if not guaranteed to be
268 * delivered) of any compliant IPv4 (and IPv6) network, and should work
269 * on most non-IP stacks too. */
270 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400271 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200272 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
274 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200275
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 new_timeout = 2 * ssl->handshake->retransmit_timeout;
277
278 /* Avoid arithmetic overflow and range overflow */
279 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200280 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200282 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283 }
284
285 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000286 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
287 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200288
289 return( 0 );
290}
291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200293{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200294 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
296 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200297}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
301int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200302 const unsigned char *key_enc, const unsigned char *key_dec,
303 size_t keylen,
304 const unsigned char *iv_enc, const unsigned char *iv_dec,
305 size_t ivlen,
306 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200307 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
309int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
310int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
313#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000314
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100315/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000316 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200317 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000318
Hanno Beckerccc13d02020-05-04 12:30:04 +0100319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
320 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100321
322static size_t ssl_compute_padding_length( size_t len,
323 size_t granularity )
324{
325 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
326}
327
Hanno Becker581bc1b2020-05-04 12:20:03 +0100328/* This functions transforms a (D)TLS plaintext fragment and a record content
329 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
330 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
331 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100332 *
333 * struct {
334 * opaque content[DTLSPlaintext.length];
335 * ContentType real_type;
336 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100337 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338 *
339 * Input:
340 * - `content`: The beginning of the buffer holding the
341 * plaintext to be wrapped.
342 * - `*content_size`: The length of the plaintext in Bytes.
343 * - `max_len`: The number of Bytes available starting from
344 * `content`. This must be `>= *content_size`.
345 * - `rec_type`: The desired record content type.
346 *
347 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100348 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
349 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100350 *
351 * Returns:
352 * - `0` on success.
353 * - A negative error code if `max_len` didn't offer enough space
354 * for the expansion.
355 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100356static int ssl_build_inner_plaintext( unsigned char *content,
357 size_t *content_size,
358 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100359 uint8_t rec_type,
360 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361{
362 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363
364 /* Write real content type */
365 if( remaining == 0 )
366 return( -1 );
367 content[ len ] = rec_type;
368 len++;
369 remaining--;
370
371 if( remaining < pad )
372 return( -1 );
373 memset( content + len, 0, pad );
374 len += pad;
375 remaining -= pad;
376
377 *content_size = len;
378 return( 0 );
379}
380
Hanno Becker581bc1b2020-05-04 12:20:03 +0100381/* This function parses a (D)TLSInnerPlaintext structure.
382 * See ssl_build_inner_plaintext() for details. */
383static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384 size_t *content_size,
385 uint8_t *rec_type )
386{
387 size_t remaining = *content_size;
388
389 /* Determine length of padding by skipping zeroes from the back. */
390 do
391 {
392 if( remaining == 0 )
393 return( -1 );
394 remaining--;
395 } while( content[ remaining ] == 0 );
396
397 *content_size = remaining;
398 *rec_type = content[ remaining ];
399
400 return( 0 );
401}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100402#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
403 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100404
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100406 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000407static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 mbedtls_record *rec,
410 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000411{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100412 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 *
414 * additional_data = seq_num + TLSCompressed.type +
415 * TLSCompressed.version + TLSCompressed.length;
416 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100417 * For the CID extension, this is extended as follows
418 * (quoting draft-ietf-tls-dtls-connection-id-05,
419 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 *
421 * additional_data = seq_num + DTLSPlaintext.type +
422 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100423 * cid +
424 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100425 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426 *
427 * For TLS 1.3, the record sequence number is dropped from the AAD
428 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100429 */
430
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100431 unsigned char *cur = add_data;
432
433#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
434 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
435#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
436 {
437 ((void) minor_ver);
438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
Joe Subbianic54e9082021-07-19 11:56:54 +0100457 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100458 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100459 }
460 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100462 {
Joe Subbianic54e9082021-07-19 11:56:54 +0100463 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100465 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100466
467 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000468}
469
Hanno Becker9d062f92020-02-07 10:26:36 +0000470#if defined(MBEDTLS_SSL_PROTO_SSL3)
471
472#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
473
474/*
475 * SSLv3.0 MAC functions
476 */
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100477static int ssl_mac( mbedtls_md_context_t *md_ctx,
478 const unsigned char *secret,
479 const unsigned char *buf, size_t len,
480 const unsigned char *ctr, int type,
481 unsigned char out[SSL3_MAC_MAX_BYTES] )
Hanno Becker9d062f92020-02-07 10:26:36 +0000482{
483 unsigned char header[11];
484 unsigned char padding[48];
485 int padlen;
486 int md_size = mbedtls_md_get_size( md_ctx->md_info );
487 int md_type = mbedtls_md_get_type( md_ctx->md_info );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100488 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9d062f92020-02-07 10:26:36 +0000489
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 );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100501 ret = mbedtls_md_starts( md_ctx );
502 if( ret != 0 )
503 return( ret );
504 ret = mbedtls_md_update( md_ctx, secret, md_size );
505 if( ret != 0 )
506 return( ret );
507 ret = mbedtls_md_update( md_ctx, padding, padlen );
508 if( ret != 0 )
509 return( ret );
510 ret = mbedtls_md_update( md_ctx, header, 11 );
511 if( ret != 0 )
512 return( ret );
513 ret = mbedtls_md_update( md_ctx, buf, len );
514 if( ret != 0 )
515 return( ret );
516 ret = mbedtls_md_finish( md_ctx, out );
517 if( ret != 0 )
518 return( ret );
Hanno Becker9d062f92020-02-07 10:26:36 +0000519
520 memset( padding, 0x5C, padlen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100521 ret = mbedtls_md_starts( md_ctx );
522 if( ret != 0 )
523 return( ret );
524 ret = mbedtls_md_update( md_ctx, secret, md_size );
525 if( ret != 0 )
526 return( ret );
527 ret = mbedtls_md_update( md_ctx, padding, padlen );
528 if( ret != 0 )
529 return( ret );
530 ret = mbedtls_md_update( md_ctx, out, md_size );
531 if( ret != 0 )
532 return( ret );
533 ret = mbedtls_md_finish( md_ctx, out );
534 if( ret != 0 )
535 return( ret );
536
537 return( 0 );
Hanno Becker9d062f92020-02-07 10:26:36 +0000538}
539#endif /* MBEDTLS_SSL_PROTO_SSL3 */
540
Hanno Becker67a37db2020-05-28 16:27:07 +0100541#if defined(MBEDTLS_GCM_C) || \
542 defined(MBEDTLS_CCM_C) || \
543 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100544static int ssl_transform_aead_dynamic_iv_is_explicit(
545 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100546{
Hanno Becker17263802020-05-28 07:05:48 +0100547 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100548}
549
Hanno Becker17263802020-05-28 07:05:48 +0100550/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
551 *
552 * Concretely, this occurs in two variants:
553 *
554 * a) Fixed and dynamic IV lengths add up to total IV length, giving
555 * IV = fixed_iv || dynamic_iv
556 *
Hanno Becker15952812020-06-04 13:31:46 +0100557 * This variant is used in TLS 1.2 when used with GCM or CCM.
558 *
Hanno Becker17263802020-05-28 07:05:48 +0100559 * b) Fixed IV lengths matches total IV length, giving
560 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100561 *
562 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
563 *
564 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100565 *
566 * This function has the precondition that
567 *
568 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
569 *
570 * which has to be ensured by the caller. If this precondition
571 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100572 */
573static void ssl_build_record_nonce( unsigned char *dst_iv,
574 size_t dst_iv_len,
575 unsigned char const *fixed_iv,
576 size_t fixed_iv_len,
577 unsigned char const *dynamic_iv,
578 size_t dynamic_iv_len )
579{
580 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100581
582 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100583 memset( dst_iv, 0, dst_iv_len );
584 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100585
Hanno Becker17263802020-05-28 07:05:48 +0100586 dst_iv += dst_iv_len - dynamic_iv_len;
587 for( i = 0; i < dynamic_iv_len; i++ )
588 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100589}
Hanno Becker67a37db2020-05-28 16:27:07 +0100590#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100591
Hanno Beckera18d1322018-01-03 14:27:32 +0000592int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
593 mbedtls_ssl_transform *transform,
594 mbedtls_record *rec,
595 int (*f_rng)(void *, unsigned char *, size_t),
596 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000597{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100599 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000600 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100601 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100602 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000603 size_t post_avail;
604
605 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000606#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200607 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000608 ((void) ssl);
609#endif
610
611 /* The PRNG is used for dynamic IV generation that's used
612 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200613#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000614 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
615 ((void) f_rng);
616 ((void) p_rng);
617#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000620
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000621 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100622 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000623 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
624 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
625 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100626 if( rec == NULL
627 || rec->buf == NULL
628 || rec->buf_len < rec->data_offset
629 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100630#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100631 || rec->cid_len != 0
632#endif
633 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000634 {
635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100637 }
638
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000639 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100640 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000642 data, rec->data_len );
643
644 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
645
646 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
647 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
649 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000650 rec->data_len,
651 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000652 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
653 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100654
Hanno Becker92313402020-05-20 13:58:58 +0100655 /* The following two code paths implement the (D)TLSInnerPlaintext
656 * structure present in TLS 1.3 and DTLS 1.2 + CID.
657 *
658 * See ssl_build_inner_plaintext() for more information.
659 *
660 * Note that this changes `rec->data_len`, and hence
661 * `post_avail` needs to be recalculated afterwards.
662 *
663 * Note also that the two code paths cannot occur simultaneously
664 * since they apply to different versions of the protocol. There
665 * is hence no risk of double-addition of the inner plaintext.
666 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100667#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
668 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
669 {
Hanno Becker13996922020-05-28 16:15:19 +0100670 size_t padding =
671 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100672 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100673 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100674 &rec->data_len,
675 post_avail,
676 rec->type,
677 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100678 {
679 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
680 }
681
682 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
683 }
684#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
685
Hanno Beckera0e20d02019-05-15 14:03:01 +0100686#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100687 /*
688 * Add CID information
689 */
690 rec->cid_len = transform->out_cid_len;
691 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
692 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100693
694 if( rec->cid_len != 0 )
695 {
Hanno Becker13996922020-05-28 16:15:19 +0100696 size_t padding =
697 ssl_compute_padding_length( rec->data_len,
698 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100699 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100700 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100701 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100702 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100703 * Note that this changes `rec->data_len`, and hence
704 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100705 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100706 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100707 &rec->data_len,
708 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100709 rec->type,
710 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100711 {
712 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
713 }
714
715 rec->type = MBEDTLS_SSL_MSG_CID;
716 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100717#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100718
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100719 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
720
Paul Bakker5121ce52009-01-03 21:22:43 +0000721 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100722 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000723 */
Hanno Becker52344c22018-01-03 15:24:20 +0000724#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 if( mode == MBEDTLS_MODE_STREAM ||
726 ( mode == MBEDTLS_MODE_CBC
727#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000728 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100729#endif
730 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000731 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000732 if( post_avail < transform->maclen )
733 {
734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
735 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
736 }
737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000739 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200740 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000741 unsigned char mac[SSL3_MAC_MAX_BYTES];
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
743 ret = ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
744 data, rec->data_len, rec->ctr, rec->type, mac );
745 if( ret == 0 )
746 memcpy( data + rec->data_len, mac, transform->maclen );
Gilles Peskined8e2e832021-12-10 21:33:21 +0100747 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100748 if( ret != 0 )
749 {
750 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_mac", ret );
751 return( ret );
752 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200753 }
754 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200755#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
757 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000758 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200759 {
Hanno Becker992b6872017-11-09 18:57:39 +0000760 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100761 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker992b6872017-11-09 18:57:39 +0000762
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100763 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
764 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000765
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100766 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
767 add_data, add_data_len );
768 if( ret != 0 )
769 goto hmac_failed_etm_disabled;
770 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
771 data, rec->data_len );
772 if( ret != 0 )
773 goto hmac_failed_etm_disabled;
774 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
775 if( ret != 0 )
776 goto hmac_failed_etm_disabled;
777 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
778 if( ret != 0 )
779 goto hmac_failed_etm_disabled;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780
781 memcpy( data + rec->data_len, mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100782
783 hmac_failed_etm_disabled:
Gilles Peskined8e2e832021-12-10 21:33:21 +0100784 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +0100785 if( ret != 0 )
786 {
787 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_md_hmac_xxx", ret );
788 return( ret );
789 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200790 }
791 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200792#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200793 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
795 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200796 }
797
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000798 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
799 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200800
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 rec->data_len += transform->maclen;
802 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100803 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200804 }
Hanno Becker52344c22018-01-03 15:24:20 +0000805#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000806
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200807 /*
808 * Encrypt
809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
811 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000812 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000815 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000816 "including %d bytes of padding",
817 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000818
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000819 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
820 transform->iv_enc, transform->ivlen,
821 data, rec->data_len,
822 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200823 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200825 return( ret );
826 }
827
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200829 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
831 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200832 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000833 }
Paul Bakker68884e32013-01-07 18:20:04 +0100834 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000836
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200837#if defined(MBEDTLS_GCM_C) || \
838 defined(MBEDTLS_CCM_C) || \
839 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200841 mode == MBEDTLS_MODE_CCM ||
842 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000843 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100846 unsigned char *dynamic_iv;
847 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100848 int dynamic_iv_is_explicit =
849 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000850
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100851 /* Check that there's space for the authentication tag. */
852 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 {
854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
855 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
856 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000857
Paul Bakker68884e32013-01-07 18:20:04 +0100858 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100859 * Build nonce for AEAD encryption.
860 *
861 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
862 * part of the IV is prepended to the ciphertext and
863 * can be chosen freely - in particular, it need not
864 * agree with the record sequence number.
865 * However, since ChaChaPoly as well as all AEAD modes
866 * in TLS 1.3 use the record sequence number as the
867 * dynamic part of the nonce, we uniformly use the
868 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100869 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100870 dynamic_iv = rec->ctr;
871 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200872
Hanno Becker17263802020-05-28 07:05:48 +0100873 ssl_build_record_nonce( iv, sizeof( iv ),
874 transform->iv_enc,
875 transform->fixed_ivlen,
876 dynamic_iv,
877 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100878
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100879 /*
880 * Build additional data for AEAD encryption.
881 * This depends on the TLS version.
882 */
883 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
884 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100885
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200886 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100887 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200888 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100889 dynamic_iv,
890 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000891 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100892 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000893 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200894 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000895 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000896
Paul Bakker68884e32013-01-07 18:20:04 +0100897 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200898 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200899 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000900
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100901 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100903 add_data, add_data_len,
904 data, rec->data_len, /* src */
905 data, rec->buf_len - (data - rec->buf), /* dst */
906 &rec->data_len,
907 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200908 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200910 return( ret );
911 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100913 data + rec->data_len - transform->taglen,
914 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100915 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100917
918 /*
919 * Prefix record content with dynamic IV in case it is explicit.
920 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100921 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100922 {
923 if( rec->data_offset < dynamic_iv_len )
924 {
925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
926 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
927 }
928
929 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
930 rec->data_offset -= dynamic_iv_len;
931 rec->data_len += dynamic_iv_len;
932 }
933
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100934 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000935 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000936 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100937#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200938#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000940 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000942 size_t padlen, i;
943 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 /* Currently we're always using minimal padding
946 * (up to 255 bytes would be allowed). */
947 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
948 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000949 padlen = 0;
950
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000951 /* Check there's enough space in the buffer for the padding. */
952 if( post_avail < padlen + 1 )
953 {
954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
955 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
956 }
957
Paul Bakker5121ce52009-01-03 21:22:43 +0000958 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000959 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000960
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000961 rec->data_len += padlen + 1;
962 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000965 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000966 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
967 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000968 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000970 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000971 if( f_rng == NULL )
972 {
973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
974 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
975 }
976
977 if( rec->data_offset < transform->ivlen )
978 {
979 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
980 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
981 }
982
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000983 /*
984 * Generate IV
985 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000986 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000987 if( ret != 0 )
988 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000989
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000990 memcpy( data - transform->ivlen, transform->iv_enc,
991 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000992
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000993 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000995
Paul Elliottd48d5c62021-01-07 14:47:05 +0000996 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
997 "including %" MBEDTLS_PRINTF_SIZET
998 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001000 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001001
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001002 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
1003 transform->iv_enc,
1004 transform->ivlen,
1005 data, rec->data_len,
1006 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001007 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001009 return( ret );
1010 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001011
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001013 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1015 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001016 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001019 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001020 {
1021 /*
1022 * Save IV in SSL3 and TLS1
1023 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001024 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
1025 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001027 else
Paul Bakkercca5b812013-08-31 17:40:26 +02001028#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001029 {
1030 data -= transform->ivlen;
1031 rec->data_offset -= transform->ivlen;
1032 rec->data_len += transform->ivlen;
1033 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001036 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001037 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001038 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1039
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001040 /*
1041 * MAC(MAC_write_key, seq_num +
1042 * TLSCipherText.type +
1043 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001044 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001045 * IV + // except for TLS 1.0
1046 * ENC(content + padding + padding_length));
1047 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001048
1049 if( post_avail < transform->maclen)
1050 {
1051 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1052 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1053 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001054
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001055 ssl_extract_add_data_from_record( add_data, &add_data_len,
1056 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001059 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001060 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001061
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001062 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
1063 add_data_len );
1064 if( ret != 0 )
1065 goto hmac_failed_etm_enabled;
1066 ret = mbedtls_md_hmac_update( &transform->md_ctx_enc,
1067 data, rec->data_len );
1068 if( ret != 0 )
1069 goto hmac_failed_etm_enabled;
1070 ret = mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1071 if( ret != 0 )
1072 goto hmac_failed_etm_enabled;
1073 ret = mbedtls_md_hmac_reset( &transform->md_ctx_enc );
1074 if( ret != 0 )
1075 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001076
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001077 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001078
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001079 rec->data_len += transform->maclen;
1080 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001081 auth_done++;
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001082
1083 hmac_failed_etm_enabled:
Gilles Peskined8e2e832021-12-10 21:33:21 +01001084 mbedtls_platform_zeroize( mac, transform->maclen );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001085 if( ret != 0 )
1086 {
1087 MBEDTLS_SSL_DEBUG_RET( 1, "HMAC calculation failed", ret );
1088 return( ret );
1089 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001090 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001092 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001093 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001094#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001095 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1097 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001098 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001099
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001100 /* Make extra sure authentication was performed, exactly once */
1101 if( auth_done != 1 )
1102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001105 }
1106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001108
1109 return( 0 );
1110}
1111
Hanno Becker605949f2019-07-12 08:23:59 +01001112int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001113 mbedtls_ssl_transform *transform,
1114 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001115{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001116 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001118 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001119#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001120 size_t padlen = 0, correct = 1;
1121#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001122 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001123 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001124 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001125
Hanno Beckera18d1322018-01-03 14:27:32 +00001126#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001127 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001128 ((void) ssl);
1129#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001132 if( rec == NULL ||
1133 rec->buf == NULL ||
1134 rec->buf_len < rec->data_offset ||
1135 rec->buf_len - rec->data_offset < rec->data_len )
1136 {
1137 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001139 }
1140
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001141 data = rec->buf + rec->data_offset;
1142 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001143
Hanno Beckera0e20d02019-05-15 14:03:01 +01001144#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001145 /*
1146 * Match record's CID with incoming CID.
1147 */
Hanno Becker938489a2019-05-08 13:02:22 +01001148 if( rec->cid_len != transform->in_cid_len ||
1149 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1150 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001151 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001152 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001153#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1156 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001157 {
1158 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001159 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1160 transform->iv_dec,
1161 transform->ivlen,
1162 data, rec->data_len,
1163 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001164 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001166 return( ret );
1167 }
1168
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001169 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001170 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1172 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001173 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001174 }
Paul Bakker68884e32013-01-07 18:20:04 +01001175 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001177#if defined(MBEDTLS_GCM_C) || \
1178 defined(MBEDTLS_CCM_C) || \
1179 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001181 mode == MBEDTLS_MODE_CCM ||
1182 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001183 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001184 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001185 unsigned char *dynamic_iv;
1186 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001187
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001188 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001189 * Extract dynamic part of nonce for AEAD decryption.
1190 *
1191 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1192 * part of the IV is prepended to the ciphertext and
1193 * can be chosen freely - in particular, it need not
1194 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001195 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001196 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001197 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001198 {
1199 if( rec->data_len < dynamic_iv_len )
1200 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1202 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001203 rec->data_len,
1204 dynamic_iv_len ) );
1205 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1206 }
1207 dynamic_iv = data;
1208
1209 data += dynamic_iv_len;
1210 rec->data_offset += dynamic_iv_len;
1211 rec->data_len -= dynamic_iv_len;
1212 }
Hanno Becker17263802020-05-28 07:05:48 +01001213 else
1214 {
1215 dynamic_iv = rec->ctr;
1216 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001217
1218 /* Check that there's space for the authentication tag. */
1219 if( rec->data_len < transform->taglen )
1220 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1222 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001223 rec->data_len,
1224 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001226 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001227 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001228
Hanno Beckerdf8be222020-05-21 15:30:57 +01001229 /*
1230 * Prepare nonce from dynamic and static parts.
1231 */
Hanno Becker17263802020-05-28 07:05:48 +01001232 ssl_build_record_nonce( iv, sizeof( iv ),
1233 transform->iv_dec,
1234 transform->fixed_ivlen,
1235 dynamic_iv,
1236 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001237
Hanno Beckerdf8be222020-05-21 15:30:57 +01001238 /*
1239 * Build additional data for AEAD encryption.
1240 * This depends on the TLS version.
1241 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001242 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1243 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001244 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001245 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001246
Hanno Beckerd96a6522019-07-10 13:55:25 +01001247 /* Because of the check above, we know that there are
Shaun Case0e7791f2021-12-20 21:14:10 -08001248 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001249 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001250 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001251 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001252
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001253 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001254 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001255 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001256
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001257 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001258 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001259 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001260 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001261 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001262 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001263 data, rec->data_len + transform->taglen, /* src */
1264 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001265 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001266 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1270 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001271
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001272 return( ret );
1273 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001274 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001275
Hanno Beckerd96a6522019-07-10 13:55:25 +01001276 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001277 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001278 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1280 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001281 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001282 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001283 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001285#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001287 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001288 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001289
Paul Bakker5121ce52009-01-03 21:22:43 +00001290 /*
Paul Bakker45829992013-01-03 14:52:21 +01001291 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1295 {
1296 /* The ciphertext is prefixed with the CBC IV. */
1297 minlen += transform->ivlen;
1298 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001299#endif
Paul Bakker45829992013-01-03 14:52:21 +01001300
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001301 /* Size considerations:
1302 *
1303 * - The CBC cipher text must not be empty and hence
1304 * at least of size transform->ivlen.
1305 *
1306 * Together with the potential IV-prefix, this explains
1307 * the first of the two checks below.
1308 *
1309 * - The record must contain a MAC, either in plain or
1310 * encrypted, depending on whether Encrypt-then-MAC
1311 * is used or not.
1312 * - If it is, the message contains the IV-prefix,
1313 * the CBC ciphertext, and the MAC.
1314 * - If it is not, the padded plaintext, and hence
1315 * the CBC ciphertext, has at least length maclen + 1
1316 * because there is at least the padding length byte.
1317 *
1318 * As the CBC ciphertext is not empty, both cases give the
1319 * lower bound minlen + maclen + 1 on the record size, which
1320 * we test for in the second check below.
1321 */
1322 if( rec->data_len < minlen + transform->ivlen ||
1323 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001324 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001325 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1326 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1327 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001328 "+ 1 ) ( + expl IV )", rec->data_len,
1329 transform->ivlen,
1330 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001332 }
1333
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001334 /*
1335 * Authenticate before decrypt if enabled
1336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001339 {
Hanno Becker992b6872017-11-09 18:57:39 +00001340 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001341
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001342 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001343
Hanno Beckerd96a6522019-07-10 13:55:25 +01001344 /* Update data_len in tandem with add_data.
1345 *
1346 * The subtraction is safe because of the previous check
1347 * data_len >= minlen + maclen + 1.
1348 *
1349 * Afterwards, we know that data + data_len is followed by at
1350 * least maclen Bytes, which justifies the call to
Gabor Mezei18a44942021-10-20 11:59:27 +02001351 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001352 *
1353 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001355 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1356 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001357
Hanno Beckerd96a6522019-07-10 13:55:25 +01001358 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001359 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1360 add_data_len );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001361 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1362 add_data_len );
1363 if( ret != 0 )
1364 goto hmac_failed_etm_enabled;
1365 ret = mbedtls_md_hmac_update( &transform->md_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 data, rec->data_len );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001367 if( ret != 0 )
1368 goto hmac_failed_etm_enabled;
1369 ret = mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1370 if( ret != 0 )
1371 goto hmac_failed_etm_enabled;
1372 ret = mbedtls_md_hmac_reset( &transform->md_ctx_dec );
1373 if( ret != 0 )
1374 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001375
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001376 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1377 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001378 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001379 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001380
Hanno Beckerd96a6522019-07-10 13:55:25 +01001381 /* Compare expected MAC with MAC at the end of the record. */
Gabor Mezei18a44942021-10-20 11:59:27 +02001382 if( mbedtls_ct_memcmp( data + rec->data_len, mac_expect,
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +02001383 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001386 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1387 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001389 auth_done++;
Gilles Peskined8e2e832021-12-10 21:33:21 +01001390
1391 hmac_failed_etm_enabled:
1392 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1393 if( ret != 0 )
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001394 {
1395 if( ret != MBEDTLS_ERR_SSL_INVALID_MAC )
1396 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_hmac_xxx", ret );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001397 return( ret );
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001398 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001399 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001401
1402 /*
1403 * Check length sanity
1404 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001405
1406 /* We know from above that data_len > minlen >= 0,
1407 * so the following check in particular implies that
1408 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001409 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001410 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1412 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001415 }
1416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001418 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001419 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001420 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001421 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001422 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001423 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001425
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 data += transform->ivlen;
1427 rec->data_offset += transform->ivlen;
1428 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001429 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001431
Hanno Beckerd96a6522019-07-10 13:55:25 +01001432 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1433
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001434 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1435 transform->iv_dec, transform->ivlen,
1436 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001437 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001439 return( ret );
1440 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001441
Hanno Beckerd96a6522019-07-10 13:55:25 +01001442 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001443 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001444 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001445 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1446 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001447 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001451 {
1452 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001453 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1454 * records is equivalent to CBC decryption of the concatenation
1455 * of the records; in other words, IVs are maintained across
1456 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001457 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1459 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001460 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001461#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001462
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001463 /* Safe since data_len >= minlen + maclen + 1, so after having
1464 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001465 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1466 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001467 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001468
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001469 if( auth_done == 1 )
1470 {
Gabor Mezei18a44942021-10-20 11:59:27 +02001471 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001472 rec->data_len,
1473 padlen + 1 );
1474 correct &= mask;
1475 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001476 }
1477 else
Paul Bakker45829992013-01-03 14:52:21 +01001478 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001480 if( rec->data_len < transform->maclen + padlen + 1 )
1481 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1483 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1484 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001485 rec->data_len,
1486 transform->maclen,
1487 padlen + 1 ) );
1488 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001489#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001490
Gabor Mezei18a44942021-10-20 11:59:27 +02001491 const size_t mask = mbedtls_ct_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001492 rec->data_len,
1493 transform->maclen + padlen + 1 );
1494 correct &= mask;
1495 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001496 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001497
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 padlen++;
1499
1500 /* Regardless of the validity of the padding,
1501 * we have data_len >= padlen here. */
1502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001504 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001505 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001506 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1507 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001508 * the protocol (known as part of POODLE), so we don't care if the
1509 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001510 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001511 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1514 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001515 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001516#endif
Paul Bakker45829992013-01-03 14:52:21 +01001517 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001518 }
1519 }
1520 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1522#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1523 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001524 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001525 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001526 /* The padding check involves a series of up to 256
1527 * consecutive memory reads at the end of the record
1528 * plaintext buffer. In order to hide the length and
1529 * validity of the padding, always perform exactly
1530 * `min(256,plaintext_len)` reads (but take into account
1531 * only the last `padlen` bytes for the padding check). */
1532 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001533 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001534
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 /* Index of first padding byte; it has been ensured above
1536 * that the subtraction is safe. */
1537 size_t const padding_idx = rec->data_len - padlen;
1538 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1539 size_t const start_idx = rec->data_len - num_checks;
1540 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001541
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001543 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001544 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001545 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001546 */
Gabor Mezei18a44942021-10-20 11:59:27 +02001547 const size_t mask = mbedtls_ct_size_mask_ge( idx, padding_idx );
1548 const size_t equal = mbedtls_ct_size_bool_eq( check[idx],
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001549 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001550 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001551 }
Gabor Mezei18a44942021-10-20 11:59:27 +02001552 correct &= mbedtls_ct_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001553
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001555 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001557#endif
Gabor Mezei18a44942021-10-20 11:59:27 +02001558 padlen &= mbedtls_ct_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001559 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001560 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1562 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1565 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001566 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001567
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001568 /* If the padding was found to be invalid, padlen == 0
1569 * and the subtraction is safe. If the padding was found valid,
1570 * padlen hasn't been changed and the previous assertion
1571 * data_len >= padlen still holds. */
1572 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001573 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001574 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001575#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001576 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1578 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001579 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001580
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001581#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001583 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001584#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001585
1586 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001587 * Authenticate if not done yet.
1588 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001589 */
Hanno Becker52344c22018-01-03 15:24:20 +00001590#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001591 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001592 {
Paul Elliottb8300282022-05-19 18:31:35 +01001593 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1594 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001595
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001596 /* If the initial value of padlen was such that
1597 * data_len < maclen + padlen + 1, then padlen
1598 * got reset to 1, and the initial check
1599 * data_len >= minlen + maclen + 1
1600 * guarantees that at this point we still
1601 * have at least data_len >= maclen.
1602 *
1603 * If the initial value of padlen was such that
1604 * data_len >= maclen + padlen + 1, then we have
1605 * subtracted either padlen + 1 (if the padding was correct)
1606 * or 0 (if the padding was incorrect) since then,
1607 * hence data_len >= maclen in any case.
1608 */
1609 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001610 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1611 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001614 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001615 {
Gilles Peskine2b3f21d2021-12-10 21:35:10 +01001616 ret = ssl_mac( &transform->md_ctx_dec,
1617 transform->mac_dec,
1618 data, rec->data_len,
1619 rec->ctr, rec->type,
1620 mac_expect );
1621 if( ret != 0 )
1622 {
1623 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_mac", ret );
1624 goto hmac_failed_etm_disabled;
1625 }
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001626 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001627 }
1628 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1630#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1631 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001633 {
1634 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001635 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001636 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001637 *
1638 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001639 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001640 *
1641 * Note that max_len + maclen is never more than the buffer
1642 * length, as we previously did in_msglen -= maclen too.
1643 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001644 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001645 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1646
Gabor Mezei18a44942021-10-20 11:59:27 +02001647 ret = mbedtls_ct_hmac( &transform->md_ctx_dec,
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001648 add_data, add_data_len,
1649 data, rec->data_len, min_len, max_len,
1650 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001651 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001652 {
Gabor Mezei2dcccbf2021-11-16 13:34:05 +01001653 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ct_hmac", ret );
Gilles Peskined8e2e832021-12-10 21:33:21 +01001654 goto hmac_failed_etm_disabled;
Gilles Peskine20b44082018-05-29 14:06:49 +02001655 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001656
Gabor Mezei18a44942021-10-20 11:59:27 +02001657 mbedtls_ct_memcpy_offset( mac_peer, data,
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001658 rec->data_len,
1659 min_len, max_len,
1660 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001661 }
1662 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1664 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1667 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001668 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001669
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001670#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001671 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001672 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001673#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
Gabor Mezei18a44942021-10-20 11:59:27 +02001675 if( mbedtls_ct_memcmp( mac_peer, mac_expect,
gabor-mezei-arm378e7eb2021-07-19 15:19:19 +02001676 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001677 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#if defined(MBEDTLS_SSL_DEBUG_ALL)
1679 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001680#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001681 correct = 0;
1682 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001683 auth_done++;
Gilles Peskined8e2e832021-12-10 21:33:21 +01001684
1685 hmac_failed_etm_disabled:
1686 mbedtls_platform_zeroize( mac_peer, transform->maclen );
1687 mbedtls_platform_zeroize( mac_expect, transform->maclen );
1688 if( ret != 0 )
1689 return( ret );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001690 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001691
1692 /*
1693 * Finally check the correct flag
1694 */
1695 if( correct == 0 )
1696 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001697#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001698
1699 /* Make extra sure authentication was performed, exactly once */
1700 if( auth_done != 1 )
1701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1703 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001704 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001705
Hanno Beckerccc13d02020-05-04 12:30:04 +01001706#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1707 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1708 {
1709 /* Remove inner padding and infer true content type. */
1710 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1711 &rec->type );
1712
1713 if( ret != 0 )
1714 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1715 }
1716#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1717
Hanno Beckera0e20d02019-05-15 14:03:01 +01001718#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001719 if( rec->cid_len != 0 )
1720 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001721 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1722 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001723 if( ret != 0 )
1724 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1725 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001726#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
1730 return( 0 );
1731}
1732
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001733#undef MAC_NONE
1734#undef MAC_PLAINTEXT
1735#undef MAC_CIPHERTEXT
1736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001738/*
1739 * Compression/decompression functions
1740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001742{
Janos Follath865b3eb2019-12-16 11:46:15 +00001743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001744 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001745 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001746 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001747 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1749 size_t out_buf_len = ssl->out_buf_len;
1750#else
1751 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1752#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001755
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001756 if( len_pre == 0 )
1757 return( 0 );
1758
Paul Bakker2770fbd2012-07-03 13:30:23 +00001759 memcpy( msg_pre, ssl->out_msg, len_pre );
1760
Paul Elliottd48d5c62021-01-07 14:47:05 +00001761 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001762 ssl->out_msglen ) );
1763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001765 ssl->out_msg, ssl->out_msglen );
1766
Paul Bakker48916f92012-09-16 19:57:18 +00001767 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1768 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1769 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001770 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001771
Paul Bakker48916f92012-09-16 19:57:18 +00001772 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001773 if( ret != Z_OK )
1774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1776 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001777 }
1778
Darryl Greenb33cc762019-11-28 14:29:44 +00001779 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001780 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001781
Paul Elliottd48d5c62021-01-07 14:47:05 +00001782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783 ssl->out_msglen ) );
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786 ssl->out_msg, ssl->out_msglen );
1787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001789
1790 return( 0 );
1791}
1792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794{
Janos Follath865b3eb2019-12-16 11:46:15 +00001795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001796 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001797 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001799 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001800#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1801 size_t in_buf_len = ssl->in_buf_len;
1802#else
1803 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1804#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001807
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001808 if( len_pre == 0 )
1809 return( 0 );
1810
Paul Bakker2770fbd2012-07-03 13:30:23 +00001811 memcpy( msg_pre, ssl->in_msg, len_pre );
1812
Paul Elliottd48d5c62021-01-07 14:47:05 +00001813 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814 ssl->in_msglen ) );
1815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001817 ssl->in_msg, ssl->in_msglen );
1818
Paul Bakker48916f92012-09-16 19:57:18 +00001819 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1820 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1821 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001822 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001823
Paul Bakker48916f92012-09-16 19:57:18 +00001824 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001825 if( ret != Z_OK )
1826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1828 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829 }
1830
Darryl Greenb33cc762019-11-28 14:29:44 +00001831 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001832 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001833
Paul Elliottd48d5c62021-01-07 14:47:05 +00001834 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835 ssl->in_msglen ) );
1836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838 ssl->in_msg, ssl->in_msglen );
1839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001841
1842 return( 0 );
1843}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001845
Paul Bakker5121ce52009-01-03 21:22:43 +00001846/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001847 * Fill the input message buffer by appending data to it.
1848 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001849 *
1850 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1851 * available (from this read and/or a previous one). Otherwise, an error code
1852 * is returned (possibly EOF or WANT_READ).
1853 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001854 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1855 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1856 * since we always read a whole datagram at once.
1857 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001858 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001859 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001862{
Janos Follath865b3eb2019-12-16 11:46:15 +00001863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001864 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001865#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1866 size_t in_buf_len = ssl->in_buf_len;
1867#else
1868 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1869#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001872
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001873 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001876 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001878 }
1879
Darryl Greenb33cc762019-11-28 14:29:44 +00001880 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001884 }
1885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001887 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001888 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001889 uint32_t timeout;
1890
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001891 /*
1892 * The point is, we need to always read a full datagram at once, so we
1893 * sometimes read more then requested, and handle the additional data.
1894 * It could be the rest of the current record (while fetching the
1895 * header) and/or some other records in the same datagram.
1896 */
1897
1898 /*
1899 * Move to the next record in the already read datagram if applicable
1900 */
1901 if( ssl->next_record_offset != 0 )
1902 {
1903 if( ssl->in_left < ssl->next_record_offset )
1904 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1906 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001907 }
1908
1909 ssl->in_left -= ssl->next_record_offset;
1910
1911 if( ssl->in_left != 0 )
1912 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1914 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001915 ssl->next_record_offset ) );
1916 memmove( ssl->in_hdr,
1917 ssl->in_hdr + ssl->next_record_offset,
1918 ssl->in_left );
1919 }
1920
1921 ssl->next_record_offset = 0;
1922 }
1923
Paul Elliottd48d5c62021-01-07 14:47:05 +00001924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1925 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001926 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001927
1928 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001929 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001930 */
1931 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001932 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001934 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001935 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001936
1937 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001938 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001939 * are not at the beginning of a new record, the caller did something
1940 * wrong.
1941 */
1942 if( ssl->in_left != 0 )
1943 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001944 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1945 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001946 }
1947
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001948 /*
1949 * Don't even try to read if time's out already.
1950 * This avoids by-passing the timer when repeatedly receiving messages
1951 * that will end up being dropped.
1952 */
Hanno Becker7876d122020-02-05 10:39:31 +00001953 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001954 {
1955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001956 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001957 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001958 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001959 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001960 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963 timeout = ssl->handshake->retransmit_timeout;
1964 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001965 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001966
Paul Elliott9f352112020-12-09 14:55:45 +00001967 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001968
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001969 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001970 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1971 timeout );
1972 else
1973 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001976
1977 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001979 }
1980
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001981 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001982 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001984 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001987 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001988 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1989 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001991 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001992 }
1993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001997 return( ret );
1998 }
1999
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002000 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002001 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002003 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002005 {
Hanno Becker786300f2020-02-05 10:46:40 +00002006 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002007 {
Hanno Becker786300f2020-02-05 10:46:40 +00002008 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2009 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002010 return( ret );
2011 }
2012
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002013 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002014 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002016 }
2017
Paul Bakker5121ce52009-01-03 21:22:43 +00002018 if( ret < 0 )
2019 return( ret );
2020
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002021 ssl->in_left = ret;
2022 }
2023 else
2024#endif
2025 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002026 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2027 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002028 ssl->in_left, nb_want ) );
2029
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002030 while( ssl->in_left < nb_want )
2031 {
2032 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002033
Hanno Becker7876d122020-02-05 10:39:31 +00002034 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002035 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2036 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002037 {
2038 if( ssl->f_recv_timeout != NULL )
2039 {
2040 ret = ssl->f_recv_timeout( ssl->p_bio,
2041 ssl->in_hdr + ssl->in_left, len,
2042 ssl->conf->read_timeout );
2043 }
2044 else
2045 {
2046 ret = ssl->f_recv( ssl->p_bio,
2047 ssl->in_hdr + ssl->in_left, len );
2048 }
2049 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002050
Paul Elliottd48d5c62021-01-07 14:47:05 +00002051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2052 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002053 ssl->in_left, nb_want ) );
2054 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
2056 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002058
2059 if( ret < 0 )
2060 return( ret );
2061
makise-homuraaf9513b2020-08-24 18:26:27 +03002062 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002063 {
Darryl Green11999bb2018-03-13 15:22:58 +00002064 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002065 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002066 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002067 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2068 }
2069
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002070 ssl->in_left += ret;
2071 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002072 }
2073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002075
2076 return( 0 );
2077}
2078
2079/*
2080 * Flush any data not yet written
2081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002083{
Janos Follath865b3eb2019-12-16 11:46:15 +00002084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002085 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002088
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002089 if( ssl->f_send == NULL )
2090 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002092 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002094 }
2095
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002096 /* Avoid incrementing counter if data is flushed */
2097 if( ssl->out_left == 0 )
2098 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002100 return( 0 );
2101 }
2102
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 while( ssl->out_left > 0 )
2104 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002105 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2106 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002107 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002108
Hanno Becker2b1e3542018-08-06 11:19:13 +01002109 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002110 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002113
2114 if( ret <= 0 )
2115 return( ret );
2116
makise-homuraaf9513b2020-08-24 18:26:27 +03002117 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002118 {
Darryl Green11999bb2018-03-13 15:22:58 +00002119 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002120 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002121 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002122 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2123 }
2124
Paul Bakker5121ce52009-01-03 21:22:43 +00002125 ssl->out_left -= ret;
2126 }
2127
Hanno Becker2b1e3542018-08-06 11:19:13 +01002128#if defined(MBEDTLS_SSL_PROTO_DTLS)
2129 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002130 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002131 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002132 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002133 else
2134#endif
2135 {
2136 ssl->out_hdr = ssl->out_buf + 8;
2137 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002138 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002141
2142 return( 0 );
2143}
2144
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002145/*
2146 * Functions to handle the DTLS retransmission state machine
2147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149/*
2150 * Append current handshake message to current outgoing flight
2151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002153{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002155 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2156 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2157 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002158
2159 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002160 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002161 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002162 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002164 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165 }
2166
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002167 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002168 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2170 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002172 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002173 }
2174
2175 /* Copy current handshake message with headers */
2176 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2177 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002178 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002179 msg->next = NULL;
2180
2181 /* Append to the current flight */
2182 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002183 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184 else
2185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187 while( cur->next != NULL )
2188 cur = cur->next;
2189 cur->next = msg;
2190 }
2191
Hanno Becker3b235902018-08-06 09:54:53 +01002192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193 return( 0 );
2194}
2195
2196/*
2197 * Free the current flight of handshake messages
2198 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002199void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002200{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201 mbedtls_ssl_flight_item *cur = flight;
2202 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002203
2204 while( cur != NULL )
2205 {
2206 next = cur->next;
2207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 mbedtls_free( cur->p );
2209 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002210
2211 cur = next;
2212 }
2213}
2214
2215/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002216 * Swap transform_out and out_ctr with the alternative ones
2217 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002218static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002219{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002221 unsigned char tmp_out_ctr[8];
2222
2223 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2224 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002226 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002227 }
2228
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002230
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002231 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002232 tmp_transform = ssl->transform_out;
2233 ssl->transform_out = ssl->handshake->alt_transform_out;
2234 ssl->handshake->alt_transform_out = tmp_transform;
2235
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002236 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002237 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2238 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002239 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002240
2241 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002242 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002243
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2245 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002246 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002247 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2248 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002249 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2251 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002252 }
2253 }
2254#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002255
2256 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002257}
2258
2259/*
2260 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002261 */
2262int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2263{
2264 int ret = 0;
2265
2266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2267
2268 ret = mbedtls_ssl_flight_transmit( ssl );
2269
2270 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2271
2272 return( ret );
2273}
2274
2275/*
2276 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002277 *
2278 * Need to remember the current message in case flush_output returns
2279 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002280 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002281 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002282int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283{
Janos Follath865b3eb2019-12-16 11:46:15 +00002284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002286
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002287 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002288 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002290
2291 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002292 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002293 ret = ssl_swap_epochs( ssl );
2294 if( ret != 0 )
2295 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002296
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002298 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002299
2300 while( ssl->handshake->cur_msg != NULL )
2301 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002302 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002303 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002304
Hanno Beckere1dcb032018-08-17 16:47:58 +01002305 int const is_finished =
2306 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2307 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2308
Hanno Becker04da1892018-08-14 13:22:10 +01002309 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2310 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2311
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002312 /* Swap epochs before sending Finished: we can't do it after
2313 * sending ChangeCipherSpec, in case write returns WANT_READ.
2314 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002315 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002316 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002318 ret = ssl_swap_epochs( ssl );
2319 if( ret != 0 )
2320 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002321 }
2322
Hanno Becker67bc7c32018-08-06 11:33:50 +01002323 ret = ssl_get_remaining_payload_in_datagram( ssl );
2324 if( ret < 0 )
2325 return( ret );
2326 max_frag_len = (size_t) ret;
2327
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002328 /* CCS is copied as is, while HS messages may need fragmentation */
2329 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2330 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002331 if( max_frag_len == 0 )
2332 {
2333 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2334 return( ret );
2335
2336 continue;
2337 }
2338
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002339 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002340 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002341 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002342
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002343 /* Update position inside current message */
2344 ssl->handshake->cur_msg_p += cur->len;
2345 }
2346 else
2347 {
2348 const unsigned char * const p = ssl->handshake->cur_msg_p;
2349 const size_t hs_len = cur->len - 12;
2350 const size_t frag_off = p - ( cur->p + 12 );
2351 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002352 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002353
Hanno Beckere1dcb032018-08-17 16:47:58 +01002354 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002355 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002356 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002357 {
2358 ret = ssl_swap_epochs( ssl );
2359 if( ret != 0 )
2360 return( ret );
2361 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002362
Hanno Becker67bc7c32018-08-06 11:33:50 +01002363 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2364 return( ret );
2365
2366 continue;
2367 }
2368 max_hs_frag_len = max_frag_len - 12;
2369
2370 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2371 max_hs_frag_len : rem_len;
2372
2373 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002374 {
2375 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002376 (unsigned) cur_hs_frag_len,
2377 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002378 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002379
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002380 /* Messages are stored with handshake headers as if not fragmented,
2381 * copy beginning of headers then fill fragmentation fields.
2382 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2383 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002384
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002385 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2386 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2387 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002388
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002389 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2390 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2391 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002392
2393 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2394
Hanno Becker3f7b9732018-08-28 09:53:25 +01002395 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002396 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2397 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002398 ssl->out_msgtype = cur->type;
2399
2400 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002401 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002402 }
2403
2404 /* If done with the current message move to the next one if any */
2405 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2406 {
2407 if( cur->next != NULL )
2408 {
2409 ssl->handshake->cur_msg = cur->next;
2410 ssl->handshake->cur_msg_p = cur->next->p + 12;
2411 }
2412 else
2413 {
2414 ssl->handshake->cur_msg = NULL;
2415 ssl->handshake->cur_msg_p = NULL;
2416 }
2417 }
2418
2419 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002420 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423 return( ret );
2424 }
2425 }
2426
Hanno Becker67bc7c32018-08-06 11:33:50 +01002427 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2428 return( ret );
2429
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002430 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2432 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002433 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002434 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002436 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002437 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002438
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002439 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002440
2441 return( 0 );
2442}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002443
2444/*
2445 * To be called when the last message of an incoming flight is received.
2446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002448{
2449 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002450 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002451 ssl->handshake->flight = NULL;
2452 ssl->handshake->cur_msg = NULL;
2453
2454 /* The next incoming flight will start with this msg_seq */
2455 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2456
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002457 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002458 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002459
Hanno Becker0271f962018-08-16 13:23:47 +01002460 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002461 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002462
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002463 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002464 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2467 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002468 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002470 }
2471 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002473}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002474
2475/*
2476 * To be called when the last message of an outgoing flight is send.
2477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002479{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002480 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002481 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2484 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002485 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002487 }
2488 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002490}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002492
Paul Bakker5121ce52009-01-03 21:22:43 +00002493/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002494 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002495 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002496
2497/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002498 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002499 *
2500 * - fill in handshake headers
2501 * - update handshake checksum
2502 * - DTLS: save message for resending
2503 * - then pass to the record layer
2504 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002505 * DTLS: except for HelloRequest, messages are only queued, and will only be
2506 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002507 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002508 * Inputs:
2509 * - ssl->out_msglen: 4 + actual handshake message len
2510 * (4 is the size of handshake headers for TLS)
2511 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2512 * - ssl->out_msg + 4: the handshake message body
2513 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002514 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002515 * - ssl->out_msglen: the length of the record contents
2516 * (including handshake headers but excluding record headers)
2517 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002519int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002520{
Janos Follath865b3eb2019-12-16 11:46:15 +00002521 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002522 const size_t hs_len = ssl->out_msglen - 4;
2523 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002525 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2526
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002527 /*
2528 * Sanity checks
2529 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002530 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002531 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2532 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002533 /* In SSLv3, the client might send a NoCertificate alert. */
2534#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2535 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2536 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2537 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2538#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2539 {
2540 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2541 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2542 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002543 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002544
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002545 /* Whenever we send anything different from a
2546 * HelloRequest we should be in a handshake - double check. */
2547 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2548 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002549 ssl->handshake == NULL )
2550 {
2551 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2552 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2553 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002556 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002557 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2561 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002562 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002563#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002564
Hanno Beckerb50a2532018-08-06 11:52:54 +01002565 /* Double-check that we did not exceed the bounds
2566 * of the outgoing record buffer.
2567 * This should never fail as the various message
2568 * writing functions must obey the bounds of the
2569 * outgoing record buffer, but better be safe.
2570 *
2571 * Note: We deliberately do not check for the MTU or MFL here.
2572 */
2573 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2574 {
2575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002576 "size %" MBEDTLS_PRINTF_SIZET
2577 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002578 ssl->out_msglen,
2579 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002580 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2581 }
2582
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002583 /*
2584 * Fill handshake headers
2585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002587 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002588 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2589 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2590 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002591
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002592 /*
2593 * DTLS has additional fields in the Handshake layer,
2594 * between the length field and the actual payload:
2595 * uint16 message_seq;
2596 * uint24 fragment_offset;
2597 * uint24 fragment_length;
2598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002600 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002601 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002602 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002603 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002604 {
2605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002606 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002607 hs_len,
2608 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002609 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2610 }
2611
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002612 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002613 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002614
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002615 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002616 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002617 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002618 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002619 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002620 }
2621 else
2622 {
2623 ssl->out_msg[4] = 0;
2624 ssl->out_msg[5] = 0;
2625 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002626
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002627 /* Handshake hashes are computed without fragmentation,
2628 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002629 memset( ssl->out_msg + 6, 0x00, 3 );
2630 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002631 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002632#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002633
Hanno Becker0207e532018-08-28 10:28:28 +01002634 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002635 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2636 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002637 }
2638
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002639 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002641 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002642 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2643 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002644 {
2645 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002648 return( ret );
2649 }
2650 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002651 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002652#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002653 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002654 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002655 {
2656 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2657 return( ret );
2658 }
2659 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002660
2661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2662
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002663 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002664}
2665
2666/*
2667 * Record layer functions
2668 */
2669
2670/*
2671 * Write current record.
2672 *
2673 * Uses:
2674 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2675 * - ssl->out_msglen: length of the record content (excl headers)
2676 * - ssl->out_msg: record content
2677 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002678int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002679{
2680 int ret, done = 0;
2681 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002682 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002683
2684 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002687 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002689 {
2690 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002693 return( ret );
2694 }
2695
2696 len = ssl->out_msglen;
2697 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2701 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002702 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 ret = mbedtls_ssl_hw_record_write( ssl );
2706 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2709 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002710 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002711
2712 if( ret == 0 )
2713 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002714 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002716 if( !done )
2717 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002718 unsigned i;
2719 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002720#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2721 size_t out_buf_len = ssl->out_buf_len;
2722#else
2723 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2724#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002725 /* Skip writing the record content type to after the encryption,
2726 * as it may change when using the CID extension. */
2727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002729 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002730
Hanno Becker19859472018-08-06 09:40:20 +01002731 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002732 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002733
Paul Bakker48916f92012-09-16 19:57:18 +00002734 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002735 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002736 mbedtls_record rec;
2737
2738 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002739 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002740 rec.data_len = ssl->out_msglen;
2741 rec.data_offset = ssl->out_msg - rec.buf;
2742
2743 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2744 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2745 ssl->conf->transport, rec.ver );
2746 rec.type = ssl->out_msgtype;
2747
Hanno Beckera0e20d02019-05-15 14:03:01 +01002748#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002749 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002750 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002751#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002752
Hanno Beckera18d1322018-01-03 14:27:32 +00002753 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002754 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002755 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002757 return( ret );
2758 }
2759
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002760 if( rec.data_offset != 0 )
2761 {
2762 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2763 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2764 }
2765
Hanno Becker6430faf2019-05-08 11:57:13 +01002766 /* Update the record content type and CID. */
2767 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002768#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002769 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002770#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002771 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002772 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002773 }
2774
Hanno Becker5903de42019-05-03 14:46:38 +01002775 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002776
2777#if defined(MBEDTLS_SSL_PROTO_DTLS)
2778 /* In case of DTLS, double-check that we don't exceed
2779 * the remaining space in the datagram. */
2780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2781 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002782 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002783 if( ret < 0 )
2784 return( ret );
2785
2786 if( protected_record_size > (size_t) ret )
2787 {
2788 /* Should never happen */
2789 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2790 }
2791 }
2792#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002793
Hanno Becker6430faf2019-05-08 11:57:13 +01002794 /* Now write the potentially updated record content type. */
2795 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2796
Paul Elliott9f352112020-12-09 14:55:45 +00002797 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002798 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002799 ssl->out_hdr[0], ssl->out_hdr[1],
2800 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002803 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002804
2805 ssl->out_left += protected_record_size;
2806 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002807 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002808
Hanno Beckerdd772292020-02-05 10:38:31 +00002809 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002810 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2811 break;
2812
2813 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002814 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002815 {
2816 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2817 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819 }
2820
Hanno Becker67bc7c32018-08-06 11:33:50 +01002821#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002822 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2823 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002824 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002825 size_t remaining;
2826 ret = ssl_get_remaining_payload_in_datagram( ssl );
2827 if( ret < 0 )
2828 {
2829 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2830 ret );
2831 return( ret );
2832 }
2833
2834 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002835 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002836 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002837 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002838 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002839 else
2840 {
Hanno Becker513815a2018-08-20 11:56:09 +01002841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002842 }
2843 }
2844#endif /* MBEDTLS_SSL_PROTO_DTLS */
2845
2846 if( ( flush == SSL_FORCE_FLUSH ) &&
2847 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002848 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002850 return( ret );
2851 }
2852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002854
2855 return( 0 );
2856}
2857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002859
2860static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2861{
2862 if( ssl->in_msglen < ssl->in_hslen ||
2863 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2864 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2865 {
2866 return( 1 );
2867 }
2868 return( 0 );
2869}
Hanno Becker44650b72018-08-16 12:51:11 +01002870
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002871static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002872{
2873 return( ( ssl->in_msg[9] << 16 ) |
2874 ( ssl->in_msg[10] << 8 ) |
2875 ssl->in_msg[11] );
2876}
2877
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002878static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002879{
2880 return( ( ssl->in_msg[6] << 16 ) |
2881 ( ssl->in_msg[7] << 8 ) |
2882 ssl->in_msg[8] );
2883}
2884
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002885static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002886{
2887 uint32_t msg_len, frag_off, frag_len;
2888
2889 msg_len = ssl_get_hs_total_len( ssl );
2890 frag_off = ssl_get_hs_frag_off( ssl );
2891 frag_len = ssl_get_hs_frag_len( ssl );
2892
2893 if( frag_off > msg_len )
2894 return( -1 );
2895
2896 if( frag_len > msg_len - frag_off )
2897 return( -1 );
2898
2899 if( frag_len + 12 > ssl->in_msglen )
2900 return( -1 );
2901
2902 return( 0 );
2903}
2904
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002905/*
2906 * Mark bits in bitmask (used for DTLS HS reassembly)
2907 */
2908static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2909{
2910 unsigned int start_bits, end_bits;
2911
2912 start_bits = 8 - ( offset % 8 );
2913 if( start_bits != 8 )
2914 {
2915 size_t first_byte_idx = offset / 8;
2916
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002917 /* Special case */
2918 if( len <= start_bits )
2919 {
2920 for( ; len != 0; len-- )
2921 mask[first_byte_idx] |= 1 << ( start_bits - len );
2922
2923 /* Avoid potential issues with offset or len becoming invalid */
2924 return;
2925 }
2926
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002927 offset += start_bits; /* Now offset % 8 == 0 */
2928 len -= start_bits;
2929
2930 for( ; start_bits != 0; start_bits-- )
2931 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2932 }
2933
2934 end_bits = len % 8;
2935 if( end_bits != 0 )
2936 {
2937 size_t last_byte_idx = ( offset + len ) / 8;
2938
2939 len -= end_bits; /* Now len % 8 == 0 */
2940
2941 for( ; end_bits != 0; end_bits-- )
2942 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2943 }
2944
2945 memset( mask + offset / 8, 0xFF, len / 8 );
2946}
2947
2948/*
2949 * Check that bitmask is full
2950 */
2951static int ssl_bitmask_check( unsigned char *mask, size_t len )
2952{
2953 size_t i;
2954
2955 for( i = 0; i < len / 8; i++ )
2956 if( mask[i] != 0xFF )
2957 return( -1 );
2958
2959 for( i = 0; i < len % 8; i++ )
2960 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2961 return( -1 );
2962
2963 return( 0 );
2964}
2965
Hanno Becker56e205e2018-08-16 09:06:12 +01002966/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002967static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002968 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002969{
Hanno Becker56e205e2018-08-16 09:06:12 +01002970 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002971
Hanno Becker56e205e2018-08-16 09:06:12 +01002972 alloc_len = 12; /* Handshake header */
2973 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002974
Hanno Beckerd07df862018-08-16 09:14:58 +01002975 if( add_bitmap )
2976 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002977
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002978 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002979}
Hanno Becker56e205e2018-08-16 09:06:12 +01002980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002982
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002983static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002984{
2985 return( ( ssl->in_msg[1] << 16 ) |
2986 ( ssl->in_msg[2] << 8 ) |
2987 ssl->in_msg[3] );
2988}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002989
Simon Butcher99000142016-10-13 17:21:01 +01002990int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002991{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002993 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002994 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002995 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002997 }
2998
Hanno Becker12555c62018-08-16 12:47:53 +01002999 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003002 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003003 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003006 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003007 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003009 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003010
Hanno Becker44650b72018-08-16 12:51:11 +01003011 if( ssl_check_hs_header( ssl ) != 0 )
3012 {
3013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3014 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3015 }
3016
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003017 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003018 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3019 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3020 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3021 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003022 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003023 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3024 {
3025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3026 recv_msg_seq,
3027 ssl->handshake->in_msg_seq ) );
3028 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3029 }
3030
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003031 /* Retransmit only on last message from previous flight, to avoid
3032 * too many retransmissions.
3033 * Besides, No sane server ever retransmits HelloVerifyRequest */
3034 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003036 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003038 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003039 recv_msg_seq,
3040 ssl->handshake->in_flight_start_seq ) );
3041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003043 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003045 return( ret );
3046 }
3047 }
3048 else
3049 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003051 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003052 recv_msg_seq,
3053 ssl->handshake->in_msg_seq ) );
3054 }
3055
Hanno Becker90333da2017-10-10 11:27:13 +01003056 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003057 }
3058 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003059
Hanno Becker6d97ef52018-08-16 13:09:04 +01003060 /* Message reassembly is handled alongside buffering of future
3061 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003062 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003063 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003064 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003067 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003068 }
3069 }
3070 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003072 /* With TLS we don't handle fragmentation (for now) */
3073 if( ssl->in_msglen < ssl->in_hslen )
3074 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3076 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003077 }
3078
Simon Butcher99000142016-10-13 17:21:01 +01003079 return( 0 );
3080}
3081
3082void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3083{
Hanno Becker0271f962018-08-16 13:23:47 +01003084 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003085
Hanno Becker0271f962018-08-16 13:23:47 +01003086 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003087 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003088 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003089 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003090
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003091 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003093 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003094 ssl->handshake != NULL )
3095 {
Hanno Becker0271f962018-08-16 13:23:47 +01003096 unsigned offset;
3097 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003098
Hanno Becker0271f962018-08-16 13:23:47 +01003099 /* Increment handshake sequence number */
3100 hs->in_msg_seq++;
3101
3102 /*
3103 * Clear up handshake buffering and reassembly structure.
3104 */
3105
3106 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003107 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003108
3109 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003110 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3111 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003112 offset++, hs_buf++ )
3113 {
3114 *hs_buf = *(hs_buf + 1);
3115 }
3116
3117 /* Create a fresh last entry */
3118 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003119 }
3120#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003121}
3122
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003123/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003124 * DTLS anti-replay: RFC 6347 4.1.2.6
3125 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003126 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3127 * Bit n is set iff record number in_window_top - n has been seen.
3128 *
3129 * Usually, in_window_top is the last record number seen and the lsb of
3130 * in_window is set. The only exception is the initial state (record number 0
3131 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003134void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003135{
3136 ssl->in_window_top = 0;
3137 ssl->in_window = 0;
3138}
3139
3140static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3141{
3142 return( ( (uint64_t) buf[0] << 40 ) |
3143 ( (uint64_t) buf[1] << 32 ) |
3144 ( (uint64_t) buf[2] << 24 ) |
3145 ( (uint64_t) buf[3] << 16 ) |
3146 ( (uint64_t) buf[4] << 8 ) |
3147 ( (uint64_t) buf[5] ) );
3148}
3149
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003150static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3151{
Janos Follath865b3eb2019-12-16 11:46:15 +00003152 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003153 unsigned char *original_in_ctr;
3154
3155 // save original in_ctr
3156 original_in_ctr = ssl->in_ctr;
3157
3158 // use counter from record
3159 ssl->in_ctr = record_in_ctr;
3160
3161 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3162
3163 // restore the counter
3164 ssl->in_ctr = original_in_ctr;
3165
3166 return ret;
3167}
3168
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003169/*
3170 * Return 0 if sequence number is acceptable, -1 otherwise
3171 */
Hanno Becker0183d692019-07-12 08:50:37 +01003172int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003173{
3174 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3175 uint64_t bit;
3176
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003177 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003178 return( 0 );
3179
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003180 if( rec_seqnum > ssl->in_window_top )
3181 return( 0 );
3182
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003183 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003184
3185 if( bit >= 64 )
3186 return( -1 );
3187
3188 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3189 return( -1 );
3190
3191 return( 0 );
3192}
3193
3194/*
3195 * Update replay window on new validated record
3196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003198{
3199 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3200
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003201 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003202 return;
3203
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003204 if( rec_seqnum > ssl->in_window_top )
3205 {
3206 /* Update window_top and the contents of the window */
3207 uint64_t shift = rec_seqnum - ssl->in_window_top;
3208
3209 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003210 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003211 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003212 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003213 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003214 ssl->in_window |= 1;
3215 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003216
3217 ssl->in_window_top = rec_seqnum;
3218 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003219 else
3220 {
3221 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003222 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003223
3224 if( bit < 64 ) /* Always true, but be extra sure */
3225 ssl->in_window |= (uint64_t) 1 << bit;
3226 }
3227}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003229
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003230#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003231/*
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003232 * Check if a datagram looks like a ClientHello with a valid cookie,
3233 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003234 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003235 *
3236 * - if cookie is valid, return 0
3237 * - if ClientHello looks superficially valid but cookie is not,
3238 * fill obuf and set olen, then
3239 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3240 * - otherwise return a specific error code
3241 */
3242static int ssl_check_dtls_clihlo_cookie(
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003243 mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003244 const unsigned char *cli_id, size_t cli_id_len,
3245 const unsigned char *in, size_t in_len,
3246 unsigned char *obuf, size_t buf_len, size_t *olen )
3247{
3248 size_t sid_len, cookie_len;
3249 unsigned char *p;
3250
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003251 /*
3252 * Structure of ClientHello with record and handshake headers,
3253 * and expected values. We don't need to check a lot, more checks will be
3254 * done when actually parsing the ClientHello - skipping those checks
3255 * avoids code duplication and does not make cookie forging any easier.
3256 *
3257 * 0-0 ContentType type; copied, must be handshake
3258 * 1-2 ProtocolVersion version; copied
3259 * 3-4 uint16 epoch; copied, must be 0
3260 * 5-10 uint48 sequence_number; copied
3261 * 11-12 uint16 length; (ignored)
3262 *
3263 * 13-13 HandshakeType msg_type; (ignored)
3264 * 14-16 uint24 length; (ignored)
3265 * 17-18 uint16 message_seq; copied
3266 * 19-21 uint24 fragment_offset; copied, must be 0
3267 * 22-24 uint24 fragment_length; (ignored)
3268 *
3269 * 25-26 ProtocolVersion client_version; (ignored)
3270 * 27-58 Random random; (ignored)
3271 * 59-xx SessionID session_id; 1 byte len + sid_len content
3272 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3273 * ...
3274 *
3275 * Minimum length is 61 bytes.
3276 */
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003277 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: in_len=%u",
3278 (unsigned) in_len ) );
3279 MBEDTLS_SSL_DEBUG_BUF( 4, "cli_id", cli_id, cli_id_len );
3280 if( in_len < 61 )
3281 {
3282 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: record too short" ) );
3283 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3284 }
3285 if( in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003286 in[3] != 0 || in[4] != 0 ||
3287 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3288 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003289 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: not a good ClientHello" ) );
3290 MBEDTLS_SSL_DEBUG_MSG( 4, ( " type=%u epoch=%u fragment_offset=%u",
3291 in[0],
3292 (unsigned) in[3] << 8 | in[4],
3293 (unsigned) in[19] << 16 | in[20] << 8 | in[21] ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003294 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3295 }
3296
3297 sid_len = in[59];
3298 if( sid_len > in_len - 61 )
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003299 {
3300 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: sid_len=%u > %u",
3301 (unsigned) sid_len,
3302 (unsigned) in_len - 61 ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003303 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003304 }
3305 MBEDTLS_SSL_DEBUG_BUF( 4, "sid received from network",
3306 in + 60, sid_len );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003307
3308 cookie_len = in[60 + sid_len];
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003309 if( cookie_len > in_len - 60 ) {
3310 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: cookie_len=%u > %u",
3311 (unsigned) cookie_len,
3312 (unsigned) in_len - 60 ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003313 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003314 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003315
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003316 MBEDTLS_SSL_DEBUG_BUF( 4, "cookie received from network",
3317 in + sid_len + 61, cookie_len );
3318 if( ssl->conf->f_cookie_check( ssl->conf->p_cookie,
3319 in + sid_len + 61, cookie_len,
3320 cli_id, cli_id_len ) == 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003321 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003322 MBEDTLS_SSL_DEBUG_MSG( 4, ( "check cookie: valid" ) );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003323 return( 0 );
3324 }
3325
3326 /*
3327 * If we get here, we've got an invalid cookie, let's prepare HVR.
3328 *
3329 * 0-0 ContentType type; copied
3330 * 1-2 ProtocolVersion version; copied
3331 * 3-4 uint16 epoch; copied
3332 * 5-10 uint48 sequence_number; copied
3333 * 11-12 uint16 length; olen - 13
3334 *
3335 * 13-13 HandshakeType msg_type; hello_verify_request
3336 * 14-16 uint24 length; olen - 25
3337 * 17-18 uint16 message_seq; copied
3338 * 19-21 uint24 fragment_offset; copied
3339 * 22-24 uint24 fragment_length; olen - 25
3340 *
3341 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3342 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3343 *
3344 * Minimum length is 28.
3345 */
3346 if( buf_len < 28 )
3347 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3348
3349 /* Copy most fields and adapt others */
3350 memcpy( obuf, in, 25 );
3351 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3352 obuf[25] = 0xfe;
3353 obuf[26] = 0xff;
3354
3355 /* Generate and write actual cookie */
3356 p = obuf + 28;
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003357 if( ssl->conf->f_cookie_write( ssl->conf->p_cookie,
3358 &p, obuf + buf_len,
3359 cli_id, cli_id_len ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003360 {
3361 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3362 }
3363
3364 *olen = p - obuf;
3365
3366 /* Go back and fill length fields */
3367 obuf[27] = (unsigned char)( *olen - 28 );
3368
Joe Subbianiad1115a2021-07-16 14:27:50 +01003369 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3370 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3371 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003372
Joe Subbianic54e9082021-07-19 11:56:54 +01003373 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003374
3375 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3376}
3377
3378/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003379 * Handle possible client reconnect with the same UDP quadruplet
3380 * (RFC 6347 Section 4.2.8).
3381 *
3382 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3383 * that looks like a ClientHello.
3384 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003385 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003386 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003387 * - if the input looks like a ClientHello with a valid cookie,
3388 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003389 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003390 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003391 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003392 * This function is called (through ssl_check_client_reconnect()) when an
3393 * unexpected record is found in ssl_get_next_record(), which will discard the
3394 * record if we return 0, and bubble up the return value otherwise (this
3395 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3396 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003397 */
3398static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3399{
Janos Follath865b3eb2019-12-16 11:46:15 +00003400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003401 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003402
Hanno Becker2fddd372019-07-10 14:37:41 +01003403 if( ssl->conf->f_cookie_write == NULL ||
3404 ssl->conf->f_cookie_check == NULL )
3405 {
3406 /* If we can't use cookies to verify reachability of the peer,
3407 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3409 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003410 return( 0 );
3411 }
3412
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003413 ret = ssl_check_dtls_clihlo_cookie(
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003414 ssl,
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003415 ssl->cli_id, ssl->cli_id_len,
3416 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003417 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003418
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003419 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3420
3421 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003422 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003423 int send_ret;
3424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3425 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3426 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003427 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003428 * If the error is permanent we'll catch it later,
3429 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003430 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3431 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3432 (void) send_ret;
3433
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003434 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003435 }
3436
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003437 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003438 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003440 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003441 {
3442 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3443 return( ret );
3444 }
3445
3446 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003447 }
3448
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003449 return( ret );
3450}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003451#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003452
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003453static int ssl_check_record_type( uint8_t record_type )
3454{
3455 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3456 record_type != MBEDTLS_SSL_MSG_ALERT &&
3457 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3458 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3459 {
3460 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3461 }
3462
3463 return( 0 );
3464}
3465
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003466/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003467 * ContentType type;
3468 * ProtocolVersion version;
3469 * uint16 epoch; // DTLS only
3470 * uint48 sequence_number; // DTLS only
3471 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003472 *
3473 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003474 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003475 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3476 *
3477 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003478 * 1. proceed with the record if this function returns 0
3479 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3480 * 3. return CLIENT_RECONNECT if this function return that value
3481 * 4. drop the whole datagram if this function returns anything else.
3482 * Point 2 is needed when the peer is resending, and we have already received
3483 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003484 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003485static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003486 unsigned char *buf,
3487 size_t len,
3488 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003489{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003490 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003491
Hanno Beckere5e7e782019-07-11 12:29:35 +01003492 size_t const rec_hdr_type_offset = 0;
3493 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003494
Hanno Beckere5e7e782019-07-11 12:29:35 +01003495 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3496 rec_hdr_type_len;
3497 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003498
Hanno Beckere5e7e782019-07-11 12:29:35 +01003499 size_t const rec_hdr_ctr_len = 8;
3500#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003501 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003502 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3503 rec_hdr_version_len;
3504
Hanno Beckera0e20d02019-05-15 14:03:01 +01003505#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003506 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3507 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003508 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003509#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3510#endif /* MBEDTLS_SSL_PROTO_DTLS */
3511
3512 size_t rec_hdr_len_offset; /* To be determined */
3513 size_t const rec_hdr_len_len = 2;
3514
3515 /*
3516 * Check minimum lengths for record header.
3517 */
3518
3519#if defined(MBEDTLS_SSL_PROTO_DTLS)
3520 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3521 {
3522 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3523 }
3524 else
3525#endif /* MBEDTLS_SSL_PROTO_DTLS */
3526 {
3527 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3528 }
3529
3530 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3531 {
3532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3533 (unsigned) len,
3534 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3535 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3536 }
3537
3538 /*
3539 * Parse and validate record content type
3540 */
3541
3542 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003543
3544 /* Check record content type */
3545#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3546 rec->cid_len = 0;
3547
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003548 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003549 ssl->conf->cid_len != 0 &&
3550 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003551 {
3552 /* Shift pointers to account for record header including CID
3553 * struct {
3554 * ContentType special_type = tls12_cid;
3555 * ProtocolVersion version;
3556 * uint16 epoch;
3557 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003558 * opaque cid[cid_length]; // Additional field compared to
3559 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003560 * uint16 length;
3561 * opaque enc_content[DTLSCiphertext.length];
3562 * } DTLSCiphertext;
3563 */
3564
3565 /* So far, we only support static CID lengths
3566 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567 rec_hdr_cid_len = ssl->conf->cid_len;
3568 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003569
Hanno Beckere5e7e782019-07-11 12:29:35 +01003570 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003571 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3573 (unsigned) len,
3574 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003575 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003576 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003577
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003578 /* configured CID len is guaranteed at most 255, see
3579 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3580 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003581 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003582 }
3583 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003584#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003585 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003586 if( ssl_check_record_type( rec->type ) )
3587 {
Hanno Becker54229812019-07-12 14:40:00 +01003588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3589 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003590 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3591 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003592 }
3593
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594 /*
3595 * Parse and validate record version
3596 */
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003597 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3598 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003599 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3600 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003601 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003602
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003603 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003604 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch: got %u, expected %u",
3606 (unsigned) major_ver,
3607 (unsigned) ssl->major_ver ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003609 }
3610
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003611 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003612 {
Gilles Peskinef333dfa2022-02-15 23:53:36 +01003613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch: got %u, expected max %u",
3614 (unsigned) minor_ver,
3615 (unsigned) ssl->conf->max_minor_ver ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003617 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003618 /*
3619 * Parse/Copy record sequence number.
3620 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003621
Hanno Beckere5e7e782019-07-11 12:29:35 +01003622#if defined(MBEDTLS_SSL_PROTO_DTLS)
3623 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003624 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003625 /* Copy explicit record sequence number from input buffer. */
3626 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3627 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003628 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003629 else
3630#endif /* MBEDTLS_SSL_PROTO_DTLS */
3631 {
3632 /* Copy implicit record sequence number from SSL context structure. */
3633 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3634 }
Paul Bakker40e46942009-01-03 21:51:57 +00003635
Hanno Beckere5e7e782019-07-11 12:29:35 +01003636 /*
3637 * Parse record length.
3638 */
3639
Hanno Beckere5e7e782019-07-11 12:29:35 +01003640 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003641 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3642 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003643 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003644
Paul Elliott9f352112020-12-09 14:55:45 +00003645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003646 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 rec->type,
3648 major_ver, minor_ver, rec->data_len ) );
3649
3650 rec->buf = buf;
3651 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003652
Hanno Beckerd417cc92019-07-26 08:20:27 +01003653 if( rec->data_len == 0 )
3654 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003655
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003656 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003657 * DTLS-related tests.
3658 * Check epoch before checking length constraint because
3659 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3660 * message gets duplicated before the corresponding Finished message,
3661 * the second ChangeCipherSpec should be discarded because it belongs
3662 * to an old epoch, but not because its length is shorter than
3663 * the minimum record length for packets using the new record transform.
3664 * Note that these two kinds of failures are handled differently,
3665 * as an unexpected record is silently skipped but an invalid
3666 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003667 */
3668#if defined(MBEDTLS_SSL_PROTO_DTLS)
3669 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3670 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003671 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003672
Hanno Becker955a5c92019-07-10 17:12:07 +01003673 /* Check that the datagram is large enough to contain a record
3674 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003675 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003676 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3678 (unsigned) len,
3679 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003680 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3681 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003682
Hanno Becker37cfe732019-07-10 17:20:01 +01003683 /* Records from other, non-matching epochs are silently discarded.
3684 * (The case of same-port Client reconnects must be considered in
3685 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003686 if( rec_epoch != ssl->in_epoch )
3687 {
3688 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003689 "expected %u, received %lu",
3690 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003691
Hanno Becker552f7472019-07-19 10:59:12 +01003692 /* Records from the next epoch are considered for buffering
3693 * (concretely: early Finished messages). */
3694 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003695 {
Hanno Becker552f7472019-07-19 10:59:12 +01003696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3697 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003698 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003699
Hanno Becker2fddd372019-07-10 14:37:41 +01003700 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003701 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003703 /* For records from the correct epoch, check whether their
3704 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003705 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3706 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003707 {
3708 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3709 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3710 }
3711#endif
3712 }
3713#endif /* MBEDTLS_SSL_PROTO_DTLS */
3714
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003715 return( 0 );
3716}
Paul Bakker5121ce52009-01-03 21:22:43 +00003717
Paul Bakker5121ce52009-01-03 21:22:43 +00003718
Hanno Becker2fddd372019-07-10 14:37:41 +01003719#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3720static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3721{
3722 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3723
3724 /*
3725 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3726 * access the first byte of record content (handshake type), as we
3727 * have an active transform (possibly iv_len != 0), so use the
3728 * fact that the record header len is 13 instead.
3729 */
3730 if( rec_epoch == 0 &&
3731 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3732 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3733 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3734 ssl->in_left > 13 &&
3735 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3736 {
3737 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3738 "from the same port" ) );
3739 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003740 }
3741
3742 return( 0 );
3743}
Hanno Becker2fddd372019-07-10 14:37:41 +01003744#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003745
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003746/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003747 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003748 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003749static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3750 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003751{
3752 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003754 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003755 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003757#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3758 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003760 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003762 ret = mbedtls_ssl_hw_record_read( ssl );
3763 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003765 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3766 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003767 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003768
3769 if( ret == 0 )
3770 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003771 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003773 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003774 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003775 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003776
Hanno Beckera18d1322018-01-03 14:27:32 +00003777 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003778 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003779 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003780 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003781
Hanno Beckera0e20d02019-05-15 14:03:01 +01003782#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003783 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3784 ssl->conf->ignore_unexpected_cid
3785 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3786 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003787 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003788 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003789 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003790#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003791
Paul Bakker5121ce52009-01-03 21:22:43 +00003792 return( ret );
3793 }
3794
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003795 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003796 {
3797 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003798 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003799 }
3800
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003801 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003802 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003803
Hanno Beckera0e20d02019-05-15 14:03:01 +01003804#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003805 /* We have already checked the record content type
3806 * in ssl_parse_record_header(), failing or silently
3807 * dropping the record in the case of an unknown type.
3808 *
3809 * Since with the use of CIDs, the record content type
3810 * might change during decryption, re-check the record
3811 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003812 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003813 {
3814 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3815 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3816 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003817#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003818
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003819 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003820 {
3821#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3822 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003823 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003824 {
3825 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3826 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3827 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3828 }
3829#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3830
3831 ssl->nb_zero++;
3832
3833 /*
3834 * Three or more empty messages may be a DoS attack
3835 * (excessive CPU consumption).
3836 */
3837 if( ssl->nb_zero > 3 )
3838 {
3839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003840 "messages, possible DoS attack" ) );
3841 /* Treat the records as if they were not properly authenticated,
3842 * thereby failing the connection if we see more than allowed
3843 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003844 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3845 }
3846 }
3847 else
3848 ssl->nb_zero = 0;
3849
3850#if defined(MBEDTLS_SSL_PROTO_DTLS)
3851 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3852 {
3853 ; /* in_ctr read from peer, not maintained internally */
3854 }
3855 else
3856#endif
3857 {
3858 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003859 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003860 if( ++ssl->in_ctr[i - 1] != 0 )
3861 break;
3862
3863 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003864 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003865 {
3866 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3867 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3868 }
3869 }
3870
Paul Bakker5121ce52009-01-03 21:22:43 +00003871 }
3872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003873#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003874 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003875 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003876 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003877 }
3878#endif
3879
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003880 /* Check actual (decrypted) record content length against
3881 * configured maximum. */
3882 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3883 {
3884 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3885 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3886 }
3887
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003888 return( 0 );
3889}
3890
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003891/*
3892 * Read a record.
3893 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003894 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3895 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3896 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003897 */
Hanno Becker1097b342018-08-15 14:09:41 +01003898
3899/* Helper functions for mbedtls_ssl_read_record(). */
3900static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003901static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3902static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003903
Hanno Becker327c93b2018-08-15 13:56:18 +01003904int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003905 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003906{
Janos Follath865b3eb2019-12-16 11:46:15 +00003907 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003910
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003911 if( ssl->keep_current_message == 0 )
3912 {
3913 do {
Simon Butcher99000142016-10-13 17:21:01 +01003914
Hanno Becker26994592018-08-15 14:14:59 +01003915 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003916 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003917 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003918
Hanno Beckere74d5562018-08-15 14:26:08 +01003919 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003920 {
Hanno Becker40f50842018-08-15 14:48:01 +01003921#if defined(MBEDTLS_SSL_PROTO_DTLS)
3922 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003923
Hanno Becker40f50842018-08-15 14:48:01 +01003924 /* We only check for buffered messages if the
3925 * current datagram is fully consumed. */
3926 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003927 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003928 {
Hanno Becker40f50842018-08-15 14:48:01 +01003929 if( ssl_load_buffered_message( ssl ) == 0 )
3930 have_buffered = 1;
3931 }
3932
3933 if( have_buffered == 0 )
3934#endif /* MBEDTLS_SSL_PROTO_DTLS */
3935 {
3936 ret = ssl_get_next_record( ssl );
3937 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3938 continue;
3939
3940 if( ret != 0 )
3941 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003942 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003943 return( ret );
3944 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003945 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003946 }
3947
3948 ret = mbedtls_ssl_handle_message_type( ssl );
3949
Hanno Becker40f50842018-08-15 14:48:01 +01003950#if defined(MBEDTLS_SSL_PROTO_DTLS)
3951 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3952 {
3953 /* Buffer future message */
3954 ret = ssl_buffer_message( ssl );
3955 if( ret != 0 )
3956 return( ret );
3957
3958 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3959 }
3960#endif /* MBEDTLS_SSL_PROTO_DTLS */
3961
Hanno Becker90333da2017-10-10 11:27:13 +01003962 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3963 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003964
3965 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003966 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003967 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003968 return( ret );
3969 }
3970
Hanno Becker327c93b2018-08-15 13:56:18 +01003971 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003972 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003973 {
3974 mbedtls_ssl_update_handshake_status( ssl );
3975 }
Simon Butcher99000142016-10-13 17:21:01 +01003976 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003977 else
Simon Butcher99000142016-10-13 17:21:01 +01003978 {
Hanno Becker02f59072018-08-15 14:00:24 +01003979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003980 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003981 }
3982
3983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3984
3985 return( 0 );
3986}
3987
Hanno Becker40f50842018-08-15 14:48:01 +01003988#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003989static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003990{
Hanno Becker40f50842018-08-15 14:48:01 +01003991 if( ssl->in_left > ssl->next_record_offset )
3992 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003993
Hanno Becker40f50842018-08-15 14:48:01 +01003994 return( 0 );
3995}
3996
3997static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3998{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003999 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004000 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004001 int ret = 0;
4002
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004003 if( hs == NULL )
4004 return( -1 );
4005
Hanno Beckere00ae372018-08-20 09:39:42 +01004006 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4007
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004008 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4009 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4010 {
4011 /* Check if we have seen a ChangeCipherSpec before.
4012 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004013 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004014 {
4015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4016 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004017 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004018 }
4019
Hanno Becker39b8bc92018-08-28 17:17:13 +01004020 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004021 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4022 ssl->in_msglen = 1;
4023 ssl->in_msg[0] = 1;
4024
4025 /* As long as they are equal, the exact value doesn't matter. */
4026 ssl->in_left = 0;
4027 ssl->next_record_offset = 0;
4028
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004029 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004030 goto exit;
4031 }
Hanno Becker37f95322018-08-16 13:55:32 +01004032
Hanno Beckerb8f50142018-08-28 10:01:34 +01004033#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004034 /* Debug only */
4035 {
4036 unsigned offset;
4037 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4038 {
4039 hs_buf = &hs->buffering.hs[offset];
4040 if( hs_buf->is_valid == 1 )
4041 {
4042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4043 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004044 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004045 }
4046 }
4047 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004048#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004049
4050 /* Check if we have buffered and/or fully reassembled the
4051 * next handshake message. */
4052 hs_buf = &hs->buffering.hs[0];
4053 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4054 {
4055 /* Synthesize a record containing the buffered HS message. */
4056 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4057 ( hs_buf->data[2] << 8 ) |
4058 hs_buf->data[3];
4059
4060 /* Double-check that we haven't accidentally buffered
4061 * a message that doesn't fit into the input buffer. */
4062 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4063 {
4064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4065 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4066 }
4067
4068 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4069 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4070 hs_buf->data, msg_len + 12 );
4071
4072 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4073 ssl->in_hslen = msg_len + 12;
4074 ssl->in_msglen = msg_len + 12;
4075 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4076
4077 ret = 0;
4078 goto exit;
4079 }
4080 else
4081 {
4082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4083 hs->in_msg_seq ) );
4084 }
4085
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004086 ret = -1;
4087
4088exit:
4089
4090 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4091 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004092}
4093
Hanno Beckera02b0b42018-08-21 17:20:27 +01004094static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4095 size_t desired )
4096{
4097 int offset;
4098 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4100 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004101
Hanno Becker01315ea2018-08-21 17:22:17 +01004102 /* Get rid of future records epoch first, if such exist. */
4103 ssl_free_buffered_record( ssl );
4104
4105 /* Check if we have enough space available now. */
4106 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4107 hs->buffering.total_bytes_buffered ) )
4108 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004110 return( 0 );
4111 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004112
Hanno Becker4f432ad2018-08-28 10:02:32 +01004113 /* We don't have enough space to buffer the next expected handshake
4114 * message. Remove buffers used for future messages to gain space,
4115 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004116 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4117 offset >= 0; offset-- )
4118 {
4119 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4120 offset ) );
4121
Hanno Beckerb309b922018-08-23 13:18:05 +01004122 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004123
4124 /* Check if we have enough space available now. */
4125 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4126 hs->buffering.total_bytes_buffered ) )
4127 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004128 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004129 return( 0 );
4130 }
4131 }
4132
4133 return( -1 );
4134}
4135
Hanno Becker40f50842018-08-15 14:48:01 +01004136static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4137{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004138 int ret = 0;
4139 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4140
4141 if( hs == NULL )
4142 return( 0 );
4143
4144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4145
4146 switch( ssl->in_msgtype )
4147 {
4148 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4149 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004150
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004151 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004152 break;
4153
4154 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004155 {
4156 unsigned recv_msg_seq_offset;
4157 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4158 mbedtls_ssl_hs_buffer *hs_buf;
4159 size_t msg_len = ssl->in_hslen - 12;
4160
4161 /* We should never receive an old handshake
4162 * message - double-check nonetheless. */
4163 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4164 {
4165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4167 }
4168
4169 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4170 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4171 {
4172 /* Silently ignore -- message too far in the future */
4173 MBEDTLS_SSL_DEBUG_MSG( 2,
4174 ( "Ignore future HS message with sequence number %u, "
4175 "buffering window %u - %u",
4176 recv_msg_seq, ssl->handshake->in_msg_seq,
4177 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4178
4179 goto exit;
4180 }
4181
4182 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4183 recv_msg_seq, recv_msg_seq_offset ) );
4184
4185 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4186
4187 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004188 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004189 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004190 size_t reassembly_buf_sz;
4191
Hanno Becker37f95322018-08-16 13:55:32 +01004192 hs_buf->is_fragmented =
4193 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4194
4195 /* We copy the message back into the input buffer
4196 * after reassembly, so check that it's not too large.
4197 * This is an implementation-specific limitation
4198 * and not one from the standard, hence it is not
4199 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004200 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004201 {
4202 /* Ignore message */
4203 goto exit;
4204 }
4205
Hanno Beckere0b150f2018-08-21 15:51:03 +01004206 /* Check if we have enough space to buffer the message. */
4207 if( hs->buffering.total_bytes_buffered >
4208 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4209 {
4210 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4211 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4212 }
4213
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004214 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4215 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004216
4217 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4218 hs->buffering.total_bytes_buffered ) )
4219 {
4220 if( recv_msg_seq_offset > 0 )
4221 {
4222 /* If we can't buffer a future message because
4223 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004224 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4225 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4226 " (already %" MBEDTLS_PRINTF_SIZET
4227 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004228 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004229 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004230 goto exit;
4231 }
Hanno Beckere1801392018-08-21 16:51:05 +01004232 else
4233 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004234 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4235 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4236 " (already %" MBEDTLS_PRINTF_SIZET
4237 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004238 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004239 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004240 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004241
Hanno Beckera02b0b42018-08-21 17:20:27 +01004242 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004243 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004244 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4245 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4246 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4247 " (already %" MBEDTLS_PRINTF_SIZET
4248 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004249 msg_len,
4250 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004251 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004252 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004253 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4254 goto exit;
4255 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004256 }
4257
Paul Elliottd48d5c62021-01-07 14:47:05 +00004258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004259 msg_len ) );
4260
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004261 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4262 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004263 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004264 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004265 goto exit;
4266 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004267 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004268
4269 /* Prepare final header: copy msg_type, length and message_seq,
4270 * then add standardised fragment_offset and fragment_length */
4271 memcpy( hs_buf->data, ssl->in_msg, 6 );
4272 memset( hs_buf->data + 6, 0, 3 );
4273 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4274
4275 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004276
4277 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004278 }
4279 else
4280 {
4281 /* Make sure msg_type and length are consistent */
4282 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4283 {
4284 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4285 /* Ignore */
4286 goto exit;
4287 }
4288 }
4289
Hanno Becker4422bbb2018-08-20 09:40:19 +01004290 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004291 {
4292 size_t frag_len, frag_off;
4293 unsigned char * const msg = hs_buf->data + 12;
4294
4295 /*
4296 * Check and copy current fragment
4297 */
4298
4299 /* Validation of header fields already done in
4300 * mbedtls_ssl_prepare_handshake_record(). */
4301 frag_off = ssl_get_hs_frag_off( ssl );
4302 frag_len = ssl_get_hs_frag_len( ssl );
4303
Paul Elliottd48d5c62021-01-07 14:47:05 +00004304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4305 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004306 frag_off, frag_len ) );
4307 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4308
4309 if( hs_buf->is_fragmented )
4310 {
4311 unsigned char * const bitmask = msg + msg_len;
4312 ssl_bitmask_set( bitmask, frag_off, frag_len );
4313 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4314 msg_len ) == 0 );
4315 }
4316 else
4317 {
4318 hs_buf->is_complete = 1;
4319 }
4320
4321 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4322 hs_buf->is_complete ? "" : "not yet " ) );
4323 }
4324
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004325 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004326 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004327
4328 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004329 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004330 break;
4331 }
4332
4333exit:
4334
4335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4336 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004337}
4338#endif /* MBEDTLS_SSL_PROTO_DTLS */
4339
Hanno Becker1097b342018-08-15 14:09:41 +01004340static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004341{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004342 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004343 * Consume last content-layer message and potentially
4344 * update in_msglen which keeps track of the contents'
4345 * consumption state.
4346 *
4347 * (1) Handshake messages:
4348 * Remove last handshake message, move content
4349 * and adapt in_msglen.
4350 *
4351 * (2) Alert messages:
4352 * Consume whole record content, in_msglen = 0.
4353 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004354 * (3) Change cipher spec:
4355 * Consume whole record content, in_msglen = 0.
4356 *
4357 * (4) Application data:
4358 * Don't do anything - the record layer provides
4359 * the application data as a stream transport
4360 * and consumes through mbedtls_ssl_read only.
4361 *
4362 */
4363
4364 /* Case (1): Handshake messages */
4365 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004366 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004367 /* Hard assertion to be sure that no application data
4368 * is in flight, as corrupting ssl->in_msglen during
4369 * ssl->in_offt != NULL is fatal. */
4370 if( ssl->in_offt != NULL )
4371 {
4372 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4373 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4374 }
4375
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004376 /*
4377 * Get next Handshake message in the current record
4378 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004379
Hanno Becker4a810fb2017-05-24 16:27:30 +01004380 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004381 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382 * current handshake content: If DTLS handshake
4383 * fragmentation is used, that's the fragment
4384 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004385 * size here is faulty and should be changed at
4386 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004387 * (2) While it doesn't seem to cause problems, one
4388 * has to be very careful not to assume that in_hslen
4389 * is always <= in_msglen in a sensible communication.
4390 * Again, it's wrong for DTLS handshake fragmentation.
4391 * The following check is therefore mandatory, and
4392 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004393 * Additionally, ssl->in_hslen might be arbitrarily out of
4394 * bounds after handling a DTLS message with an unexpected
4395 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004396 */
4397 if( ssl->in_hslen < ssl->in_msglen )
4398 {
4399 ssl->in_msglen -= ssl->in_hslen;
4400 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4401 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004402
Hanno Becker4a810fb2017-05-24 16:27:30 +01004403 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4404 ssl->in_msg, ssl->in_msglen );
4405 }
4406 else
4407 {
4408 ssl->in_msglen = 0;
4409 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004410
Hanno Becker4a810fb2017-05-24 16:27:30 +01004411 ssl->in_hslen = 0;
4412 }
4413 /* Case (4): Application data */
4414 else if( ssl->in_offt != NULL )
4415 {
4416 return( 0 );
4417 }
4418 /* Everything else (CCS & Alerts) */
4419 else
4420 {
4421 ssl->in_msglen = 0;
4422 }
4423
Hanno Becker1097b342018-08-15 14:09:41 +01004424 return( 0 );
4425}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004426
Hanno Beckere74d5562018-08-15 14:26:08 +01004427static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4428{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004429 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004430 return( 1 );
4431
4432 return( 0 );
4433}
4434
Hanno Becker5f066e72018-08-16 14:56:31 +01004435#if defined(MBEDTLS_SSL_PROTO_DTLS)
4436
4437static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4438{
4439 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4440 if( hs == NULL )
4441 return;
4442
Hanno Becker01315ea2018-08-21 17:22:17 +01004443 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004444 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004445 hs->buffering.total_bytes_buffered -=
4446 hs->buffering.future_record.len;
4447
4448 mbedtls_free( hs->buffering.future_record.data );
4449 hs->buffering.future_record.data = NULL;
4450 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004451}
4452
4453static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4454{
4455 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4456 unsigned char * rec;
4457 size_t rec_len;
4458 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004459#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4460 size_t in_buf_len = ssl->in_buf_len;
4461#else
4462 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4463#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004464 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4465 return( 0 );
4466
4467 if( hs == NULL )
4468 return( 0 );
4469
Hanno Becker5f066e72018-08-16 14:56:31 +01004470 rec = hs->buffering.future_record.data;
4471 rec_len = hs->buffering.future_record.len;
4472 rec_epoch = hs->buffering.future_record.epoch;
4473
4474 if( rec == NULL )
4475 return( 0 );
4476
Hanno Becker4cb782d2018-08-20 11:19:05 +01004477 /* Only consider loading future records if the
4478 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004479 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004480 return( 0 );
4481
Hanno Becker5f066e72018-08-16 14:56:31 +01004482 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4483
4484 if( rec_epoch != ssl->in_epoch )
4485 {
4486 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4487 goto exit;
4488 }
4489
4490 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4491
4492 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004493 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004494 {
4495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4496 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4497 }
4498
4499 memcpy( ssl->in_hdr, rec, rec_len );
4500 ssl->in_left = rec_len;
4501 ssl->next_record_offset = 0;
4502
4503 ssl_free_buffered_record( ssl );
4504
4505exit:
4506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4507 return( 0 );
4508}
4509
Hanno Becker519f15d2019-07-11 12:43:20 +01004510static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4511 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004512{
4513 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004514
4515 /* Don't buffer future records outside handshakes. */
4516 if( hs == NULL )
4517 return( 0 );
4518
4519 /* Only buffer handshake records (we are only interested
4520 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004521 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004522 return( 0 );
4523
4524 /* Don't buffer more than one future epoch record. */
4525 if( hs->buffering.future_record.data != NULL )
4526 return( 0 );
4527
Hanno Becker01315ea2018-08-21 17:22:17 +01004528 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004529 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004530 hs->buffering.total_bytes_buffered ) )
4531 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004532 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4533 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4534 " (already %" MBEDTLS_PRINTF_SIZET
4535 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004536 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004537 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004538 return( 0 );
4539 }
4540
Hanno Becker5f066e72018-08-16 14:56:31 +01004541 /* Buffer record */
4542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004543 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004544 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004545
4546 /* ssl_parse_record_header() only considers records
4547 * of the next epoch as candidates for buffering. */
4548 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004549 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004550
4551 hs->buffering.future_record.data =
4552 mbedtls_calloc( 1, hs->buffering.future_record.len );
4553 if( hs->buffering.future_record.data == NULL )
4554 {
4555 /* If we run out of RAM trying to buffer a
4556 * record from the next epoch, just ignore. */
4557 return( 0 );
4558 }
4559
Hanno Becker519f15d2019-07-11 12:43:20 +01004560 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004561
Hanno Becker519f15d2019-07-11 12:43:20 +01004562 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004563 return( 0 );
4564}
4565
4566#endif /* MBEDTLS_SSL_PROTO_DTLS */
4567
Hanno Beckere74d5562018-08-15 14:26:08 +01004568static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004569{
Janos Follath865b3eb2019-12-16 11:46:15 +00004570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004571 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004572
Hanno Becker5f066e72018-08-16 14:56:31 +01004573#if defined(MBEDTLS_SSL_PROTO_DTLS)
4574 /* We might have buffered a future record; if so,
4575 * and if the epoch matches now, load it.
4576 * On success, this call will set ssl->in_left to
4577 * the length of the buffered record, so that
4578 * the calls to ssl_fetch_input() below will
4579 * essentially be no-ops. */
4580 ret = ssl_load_buffered_record( ssl );
4581 if( ret != 0 )
4582 return( ret );
4583#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004584
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004585 /* Ensure that we have enough space available for the default form
4586 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4587 * with no space for CIDs counted in). */
4588 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4589 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004590 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004591 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004592 return( ret );
4593 }
4594
Hanno Beckere5e7e782019-07-11 12:29:35 +01004595 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4596 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004597 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004599 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004600 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004601 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4602 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004603 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004604 if( ret != 0 )
4605 return( ret );
4606
4607 /* Fall through to handling of unexpected records */
4608 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4609 }
4610
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004611 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4612 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004613#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004614 /* Reset in pointers to default state for TLS/DTLS records,
4615 * assuming no CID and no offset between record content and
4616 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004617 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004618
Hanno Becker7ae20e02019-07-12 08:33:49 +01004619 /* Setup internal message pointers from record structure. */
4620 ssl->in_msgtype = rec.type;
4621#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4622 ssl->in_len = ssl->in_cid + rec.cid_len;
4623#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4624 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4625 ssl->in_msglen = rec.data_len;
4626
Hanno Becker2fddd372019-07-10 14:37:41 +01004627 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004628 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004629 if( ret != 0 )
4630 return( ret );
4631#endif
4632
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004633 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004634 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004635
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4637 "(header)" ) );
4638 }
4639 else
4640 {
4641 /* Skip invalid record and the rest of the datagram */
4642 ssl->next_record_offset = 0;
4643 ssl->in_left = 0;
4644
4645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4646 "(header)" ) );
4647 }
4648
4649 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004650 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004651 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004652 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004653#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004654 {
4655 return( ret );
4656 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004657 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004660 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004661 {
Hanno Beckera8814792019-07-10 15:01:45 +01004662 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004663 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004664 if( ssl->next_record_offset < ssl->in_left )
4665 {
4666 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4667 }
4668 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004669 else
4670#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004671 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004672 /*
4673 * Fetch record contents from underlying transport.
4674 */
Hanno Beckera3175662019-07-11 12:50:29 +01004675 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004676 if( ret != 0 )
4677 {
4678 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4679 return( ret );
4680 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004681
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004682 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004683 }
4684
4685 /*
4686 * Decrypt record contents.
4687 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004688
Hanno Beckerfdf66042019-07-11 13:07:45 +01004689 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004690 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004692 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004693 {
4694 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004695 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004696 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004697 /* Except when waiting for Finished as a bad mac here
4698 * probably means something went wrong in the handshake
4699 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4700 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4701 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4702 {
4703#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4704 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4705 {
4706 mbedtls_ssl_send_alert_message( ssl,
4707 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4708 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4709 }
4710#endif
4711 return( ret );
4712 }
4713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004715 if( ssl->conf->badmac_limit != 0 &&
4716 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004717 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4719 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004720 }
4721#endif
4722
Hanno Becker4a810fb2017-05-24 16:27:30 +01004723 /* As above, invalid records cause
4724 * dismissal of the whole datagram. */
4725
4726 ssl->next_record_offset = 0;
4727 ssl->in_left = 0;
4728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004730 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004731 }
4732
4733 return( ret );
4734 }
4735 else
4736#endif
4737 {
4738 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4740 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004741 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004742 mbedtls_ssl_send_alert_message( ssl,
4743 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4744 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004745 }
4746#endif
4747 return( ret );
4748 }
4749 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004750
Hanno Becker44d89b22019-07-12 09:40:44 +01004751
4752 /* Reset in pointers to default state for TLS/DTLS records,
4753 * assuming no CID and no offset between record content and
4754 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004755 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004756#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4757 ssl->in_len = ssl->in_cid + rec.cid_len;
4758#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004759 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004760
Hanno Becker8685c822019-07-12 09:37:30 +01004761 /* The record content type may change during decryption,
4762 * so re-read it. */
4763 ssl->in_msgtype = rec.type;
4764 /* Also update the input buffer, because unfortunately
4765 * the server-side ssl_parse_client_hello() reparses the
4766 * record header when receiving a ClientHello initiating
4767 * a renegotiation. */
4768 ssl->in_hdr[0] = rec.type;
4769 ssl->in_msg = rec.buf + rec.data_offset;
4770 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004771 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004772
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004773#if defined(MBEDTLS_ZLIB_SUPPORT)
4774 if( ssl->transform_in != NULL &&
4775 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4776 {
4777 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4778 {
4779 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4780 return( ret );
4781 }
4782
4783 /* Check actual (decompress) record content length against
4784 * configured maximum. */
4785 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4786 {
4787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4788 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4789 }
4790 }
4791#endif /* MBEDTLS_ZLIB_SUPPORT */
4792
Simon Butcher99000142016-10-13 17:21:01 +01004793 return( 0 );
4794}
4795
4796int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4797{
Janos Follath865b3eb2019-12-16 11:46:15 +00004798 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004799
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004800 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004801 * Handle particular types of records
4802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004804 {
Simon Butcher99000142016-10-13 17:21:01 +01004805 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4806 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004807 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004808 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004809 }
4810
Hanno Beckere678eaa2018-08-21 14:57:46 +01004811 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004812 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004813 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004814 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004815 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004816 ssl->in_msglen ) );
4817 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004818 }
4819
Hanno Beckere678eaa2018-08-21 14:57:46 +01004820 if( ssl->in_msg[0] != 1 )
4821 {
4822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4823 ssl->in_msg[0] ) );
4824 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4825 }
4826
4827#if defined(MBEDTLS_SSL_PROTO_DTLS)
4828 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4829 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4830 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4831 {
4832 if( ssl->handshake == NULL )
4833 {
4834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4835 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4836 }
4837
4838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4839 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4840 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004841#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004842 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004845 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004846 if( ssl->in_msglen != 2 )
4847 {
4848 /* Note: Standard allows for more than one 2 byte alert
4849 to be packed in a single message, but Mbed TLS doesn't
4850 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004852 ssl->in_msglen ) );
4853 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4854 }
4855
Paul Elliott9f352112020-12-09 14:55:45 +00004856 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004857 ssl->in_msg[0], ssl->in_msg[1] ) );
4858
4859 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004860 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004865 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004867 }
4868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4870 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4873 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004874 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004875
4876#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4877 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4878 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4879 {
Hanno Becker90333da2017-10-10 11:27:13 +01004880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004881 /* Will be handled when trying to parse ServerHello */
4882 return( 0 );
4883 }
4884#endif
4885
4886#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4887 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4888 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4889 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4890 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4891 {
4892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4893 /* Will be handled in mbedtls_ssl_parse_certificate() */
4894 return( 0 );
4895 }
4896#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4897
4898 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004899 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004900 }
4901
Hanno Beckerc76c6192017-06-06 10:03:17 +01004902#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004903 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004904 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004905 /* Drop unexpected ApplicationData records,
4906 * except at the beginning of renegotiations */
4907 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4908 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4909#if defined(MBEDTLS_SSL_RENEGOTIATION)
4910 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4911 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004912#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004913 )
4914 {
4915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4916 return( MBEDTLS_ERR_SSL_NON_FATAL );
4917 }
4918
4919 if( ssl->handshake != NULL &&
4920 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4921 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004922 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004923 }
4924 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004925#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004926
Paul Bakker5121ce52009-01-03 21:22:43 +00004927 return( 0 );
4928}
4929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004931{
irwir6c0da642019-09-26 21:07:41 +03004932 return( mbedtls_ssl_send_alert_message( ssl,
4933 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4934 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004935}
4936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004938 unsigned char level,
4939 unsigned char message )
4940{
Janos Follath865b3eb2019-12-16 11:46:15 +00004941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004942
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004943 if( ssl == NULL || ssl->conf == NULL )
4944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4945
Hanno Beckerd9c66c02018-08-06 11:35:16 +01004946 if( ssl->out_left != 0 )
4947 return( mbedtls_ssl_flush_output( ssl ) );
4948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004949 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004950 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004951
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004952 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004953 ssl->out_msglen = 2;
4954 ssl->out_msg[0] = level;
4955 ssl->out_msg[1] = message;
4956
Hanno Becker67bc7c32018-08-06 11:33:50 +01004957 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004960 return( ret );
4961 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004963
4964 return( 0 );
4965}
4966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004968{
Janos Follath865b3eb2019-12-16 11:46:15 +00004969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004971 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004974 ssl->out_msglen = 1;
4975 ssl->out_msg[0] = 1;
4976
Paul Bakker5121ce52009-01-03 21:22:43 +00004977 ssl->state++;
4978
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004979 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004980 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004981 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004982 return( ret );
4983 }
4984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004986
4987 return( 0 );
4988}
4989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004991{
Janos Follath865b3eb2019-12-16 11:46:15 +00004992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004993
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004995
Hanno Becker327c93b2018-08-15 13:56:18 +01004996 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004997 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004999 return( ret );
5000 }
5001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005002 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005003 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005005 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5006 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005008 }
5009
Hanno Beckere678eaa2018-08-21 14:57:46 +01005010 /* CCS records are only accepted if they have length 1 and content '1',
5011 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005012
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005013 /*
5014 * Switch to our negotiated transform and session parameters for inbound
5015 * data.
5016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005018 ssl->transform_in = ssl->transform_negotiate;
5019 ssl->session_in = ssl->session_negotiate;
5020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005022 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005023 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005024#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005025 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005026#endif
5027
5028 /* Increment epoch */
5029 if( ++ssl->in_epoch == 0 )
5030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005032 /* This is highly unlikely to happen for legitimate reasons, so
5033 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005035 }
5036 }
5037 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005039 memset( ssl->in_ctr, 0, 8 );
5040
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005041 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005043#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5044 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005045 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005048 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005049 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5050 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005052 }
5053 }
5054#endif
5055
Paul Bakker5121ce52009-01-03 21:22:43 +00005056 ssl->state++;
5057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005059
5060 return( 0 );
5061}
5062
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005063/* Once ssl->out_hdr as the address of the beginning of the
5064 * next outgoing record is set, deduce the other pointers.
5065 *
5066 * Note: For TLS, we save the implicit record sequence number
5067 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5068 * and the caller has to make sure there's space for this.
5069 */
5070
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005071static size_t ssl_transform_get_explicit_iv_len(
5072 mbedtls_ssl_transform const *transform )
5073{
5074 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5075 return( 0 );
5076
5077 return( transform->ivlen - transform->fixed_ivlen );
5078}
5079
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005080void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5081 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005082{
5083#if defined(MBEDTLS_SSL_PROTO_DTLS)
5084 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5085 {
5086 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005087#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005088 ssl->out_cid = ssl->out_ctr + 8;
5089 ssl->out_len = ssl->out_cid;
5090 if( transform != NULL )
5091 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005092#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005093 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005094#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005095 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005096 }
5097 else
5098#endif
5099 {
5100 ssl->out_ctr = ssl->out_hdr - 8;
5101 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005102#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005103 ssl->out_cid = ssl->out_len;
5104#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005105 ssl->out_iv = ssl->out_hdr + 5;
5106 }
5107
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005108 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005109 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005110 if( transform != NULL )
5111 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005112}
5113
5114/* Once ssl->in_hdr as the address of the beginning of the
5115 * next incoming record is set, deduce the other pointers.
5116 *
5117 * Note: For TLS, we save the implicit record sequence number
5118 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5119 * and the caller has to make sure there's space for this.
5120 */
5121
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005122void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005123{
Hanno Becker79594fd2019-05-08 09:38:41 +01005124 /* This function sets the pointers to match the case
5125 * of unprotected TLS/DTLS records, with both ssl->in_iv
5126 * and ssl->in_msg pointing to the beginning of the record
5127 * content.
5128 *
5129 * When decrypting a protected record, ssl->in_msg
5130 * will be shifted to point to the beginning of the
5131 * record plaintext.
5132 */
5133
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005134#if defined(MBEDTLS_SSL_PROTO_DTLS)
5135 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5136 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005137 /* This sets the header pointers to match records
5138 * without CID. When we receive a record containing
5139 * a CID, the fields are shifted accordingly in
5140 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005141 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005142#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005143 ssl->in_cid = ssl->in_ctr + 8;
5144 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005145#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005146 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005147#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005148 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005149 }
5150 else
5151#endif
5152 {
5153 ssl->in_ctr = ssl->in_hdr - 8;
5154 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005155#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005156 ssl->in_cid = ssl->in_len;
5157#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005158 ssl->in_iv = ssl->in_hdr + 5;
5159 }
5160
Hanno Becker79594fd2019-05-08 09:38:41 +01005161 /* This will be adjusted at record decryption time. */
5162 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005163}
5164
Paul Bakker5121ce52009-01-03 21:22:43 +00005165/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005166 * Setup an SSL context
5167 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005168
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005169void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005170{
5171 /* Set the incoming and outgoing record pointers. */
5172#if defined(MBEDTLS_SSL_PROTO_DTLS)
5173 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5174 {
5175 ssl->out_hdr = ssl->out_buf;
5176 ssl->in_hdr = ssl->in_buf;
5177 }
5178 else
5179#endif /* MBEDTLS_SSL_PROTO_DTLS */
5180 {
5181 ssl->out_hdr = ssl->out_buf + 8;
5182 ssl->in_hdr = ssl->in_buf + 8;
5183 }
5184
5185 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005186 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5187 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005188}
5189
Paul Bakker5121ce52009-01-03 21:22:43 +00005190/*
5191 * SSL get accessors
5192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005194{
5195 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5196}
5197
Hanno Becker8b170a02017-10-10 11:51:19 +01005198int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5199{
5200 /*
5201 * Case A: We're currently holding back
5202 * a message for further processing.
5203 */
5204
5205 if( ssl->keep_current_message == 1 )
5206 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005207 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005208 return( 1 );
5209 }
5210
5211 /*
5212 * Case B: Further records are pending in the current datagram.
5213 */
5214
5215#if defined(MBEDTLS_SSL_PROTO_DTLS)
5216 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5217 ssl->in_left > ssl->next_record_offset )
5218 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005219 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005220 return( 1 );
5221 }
5222#endif /* MBEDTLS_SSL_PROTO_DTLS */
5223
5224 /*
5225 * Case C: A handshake message is being processed.
5226 */
5227
Hanno Becker8b170a02017-10-10 11:51:19 +01005228 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5229 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005230 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005231 return( 1 );
5232 }
5233
5234 /*
5235 * Case D: An application data message is being processed
5236 */
5237 if( ssl->in_offt != NULL )
5238 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005239 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005240 return( 1 );
5241 }
5242
5243 /*
5244 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005245 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005246 * we implement support for multiple alerts in single records.
5247 */
5248
5249 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5250 return( 0 );
5251}
5252
Paul Bakker43ca69c2011-01-15 17:35:19 +00005253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005254int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005255{
Hanno Becker3136ede2018-08-17 15:28:19 +01005256 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005257 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005258 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005259
Hanno Becker5903de42019-05-03 14:46:38 +01005260 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5261
Hanno Becker78640902018-08-13 16:35:15 +01005262 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005263 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005265#if defined(MBEDTLS_ZLIB_SUPPORT)
5266 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5267 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005268#endif
5269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005270 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005271 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005272 case MBEDTLS_MODE_GCM:
5273 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005274 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005276 transform_expansion = transform->minlen;
5277 break;
5278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005280
5281 block_size = mbedtls_cipher_get_block_size(
5282 &transform->cipher_ctx_enc );
5283
Hanno Becker3136ede2018-08-17 15:28:19 +01005284 /* Expansion due to the addition of the MAC. */
5285 transform_expansion += transform->maclen;
5286
5287 /* Expansion due to the addition of CBC padding;
5288 * Theoretically up to 256 bytes, but we never use
5289 * more than the block size of the underlying cipher. */
5290 transform_expansion += block_size;
5291
5292 /* For TLS 1.1 or higher, an explicit IV is added
5293 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005294#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5295 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005296 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005297#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005298
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005299 break;
5300
5301 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005302 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005303 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005304 }
5305
Hanno Beckera0e20d02019-05-15 14:03:01 +01005306#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005307 if( transform->out_cid_len != 0 )
5308 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005309#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005310
Hanno Becker5903de42019-05-03 14:46:38 +01005311 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005312}
5313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005314#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005315/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005316 * Check record counters and renegotiate if they're above the limit.
5317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005319{
Hanno Beckerdd772292020-02-05 10:38:31 +00005320 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005321 int in_ctr_cmp;
5322 int out_ctr_cmp;
5323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5325 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005326 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005327 {
5328 return( 0 );
5329 }
5330
Andres AG2196c7f2016-12-15 17:01:16 +00005331 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5332 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005333 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005334 ssl->conf->renego_period + ep_len, 8 - ep_len );
5335
5336 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005337 {
5338 return( 0 );
5339 }
5340
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005343}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005344#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005345
5346/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005347 * Receive application data decrypted from the SSL layer
5348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005349int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005350{
Janos Follath865b3eb2019-12-16 11:46:15 +00005351 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005352 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005353
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005354 if( ssl == NULL || ssl->conf == NULL )
5355 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005359#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005360 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005361 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005363 return( ret );
5364
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005365 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005367 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005368 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005369 return( ret );
5370 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005371 }
5372#endif
5373
Hanno Becker4a810fb2017-05-24 16:27:30 +01005374 /*
5375 * Check if renegotiation is necessary and/or handshake is
5376 * in process. If yes, perform/continue, and fall through
5377 * if an unexpected packet is received while the client
5378 * is waiting for the ServerHello.
5379 *
5380 * (There is no equivalent to the last condition on
5381 * the server-side as it is not treated as within
5382 * a handshake while waiting for the ClientHello
5383 * after a renegotiation request.)
5384 */
5385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005387 ret = ssl_check_ctr_renegotiate( ssl );
5388 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5389 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005390 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005392 return( ret );
5393 }
5394#endif
5395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005397 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005398 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005399 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5400 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005401 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005403 return( ret );
5404 }
5405 }
5406
Hanno Beckere41158b2017-10-23 13:30:32 +01005407 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005408 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005409 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005410 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005411 if( ssl->f_get_timer != NULL &&
5412 ssl->f_get_timer( ssl->p_timer ) == -1 )
5413 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005414 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005415 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005416
Hanno Becker327c93b2018-08-15 13:56:18 +01005417 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005418 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005419 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5420 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005421
Hanno Becker4a810fb2017-05-24 16:27:30 +01005422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5423 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005424 }
5425
5426 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005428 {
5429 /*
5430 * OpenSSL sends empty messages to randomize the IV
5431 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005432 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005433 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005435 return( 0 );
5436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005438 return( ret );
5439 }
5440 }
5441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005443 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005444 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005445
Hanno Becker4a810fb2017-05-24 16:27:30 +01005446 /*
5447 * - For client-side, expect SERVER_HELLO_REQUEST.
5448 * - For server-side, expect CLIENT_HELLO.
5449 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5450 */
5451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005453 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005455 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005458
5459 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005461 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005462 {
5463 continue;
5464 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005465#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005467 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005468#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005469
Hanno Becker4a810fb2017-05-24 16:27:30 +01005470#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005471 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005473 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005475
5476 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005478 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005479 {
5480 continue;
5481 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005482#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005484 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005485#endif /* MBEDTLS_SSL_SRV_C */
5486
Hanno Becker21df7f92017-10-17 11:03:26 +01005487#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005488 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005489 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5490 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5491 ssl->conf->allow_legacy_renegotiation ==
5492 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5493 {
5494 /*
5495 * Accept renegotiation request
5496 */
Paul Bakker48916f92012-09-16 19:57:18 +00005497
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005498 /* DTLS clients need to know renego is server-initiated */
5499#if defined(MBEDTLS_SSL_PROTO_DTLS)
5500 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5501 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5502 {
5503 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5504 }
5505#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005506 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005507 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5508 ret != 0 )
5509 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005510 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5511 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005512 return( ret );
5513 }
5514 }
5515 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005516#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005517 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005518 /*
5519 * Refuse renegotiation
5520 */
5521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005524#if defined(MBEDTLS_SSL_PROTO_SSL3)
5525 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005526 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005527 /* SSLv3 does not have a "no_renegotiation" warning, so
5528 we send a fatal alert and abort the connection. */
5529 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5530 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5531 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005532 }
5533 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005534#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5535#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5536 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5537 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005538 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005539 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5540 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5541 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005542 {
5543 return( ret );
5544 }
Paul Bakker48916f92012-09-16 19:57:18 +00005545 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005546 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5548 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005552 }
Paul Bakker48916f92012-09-16 19:57:18 +00005553 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005554
Hanno Becker90333da2017-10-10 11:27:13 +01005555 /* At this point, we don't know whether the renegotiation has been
5556 * completed or not. The cases to consider are the following:
5557 * 1) The renegotiation is complete. In this case, no new record
5558 * has been read yet.
5559 * 2) The renegotiation is incomplete because the client received
5560 * an application data record while awaiting the ServerHello.
5561 * 3) The renegotiation is incomplete because the client received
5562 * a non-handshake, non-application data message while awaiting
5563 * the ServerHello.
5564 * In each of these case, looping will be the proper action:
5565 * - For 1), the next iteration will read a new record and check
5566 * if it's application data.
5567 * - For 2), the loop condition isn't satisfied as application data
5568 * is present, hence continue is the same as break
5569 * - For 3), the loop condition is satisfied and read_record
5570 * will re-deliver the message that was held back by the client
5571 * when expecting the ServerHello.
5572 */
5573 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005574 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005575#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005577 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005578 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005579 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005580 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005581 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005583 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005585 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005586 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005587 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005588#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5591 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005594 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005595 }
5596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005598 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5600 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005601 }
5602
5603 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005604
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005605 /* We're going to return something now, cancel timer,
5606 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005607 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005608 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005609
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005610#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005611 /* If we requested renego but received AppData, resend HelloRequest.
5612 * Do it now, after setting in_offt, to avoid taking this branch
5613 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005615 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005616 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005617 {
Hanno Becker786300f2020-02-05 10:46:40 +00005618 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005619 {
Hanno Becker786300f2020-02-05 10:46:40 +00005620 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5621 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005622 return( ret );
5623 }
5624 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005626#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005627 }
5628
5629 n = ( len < ssl->in_msglen )
5630 ? len : ssl->in_msglen;
5631
5632 memcpy( buf, ssl->in_offt, n );
5633 ssl->in_msglen -= n;
5634
gabor-mezei-arma3214132020-07-15 10:55:00 +02005635 /* Zeroising the plaintext buffer to erase unused application data
5636 from the memory. */
5637 mbedtls_platform_zeroize( ssl->in_offt, n );
5638
Paul Bakker5121ce52009-01-03 21:22:43 +00005639 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005640 {
5641 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005642 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005643 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005644 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005645 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005646 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005647 /* more data available */
5648 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005649 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005652
Paul Bakker23986e52011-04-24 08:57:21 +00005653 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005654}
5655
5656/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005657 * Send application data to be encrypted by the SSL layer, taking care of max
5658 * fragment length and buffer size.
5659 *
5660 * According to RFC 5246 Section 6.2.1:
5661 *
5662 * Zero-length fragments of Application data MAY be sent as they are
5663 * potentially useful as a traffic analysis countermeasure.
5664 *
5665 * Therefore, it is possible that the input message length is 0 and the
5666 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005667 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005668static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005669 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005670{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005671 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5672 const size_t max_len = (size_t) ret;
5673
5674 if( ret < 0 )
5675 {
5676 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5677 return( ret );
5678 }
5679
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005680 if( len > max_len )
5681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005683 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005686 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5687 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005688 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005690 }
5691 else
5692#endif
5693 len = max_len;
5694 }
Paul Bakker887bd502011-06-08 13:10:54 +00005695
Paul Bakker5121ce52009-01-03 21:22:43 +00005696 if( ssl->out_left != 0 )
5697 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005698 /*
5699 * The user has previously tried to send the data and
5700 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5701 * written. In this case, we expect the high-level write function
5702 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005704 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005706 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005707 return( ret );
5708 }
5709 }
Paul Bakker887bd502011-06-08 13:10:54 +00005710 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005711 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005712 /*
5713 * The user is trying to send a message the first time, so we need to
5714 * copy the data into the internal buffers and setup the data structure
5715 * to keep track of partial writes
5716 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005717 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005718 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005719 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005720
Hanno Becker67bc7c32018-08-06 11:33:50 +01005721 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005722 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005723 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005724 return( ret );
5725 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005726 }
5727
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005728 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005729}
5730
5731/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005732 * Write application data, doing 1/n-1 splitting if necessary.
5733 *
5734 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005735 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005736 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005739static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005740 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005741{
Janos Follath865b3eb2019-12-16 11:46:15 +00005742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005743
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005744 if( ssl->conf->cbc_record_splitting ==
5745 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005746 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5748 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5749 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005750 {
5751 return( ssl_write_real( ssl, buf, len ) );
5752 }
5753
5754 if( ssl->split_done == 0 )
5755 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005756 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005757 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005758 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005759 }
5760
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005761 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5762 return( ret );
5763 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005764
5765 return( ret + 1 );
5766}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005767#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005768
5769/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005770 * Write application data (public-facing wrapper)
5771 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005772int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005773{
Janos Follath865b3eb2019-12-16 11:46:15 +00005774 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005775
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005777
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005778 if( ssl == NULL || ssl->conf == NULL )
5779 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5780
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005781#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005782 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5783 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005784 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005785 return( ret );
5786 }
5787#endif
5788
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005789 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005790 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005791 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005792 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005793 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005794 return( ret );
5795 }
5796 }
5797
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005798#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005799 ret = ssl_write_split( ssl, buf, len );
5800#else
5801 ret = ssl_write_real( ssl, buf, len );
5802#endif
5803
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005805
5806 return( ret );
5807}
5808
5809/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005810 * Notify the peer that the connection is being closed
5811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005812int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005813{
Janos Follath865b3eb2019-12-16 11:46:15 +00005814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005815
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005816 if( ssl == NULL || ssl->conf == NULL )
5817 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5818
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005819 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005821 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005822 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5824 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5825 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005827 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005828 return( ret );
5829 }
5830 }
5831
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005833
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005834 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005835}
5836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005837void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005838{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005839 if( transform == NULL )
5840 return;
5841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005842#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005843 deflateEnd( &transform->ctx_deflate );
5844 inflateEnd( &transform->ctx_inflate );
5845#endif
5846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005847 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5848 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005849
Hanno Beckerd56ed242018-01-03 15:32:51 +00005850#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005851 mbedtls_md_free( &transform->md_ctx_enc );
5852 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005853#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005854
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005855 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005856}
5857
Hanno Becker0271f962018-08-16 13:23:47 +01005858#if defined(MBEDTLS_SSL_PROTO_DTLS)
5859
Hanno Becker533ab5f2020-02-05 10:49:13 +00005860void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005861{
5862 unsigned offset;
5863 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5864
5865 if( hs == NULL )
5866 return;
5867
Hanno Becker283f5ef2018-08-24 09:34:47 +01005868 ssl_free_buffered_record( ssl );
5869
Hanno Becker0271f962018-08-16 13:23:47 +01005870 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005871 ssl_buffering_free_slot( ssl, offset );
5872}
5873
5874static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5875 uint8_t slot )
5876{
5877 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5878 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005879
5880 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5881 return;
5882
Hanno Beckere605b192018-08-21 15:59:07 +01005883 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005884 {
Hanno Beckere605b192018-08-21 15:59:07 +01005885 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005886 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005887 mbedtls_free( hs_buf->data );
5888 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005889 }
5890}
5891
5892#endif /* MBEDTLS_SSL_PROTO_DTLS */
5893
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005894/*
5895 * Convert version numbers to/from wire format
5896 * and, for DTLS, to/from TLS equivalent.
5897 *
5898 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005899 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005900 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5901 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005903void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005904 unsigned char ver[2] )
5905{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005906#if defined(MBEDTLS_SSL_PROTO_DTLS)
5907 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005908 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005910 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5911
5912 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5913 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5914 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005915 else
5916#else
5917 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005918#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005919 {
5920 ver[0] = (unsigned char) major;
5921 ver[1] = (unsigned char) minor;
5922 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005923}
5924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005925void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005926 const unsigned char ver[2] )
5927{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005928#if defined(MBEDTLS_SSL_PROTO_DTLS)
5929 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005930 {
5931 *major = 255 - ver[0] + 2;
5932 *minor = 255 - ver[1] + 1;
5933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005934 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005935 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5936 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005937 else
5938#else
5939 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005940#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005941 {
5942 *major = ver[0];
5943 *minor = ver[1];
5944 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005945}
5946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005947#endif /* MBEDTLS_SSL_TLS_C */