blob: 020abf637e3af1945ff1ef92ddd97ce7c1738c4b [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
21 * The SSL 3.0 specification was drafted by Netscape in 1996,
22 * and became an IETF standard in 1999.
23 *
24 * http://wp.netscape.com/eng/ssl3/
25 * http://www.ietf.org/rfc/rfc2246.txt
26 * http://www.ietf.org/rfc/rfc4346.txt
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000032
SimonBd5800b72016-04-26 07:43:27 +010033#if defined(MBEDTLS_PLATFORM_C)
34#include "mbedtls/platform.h"
35#else
36#include <stdlib.h>
37#define mbedtls_calloc calloc
38#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010039#endif
40
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020042#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000043#include "mbedtls/debug.h"
44#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050045#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010046#include "mbedtls/version.h"
gabor-mezei-arm944c1072021-09-27 11:28:54 +020047#include "constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020048
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020049#include "ssl_invasive.h"
50
Rich Evans00ab4702015-02-06 13:43:58 +000051#include <string.h>
52
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050053#if defined(MBEDTLS_USE_PSA_CRYPTO)
54#include "mbedtls/psa_util.h"
55#include "psa/crypto.h"
56#endif
57
Janos Follath23bdca02016-10-07 14:47:14 +010058#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000059#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020060#endif
61
Hanno Beckercd9dcda2018-08-28 17:18:56 +010062static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010063
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020064/*
65 * Start a timer.
66 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020067 */
Hanno Becker0f57a652020-02-05 10:37:26 +000068void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020069{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020070 if( ssl->f_set_timer == NULL )
71 return;
72
73 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
74 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020075}
76
77/*
78 * Return -1 is timer is expired, 0 if it isn't.
79 */
Hanno Becker7876d122020-02-05 10:39:31 +000080int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020081{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020082 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020083 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020084
85 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020086 {
87 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020088 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020090
91 return( 0 );
92}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020093
Hanno Beckercfe45792019-07-03 16:13:00 +010094#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010095static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
96 unsigned char *buf,
97 size_t len,
98 mbedtls_record *rec );
99
Hanno Beckercfe45792019-07-03 16:13:00 +0100100int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
101 unsigned char *buf,
102 size_t buflen )
103{
Hanno Becker54229812019-07-12 14:40:00 +0100104 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100105 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
106 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
107
108 /* We don't support record checking in TLS because
109 * (a) there doesn't seem to be a usecase for it, and
110 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
111 * and we'd need to backup the transform here.
112 */
113 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
114 {
115 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
116 goto exit;
117 }
118#if defined(MBEDTLS_SSL_PROTO_DTLS)
119 else
120 {
irwir734f0cf2019-09-26 21:03:24 +0300121 mbedtls_record rec;
122
Hanno Becker54229812019-07-12 14:40:00 +0100123 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
124 if( ret != 0 )
125 {
126 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
127 goto exit;
128 }
129
130 if( ssl->transform_in != NULL )
131 {
132 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
133 if( ret != 0 )
134 {
135 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
136 goto exit;
137 }
138 }
139 }
140#endif /* MBEDTLS_SSL_PROTO_DTLS */
141
142exit:
143 /* On success, we have decrypted the buffer in-place, so make
144 * sure we don't leak any plaintext data. */
145 mbedtls_platform_zeroize( buf, buflen );
146
147 /* For the purpose of this API, treat messages with unexpected CID
148 * as well as such from future epochs as unexpected. */
149 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
150 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
151 {
152 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
153 }
154
155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
156 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100157}
158#endif /* MBEDTLS_SSL_RECORD_CHECKING */
159
Hanno Becker67bc7c32018-08-06 11:33:50 +0100160#define SSL_DONT_FORCE_FLUSH 0
161#define SSL_FORCE_FLUSH 1
162
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200163#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100164
Hanno Beckerd5847772018-08-28 10:09:23 +0100165/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100166static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
167 uint8_t slot );
168static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
170static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
171static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100172static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
173 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100174static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100175
Hanno Becker11682cc2018-08-22 14:41:02 +0100176static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100177{
Hanno Becker89490712020-02-05 10:50:12 +0000178 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000179#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
180 size_t out_buf_len = ssl->out_buf_len;
181#else
182 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
183#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100184
Darryl Greenb33cc762019-11-28 14:29:44 +0000185 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100186 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100187
Darryl Greenb33cc762019-11-28 14:29:44 +0000188 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100189}
190
Hanno Becker67bc7c32018-08-06 11:33:50 +0100191static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
192{
Hanno Becker11682cc2018-08-22 14:41:02 +0100193 size_t const bytes_written = ssl->out_left;
194 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100195
196 /* Double-check that the write-index hasn't gone
197 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100198 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100199 {
200 /* Should never happen... */
201 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
202 }
203
204 return( (int) ( mtu - bytes_written ) );
205}
206
207static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
208{
Janos Follath865b3eb2019-12-16 11:46:15 +0000209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100210 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400211 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100212
213#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400214 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100215
216 if( max_len > mfl )
217 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100218
219 /* By the standard (RFC 6066 Sect. 4), the MFL extension
220 * only limits the maximum record payload size, so in theory
221 * we would be allowed to pack multiple records of payload size
222 * MFL into a single datagram. However, this would mean that there's
223 * no way to explicitly communicate MTU restrictions to the peer.
224 *
225 * The following reduction of max_len makes sure that we never
226 * write datagrams larger than MFL + Record Expansion Overhead.
227 */
228 if( max_len <= ssl->out_left )
229 return( 0 );
230
231 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100232#endif
233
234 ret = ssl_get_remaining_space_in_datagram( ssl );
235 if( ret < 0 )
236 return( ret );
237 remaining = (size_t) ret;
238
239 ret = mbedtls_ssl_get_record_expansion( ssl );
240 if( ret < 0 )
241 return( ret );
242 expansion = (size_t) ret;
243
244 if( remaining <= expansion )
245 return( 0 );
246
247 remaining -= expansion;
248 if( remaining >= max_len )
249 remaining = max_len;
250
251 return( (int) remaining );
252}
253
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254/*
255 * Double the retransmit timeout value, within the allowed range,
256 * returning -1 if the maximum value has already been reached.
257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200259{
260 uint32_t new_timeout;
261
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200262 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200263 return( -1 );
264
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200265 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
266 * in the following way: after the initial transmission and a first
267 * retransmission, back off to a temporary estimated MTU of 508 bytes.
268 * This value is guaranteed to be deliverable (if not guaranteed to be
269 * delivered) of any compliant IPv4 (and IPv6) network, and should work
270 * on most non-IP stacks too. */
271 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400272 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200273 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
275 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200276
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200277 new_timeout = 2 * ssl->handshake->retransmit_timeout;
278
279 /* Avoid arithmetic overflow and range overflow */
280 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200281 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200282 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200283 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200284 }
285
286 ssl->handshake->retransmit_timeout = new_timeout;
Paul Elliott9f352112020-12-09 14:55:45 +0000287 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
288 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289
290 return( 0 );
291}
292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200294{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200295 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Paul Elliott9f352112020-12-09 14:55:45 +0000296 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %lu millisecs",
297 (unsigned long) ssl->handshake->retransmit_timeout ) );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200298}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
302int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200303 const unsigned char *key_enc, const unsigned char *key_dec,
304 size_t keylen,
305 const unsigned char *iv_enc, const unsigned char *iv_dec,
306 size_t ivlen,
307 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200308 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
310int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
313int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
314#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000315
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100316/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000317 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200318 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000319
Hanno Beckerccc13d02020-05-04 12:30:04 +0100320#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
321 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100322
323static size_t ssl_compute_padding_length( size_t len,
324 size_t granularity )
325{
326 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
327}
328
Hanno Becker581bc1b2020-05-04 12:20:03 +0100329/* This functions transforms a (D)TLS plaintext fragment and a record content
330 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
331 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
332 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100333 *
334 * struct {
335 * opaque content[DTLSPlaintext.length];
336 * ContentType real_type;
337 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100338 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100339 *
340 * Input:
341 * - `content`: The beginning of the buffer holding the
342 * plaintext to be wrapped.
343 * - `*content_size`: The length of the plaintext in Bytes.
344 * - `max_len`: The number of Bytes available starting from
345 * `content`. This must be `>= *content_size`.
346 * - `rec_type`: The desired record content type.
347 *
348 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100349 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
350 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100351 *
352 * Returns:
353 * - `0` on success.
354 * - A negative error code if `max_len` didn't offer enough space
355 * for the expansion.
356 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100357static int ssl_build_inner_plaintext( unsigned char *content,
358 size_t *content_size,
359 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100360 uint8_t rec_type,
361 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100362{
363 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100364
365 /* Write real content type */
366 if( remaining == 0 )
367 return( -1 );
368 content[ len ] = rec_type;
369 len++;
370 remaining--;
371
372 if( remaining < pad )
373 return( -1 );
374 memset( content + len, 0, pad );
375 len += pad;
376 remaining -= pad;
377
378 *content_size = len;
379 return( 0 );
380}
381
Hanno Becker581bc1b2020-05-04 12:20:03 +0100382/* This function parses a (D)TLSInnerPlaintext structure.
383 * See ssl_build_inner_plaintext() for details. */
384static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100385 size_t *content_size,
386 uint8_t *rec_type )
387{
388 size_t remaining = *content_size;
389
390 /* Determine length of padding by skipping zeroes from the back. */
391 do
392 {
393 if( remaining == 0 )
394 return( -1 );
395 remaining--;
396 } while( content[ remaining ] == 0 );
397
398 *content_size = remaining;
399 *rec_type = content[ remaining ];
400
401 return( 0 );
402}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100403#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
404 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100405
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100406/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100407 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000408static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100409 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100410 mbedtls_record *rec,
411 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000412{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100413 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100414 *
415 * additional_data = seq_num + TLSCompressed.type +
416 * TLSCompressed.version + TLSCompressed.length;
417 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100418 * For the CID extension, this is extended as follows
419 * (quoting draft-ietf-tls-dtls-connection-id-05,
420 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100421 *
422 * additional_data = seq_num + DTLSPlaintext.type +
423 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100424 * cid +
425 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100426 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100427 *
428 * For TLS 1.3, the record sequence number is dropped from the AAD
429 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 */
431
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 unsigned char *cur = add_data;
433
434#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
435 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
436#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
437 {
438 ((void) minor_ver);
439 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
440 cur += sizeof( rec->ctr );
441 }
442
443 *cur = rec->type;
444 cur++;
445
446 memcpy( cur, rec->ver, sizeof( rec->ver ) );
447 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100448
Hanno Beckera0e20d02019-05-15 14:03:01 +0100449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100450 if( rec->cid_len != 0 )
451 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100452 memcpy( cur, rec->cid, rec->cid_len );
453 cur += rec->cid_len;
454
455 *cur = rec->cid_len;
456 cur++;
457
Joe Subbianic54e9082021-07-19 11:56:54 +0100458 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100459 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 }
461 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 {
Joe Subbianic54e9082021-07-19 11:56:54 +0100464 MBEDTLS_PUT_UINT16_BE( rec->data_len, cur, 0 );
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100465 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100466 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100467
468 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000469}
470
Hanno Becker9d062f92020-02-07 10:26:36 +0000471#if defined(MBEDTLS_SSL_PROTO_SSL3)
472
473#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
474
475/*
476 * SSLv3.0 MAC functions
477 */
478static void ssl_mac( mbedtls_md_context_t *md_ctx,
479 const unsigned char *secret,
480 const unsigned char *buf, size_t len,
481 const unsigned char *ctr, int type,
482 unsigned char out[SSL3_MAC_MAX_BYTES] )
483{
484 unsigned char header[11];
485 unsigned char padding[48];
486 int padlen;
487 int md_size = mbedtls_md_get_size( md_ctx->md_info );
488 int md_type = mbedtls_md_get_type( md_ctx->md_info );
489
490 /* Only MD5 and SHA-1 supported */
491 if( md_type == MBEDTLS_MD_MD5 )
492 padlen = 48;
493 else
494 padlen = 40;
495
496 memcpy( header, ctr, 8 );
Joe Subbiania651e6f2021-08-23 11:35:25 +0100497 header[8] = (unsigned char) type;
Joe Subbiani11b71312021-08-23 12:49:14 +0100498 MBEDTLS_PUT_UINT16_BE( len, header, 9);
Hanno Becker9d062f92020-02-07 10:26:36 +0000499
500 memset( padding, 0x36, padlen );
501 mbedtls_md_starts( md_ctx );
502 mbedtls_md_update( md_ctx, secret, md_size );
503 mbedtls_md_update( md_ctx, padding, padlen );
504 mbedtls_md_update( md_ctx, header, 11 );
505 mbedtls_md_update( md_ctx, buf, len );
506 mbedtls_md_finish( md_ctx, out );
507
508 memset( padding, 0x5C, padlen );
509 mbedtls_md_starts( md_ctx );
510 mbedtls_md_update( md_ctx, secret, md_size );
511 mbedtls_md_update( md_ctx, padding, padlen );
512 mbedtls_md_update( md_ctx, out, md_size );
513 mbedtls_md_finish( md_ctx, out );
514}
515#endif /* MBEDTLS_SSL_PROTO_SSL3 */
516
Hanno Becker67a37db2020-05-28 16:27:07 +0100517#if defined(MBEDTLS_GCM_C) || \
518 defined(MBEDTLS_CCM_C) || \
519 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100520static int ssl_transform_aead_dynamic_iv_is_explicit(
521 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100522{
Hanno Becker17263802020-05-28 07:05:48 +0100523 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524}
525
Hanno Becker17263802020-05-28 07:05:48 +0100526/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
527 *
528 * Concretely, this occurs in two variants:
529 *
530 * a) Fixed and dynamic IV lengths add up to total IV length, giving
531 * IV = fixed_iv || dynamic_iv
532 *
Hanno Becker15952812020-06-04 13:31:46 +0100533 * This variant is used in TLS 1.2 when used with GCM or CCM.
534 *
Hanno Becker17263802020-05-28 07:05:48 +0100535 * b) Fixed IV lengths matches total IV length, giving
536 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100537 *
538 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
539 *
540 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100541 *
542 * This function has the precondition that
543 *
544 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
545 *
546 * which has to be ensured by the caller. If this precondition
547 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100548 */
549static void ssl_build_record_nonce( unsigned char *dst_iv,
550 size_t dst_iv_len,
551 unsigned char const *fixed_iv,
552 size_t fixed_iv_len,
553 unsigned char const *dynamic_iv,
554 size_t dynamic_iv_len )
555{
556 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100557
558 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100559 memset( dst_iv, 0, dst_iv_len );
560 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100561
Hanno Becker17263802020-05-28 07:05:48 +0100562 dst_iv += dst_iv_len - dynamic_iv_len;
563 for( i = 0; i < dynamic_iv_len; i++ )
564 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100565}
Hanno Becker67a37db2020-05-28 16:27:07 +0100566#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567
Hanno Beckera18d1322018-01-03 14:27:32 +0000568int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
569 mbedtls_ssl_transform *transform,
570 mbedtls_record *rec,
571 int (*f_rng)(void *, unsigned char *, size_t),
572 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000573{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100575 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000576 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100577 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100578 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000579 size_t post_avail;
580
581 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000582#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200583 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000584 ((void) ssl);
585#endif
586
587 /* The PRNG is used for dynamic IV generation that's used
588 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200589#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000590 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
591 ((void) f_rng);
592 ((void) p_rng);
593#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000597 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100598 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
601 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100602 if( rec == NULL
603 || rec->buf == NULL
604 || rec->buf_len < rec->data_offset
605 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100606#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100607 || rec->cid_len != 0
608#endif
609 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000610 {
611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100613 }
614
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000615 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000618 data, rec->data_len );
619
620 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
621
622 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
623 {
Paul Elliottd48d5c62021-01-07 14:47:05 +0000624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %" MBEDTLS_PRINTF_SIZET
625 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +0000626 rec->data_len,
627 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000628 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
629 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100630
Hanno Becker92313402020-05-20 13:58:58 +0100631 /* The following two code paths implement the (D)TLSInnerPlaintext
632 * structure present in TLS 1.3 and DTLS 1.2 + CID.
633 *
634 * See ssl_build_inner_plaintext() for more information.
635 *
636 * Note that this changes `rec->data_len`, and hence
637 * `post_avail` needs to be recalculated afterwards.
638 *
639 * Note also that the two code paths cannot occur simultaneously
640 * since they apply to different versions of the protocol. There
641 * is hence no risk of double-addition of the inner plaintext.
642 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100643#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
644 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
645 {
Hanno Becker13996922020-05-28 16:15:19 +0100646 size_t padding =
647 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100648 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100649 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100650 &rec->data_len,
651 post_avail,
652 rec->type,
653 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100654 {
655 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
656 }
657
658 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
659 }
660#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
661
Hanno Beckera0e20d02019-05-15 14:03:01 +0100662#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100663 /*
664 * Add CID information
665 */
666 rec->cid_len = transform->out_cid_len;
667 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
668 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100669
670 if( rec->cid_len != 0 )
671 {
Hanno Becker13996922020-05-28 16:15:19 +0100672 size_t padding =
673 ssl_compute_padding_length( rec->data_len,
674 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100675 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100676 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100677 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100678 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100679 * Note that this changes `rec->data_len`, and hence
680 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100681 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100682 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100683 &rec->data_len,
684 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100685 rec->type,
686 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100687 {
688 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
689 }
690
691 rec->type = MBEDTLS_SSL_MSG_CID;
692 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100694
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100695 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
696
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100698 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000699 */
Hanno Becker52344c22018-01-03 15:24:20 +0000700#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 if( mode == MBEDTLS_MODE_STREAM ||
702 ( mode == MBEDTLS_MODE_CBC
703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100705#endif
706 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000707 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000708 if( post_avail < transform->maclen )
709 {
710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
711 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
712 }
713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200716 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000717 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000718 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
719 data, rec->data_len, rec->ctr, rec->type, mac );
720 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200721 }
722 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200723#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
725 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200727 {
Hanno Becker992b6872017-11-09 18:57:39 +0000728 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
729
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100730 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
731 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000732
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100734 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000735 mbedtls_md_hmac_update( &transform->md_ctx_enc,
736 data, rec->data_len );
737 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
738 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
739
740 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200741 }
742 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200743#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200747 }
748
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
750 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200751
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 rec->data_len += transform->maclen;
753 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100754 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200755 }
Hanno Becker52344c22018-01-03 15:24:20 +0000756#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000757
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200758 /*
759 * Encrypt
760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
762 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000763 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 size_t olen;
Paul Elliottd48d5c62021-01-07 14:47:05 +0000766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000767 "including %d bytes of padding",
768 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000769
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
771 transform->iv_enc, transform->ivlen,
772 data, rec->data_len,
773 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200776 return( ret );
777 }
778
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
782 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200783 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 }
Paul Bakker68884e32013-01-07 18:20:04 +0100785 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000787
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200788#if defined(MBEDTLS_GCM_C) || \
789 defined(MBEDTLS_CCM_C) || \
790 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792 mode == MBEDTLS_MODE_CCM ||
793 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000794 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200796 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797 unsigned char *dynamic_iv;
798 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100799 int dynamic_iv_is_explicit =
800 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000801
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100802 /* Check that there's space for the authentication tag. */
803 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 {
805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
806 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
807 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000808
Paul Bakker68884e32013-01-07 18:20:04 +0100809 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100810 * Build nonce for AEAD encryption.
811 *
812 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
813 * part of the IV is prepended to the ciphertext and
814 * can be chosen freely - in particular, it need not
815 * agree with the record sequence number.
816 * However, since ChaChaPoly as well as all AEAD modes
817 * in TLS 1.3 use the record sequence number as the
818 * dynamic part of the nonce, we uniformly use the
819 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100820 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100821 dynamic_iv = rec->ctr;
822 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200823
Hanno Becker17263802020-05-28 07:05:48 +0100824 ssl_build_record_nonce( iv, sizeof( iv ),
825 transform->iv_enc,
826 transform->fixed_ivlen,
827 dynamic_iv,
828 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100829
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100830 /*
831 * Build additional data for AEAD encryption.
832 * This depends on the TLS version.
833 */
834 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
835 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100836
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200837 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100838 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200839 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100840 dynamic_iv,
841 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100843 add_data, add_data_len );
Paul Elliottd48d5c62021-01-07 14:47:05 +0000844 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000847
Paul Bakker68884e32013-01-07 18:20:04 +0100848 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200849 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200850 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000851
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100852 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100854 add_data, add_data_len,
855 data, rec->data_len, /* src */
856 data, rec->buf_len - (data - rec->buf), /* dst */
857 &rec->data_len,
858 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 return( ret );
862 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100864 data + rec->data_len - transform->taglen,
865 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868
869 /*
870 * Prefix record content with dynamic IV in case it is explicit.
871 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100872 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100873 {
874 if( rec->data_offset < dynamic_iv_len )
875 {
876 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
877 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
878 }
879
880 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
881 rec->data_offset -= dynamic_iv_len;
882 rec->data_len += dynamic_iv_len;
883 }
884
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100885 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000886 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100888#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200889#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 size_t padlen, i;
894 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 /* Currently we're always using minimal padding
897 * (up to 255 bytes would be allowed). */
898 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
899 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 padlen = 0;
901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 /* Check there's enough space in the buffer for the padding. */
903 if( post_avail < padlen + 1 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
906 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
907 }
908
Paul Bakker5121ce52009-01-03 21:22:43 +0000909 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 rec->data_len += padlen + 1;
913 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000916 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
918 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000919 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000920 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 if( f_rng == NULL )
923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
926 }
927
928 if( rec->data_offset < transform->ivlen )
929 {
930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
932 }
933
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 /*
935 * Generate IV
936 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000938 if( ret != 0 )
939 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 memcpy( data - transform->ivlen, transform->iv_enc,
942 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000946
Paul Elliottd48d5c62021-01-07 14:47:05 +0000947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
948 "including %" MBEDTLS_PRINTF_SIZET
949 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000950 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200951 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
954 transform->iv_enc,
955 transform->ivlen,
956 data, rec->data_len,
957 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200960 return( ret );
961 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200967 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000970 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200971 {
972 /*
973 * Save IV in SSL3 and TLS1
974 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000975 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
976 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200979#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 {
981 data -= transform->ivlen;
982 rec->data_offset -= transform->ivlen;
983 rec->data_len += transform->ivlen;
984 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100987 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100988 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000989 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
990
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100991 /*
992 * MAC(MAC_write_key, seq_num +
993 * TLSCipherText.type +
994 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100995 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100996 * IV + // except for TLS 1.0
997 * ENC(content + padding + padding_length));
998 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999
1000 if( post_avail < transform->maclen)
1001 {
1002 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1003 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1004 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001006 ssl_extract_add_data_from_record( add_data, &add_data_len,
1007 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001010 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001011 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001012
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001013 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001014 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001015 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1016 data, rec->data_len );
1017 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1018 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001019
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001021
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 rec->data_len += transform->maclen;
1023 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001028 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001034
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001035 /* Make extra sure authentication was performed, exactly once */
1036 if( auth_done != 1 )
1037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001040 }
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001043
1044 return( 0 );
1045}
1046
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001048
1049/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001050 * Constant-flow conditional memcpy:
1051 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1052 * - otherwise, a no-op,
1053 * but with execution flow independent of the values of c1 and c2.
1054 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001055 * This function is implemented without using comparison operators, as those
1056 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001057 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001058static void mbedtls_cf_memcpy_if_eq( unsigned char *dst,
1059 const unsigned char *src,
1060 size_t len,
1061 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001062{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001063 /* mask = c1 == c2 ? 0xff : 0x00 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001064 const size_t equal = mbedtls_cf_size_bool_eq( c1, c2 );
1065 const unsigned char mask = (unsigned char) mbedtls_cf_size_mask( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001066
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001067 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001068 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001069 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001070}
1071
1072/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001073 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001074 *
1075 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1076 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001077 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001078MBEDTLS_STATIC_TESTABLE int mbedtls_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001079 mbedtls_md_context_t *ctx,
1080 const unsigned char *add_data, size_t add_data_len,
1081 const unsigned char *data, size_t data_len_secret,
1082 size_t min_data_len, size_t max_data_len,
1083 unsigned char *output )
1084{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001085 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001086 * This function breaks the HMAC abstraction and uses the md_clone()
1087 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001088 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001089 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001090 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001091 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001092 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001093 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1094 * minlen, then cloning the context, and for each byte up to maxlen
1095 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001096 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001097 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001098 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001099 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001100 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1101 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001102 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001103 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001104 const unsigned char * const okey = ikey + block_size;
1105 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001106
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001107 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1108 mbedtls_md_context_t aux;
1109 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001110 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001111
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001112 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001113
1114#define MD_CHK( func_call ) \
1115 do { \
1116 ret = (func_call); \
1117 if( ret != 0 ) \
1118 goto cleanup; \
1119 } while( 0 )
1120
1121 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001122
1123 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1124 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001125 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1126 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001127
1128 /* For each possible length, compute the hash up to that point */
1129 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001130 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001131 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1132 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001133 /* Keep only the correct inner_hash in the output buffer */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001134 mbedtls_cf_memcpy_if_eq( output, aux_out, hash_size,
1135 offset, data_len_secret );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001136
1137 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001138 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001139 }
1140
Manuel Pégourié-Gonnard21bfbdd2021-05-17 12:28:08 +02001141 /* The context needs to finish() before it starts() again */
1142 MD_CHK( mbedtls_md_finish( ctx, aux_out ) );
1143
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001144 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001145 MD_CHK( mbedtls_md_starts( ctx ) );
1146 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1147 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1148 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001149
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001150 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001151 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001152
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001153#undef MD_CHK
1154
1155cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001156 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001157 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001158}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001159
1160/*
1161 * Constant-flow memcpy from variable position in buffer.
1162 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001163 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001164 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001165MBEDTLS_STATIC_TESTABLE void mbedtls_cf_memcpy_offset(
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001166 unsigned char *dst,
1167 const unsigned char *src_base,
1168 size_t offset_secret,
1169 size_t offset_min, size_t offset_max,
1170 size_t len )
1171{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001172 size_t offset;
1173
1174 for( offset = offset_min; offset <= offset_max; offset++ )
1175 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001176 mbedtls_cf_memcpy_if_eq( dst, src_base + offset, len,
1177 offset, offset_secret );
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001178 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001179}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001180#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001181
Hanno Becker605949f2019-07-12 08:23:59 +01001182int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001183 mbedtls_ssl_transform *transform,
1184 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001185{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001186 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001188 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001189#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001190 size_t padlen = 0, correct = 1;
1191#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001192 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001193 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001194 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001195
Hanno Beckera18d1322018-01-03 14:27:32 +00001196#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001197 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001198 ((void) ssl);
1199#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001200
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001202 if( rec == NULL ||
1203 rec->buf == NULL ||
1204 rec->buf_len < rec->data_offset ||
1205 rec->buf_len - rec->data_offset < rec->data_len )
1206 {
1207 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001209 }
1210
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001211 data = rec->buf + rec->data_offset;
1212 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001213
Hanno Beckera0e20d02019-05-15 14:03:01 +01001214#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001215 /*
1216 * Match record's CID with incoming CID.
1217 */
Hanno Becker938489a2019-05-08 13:02:22 +01001218 if( rec->cid_len != transform->in_cid_len ||
1219 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1220 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001221 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001222 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001223#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1226 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001227 {
1228 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001229 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1230 transform->iv_dec,
1231 transform->ivlen,
1232 data, rec->data_len,
1233 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001234 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001236 return( ret );
1237 }
1238
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001239 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1242 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001243 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001244 }
Paul Bakker68884e32013-01-07 18:20:04 +01001245 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001247#if defined(MBEDTLS_GCM_C) || \
1248 defined(MBEDTLS_CCM_C) || \
1249 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001251 mode == MBEDTLS_MODE_CCM ||
1252 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001253 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001254 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001255 unsigned char *dynamic_iv;
1256 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001257
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001258 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001259 * Extract dynamic part of nonce for AEAD decryption.
1260 *
1261 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1262 * part of the IV is prepended to the ciphertext and
1263 * can be chosen freely - in particular, it need not
1264 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001265 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001266 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001267 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001268 {
1269 if( rec->data_len < dynamic_iv_len )
1270 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001271 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1272 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 rec->data_len,
1274 dynamic_iv_len ) );
1275 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1276 }
1277 dynamic_iv = data;
1278
1279 data += dynamic_iv_len;
1280 rec->data_offset += dynamic_iv_len;
1281 rec->data_len -= dynamic_iv_len;
1282 }
Hanno Becker17263802020-05-28 07:05:48 +01001283 else
1284 {
1285 dynamic_iv = rec->ctr;
1286 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001287
1288 /* Check that there's space for the authentication tag. */
1289 if( rec->data_len < transform->taglen )
1290 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001291 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1292 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
Christian von Arnim883d3042020-12-01 11:58:29 +01001293 rec->data_len,
1294 transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001296 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001297 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001298
Hanno Beckerdf8be222020-05-21 15:30:57 +01001299 /*
1300 * Prepare nonce from dynamic and static parts.
1301 */
Hanno Becker17263802020-05-28 07:05:48 +01001302 ssl_build_record_nonce( iv, sizeof( iv ),
1303 transform->iv_dec,
1304 transform->fixed_ivlen,
1305 dynamic_iv,
1306 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001307
Hanno Beckerdf8be222020-05-21 15:30:57 +01001308 /*
1309 * Build additional data for AEAD encryption.
1310 * This depends on the TLS version.
1311 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001312 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1313 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001314 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001315 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001316
Hanno Beckerd96a6522019-07-10 13:55:25 +01001317 /* Because of the check above, we know that there are
1318 * explicit_iv_len Bytes preceeding data, and taglen
1319 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001320 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001321 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001323 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001325 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001326
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001327 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001328 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001329 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001330 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001331 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001332 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001333 data, rec->data_len + transform->taglen, /* src */
1334 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001335 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001337 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1340 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001341
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001342 return( ret );
1343 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001344 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001345
Hanno Beckerd96a6522019-07-10 13:55:25 +01001346 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001347 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1350 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001351 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001352 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001353 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001355#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001357 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001358 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001359
Paul Bakker5121ce52009-01-03 21:22:43 +00001360 /*
Paul Bakker45829992013-01-03 14:52:21 +01001361 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001364 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1365 {
1366 /* The ciphertext is prefixed with the CBC IV. */
1367 minlen += transform->ivlen;
1368 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001369#endif
Paul Bakker45829992013-01-03 14:52:21 +01001370
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 /* Size considerations:
1372 *
1373 * - The CBC cipher text must not be empty and hence
1374 * at least of size transform->ivlen.
1375 *
1376 * Together with the potential IV-prefix, this explains
1377 * the first of the two checks below.
1378 *
1379 * - The record must contain a MAC, either in plain or
1380 * encrypted, depending on whether Encrypt-then-MAC
1381 * is used or not.
1382 * - If it is, the message contains the IV-prefix,
1383 * the CBC ciphertext, and the MAC.
1384 * - If it is not, the padded plaintext, and hence
1385 * the CBC ciphertext, has at least length maclen + 1
1386 * because there is at least the padding length byte.
1387 *
1388 * As the CBC ciphertext is not empty, both cases give the
1389 * lower bound minlen + maclen + 1 on the record size, which
1390 * we test for in the second check below.
1391 */
1392 if( rec->data_len < minlen + transform->ivlen ||
1393 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001394 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001395 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1396 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1397 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001398 "+ 1 ) ( + expl IV )", rec->data_len,
1399 transform->ivlen,
1400 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001402 }
1403
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404 /*
1405 * Authenticate before decrypt if enabled
1406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001408 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001409 {
Hanno Becker992b6872017-11-09 18:57:39 +00001410 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001413
Hanno Beckerd96a6522019-07-10 13:55:25 +01001414 /* Update data_len in tandem with add_data.
1415 *
1416 * The subtraction is safe because of the previous check
1417 * data_len >= minlen + maclen + 1.
1418 *
1419 * Afterwards, we know that data + data_len is followed by at
1420 * least maclen Bytes, which justifies the call to
1421 * mbedtls_ssl_safer_memcmp() below.
1422 *
1423 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001425 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1426 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001427
Hanno Beckerd96a6522019-07-10 13:55:25 +01001428 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001429 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1430 add_data_len );
1431 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1432 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1434 data, rec->data_len );
1435 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1436 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001437
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001438 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1439 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001440 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001442
Hanno Beckerd96a6522019-07-10 13:55:25 +01001443 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001444 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1445 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001449 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001450 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001451 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001453
1454 /*
1455 * Check length sanity
1456 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001457
1458 /* We know from above that data_len > minlen >= 0,
1459 * so the following check in particular implies that
1460 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1464 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001465 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001467 }
1468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001470 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001471 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001472 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001473 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001474 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001475 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001476 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001477
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001478 data += transform->ivlen;
1479 rec->data_offset += transform->ivlen;
1480 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001481 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001483
Hanno Beckerd96a6522019-07-10 13:55:25 +01001484 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1485
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001486 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1487 transform->iv_dec, transform->ivlen,
1488 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001489 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001491 return( ret );
1492 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001493
Hanno Beckerd96a6522019-07-10 13:55:25 +01001494 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001495 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001496 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1498 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001499 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001503 {
1504 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001505 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1506 * records is equivalent to CBC decryption of the concatenation
1507 * of the records; in other words, IVs are maintained across
1508 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001509 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001510 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1511 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001512 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001513#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001514
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001515 /* Safe since data_len >= minlen + maclen + 1, so after having
1516 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001517 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1518 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001519 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001520
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 if( auth_done == 1 )
1522 {
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001523 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001524 rec->data_len,
1525 padlen + 1 );
1526 correct &= mask;
1527 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 }
1529 else
Paul Bakker45829992013-01-03 14:52:21 +01001530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( rec->data_len < transform->maclen + padlen + 1 )
1533 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%" MBEDTLS_PRINTF_SIZET
1535 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1536 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 rec->data_len,
1538 transform->maclen,
1539 padlen + 1 ) );
1540 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001541#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001542
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001543 const size_t mask = mbedtls_cf_size_mask_ge(
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001544 rec->data_len,
1545 transform->maclen + padlen + 1 );
1546 correct &= mask;
1547 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001548 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 padlen++;
1551
1552 /* Regardless of the validity of the padding,
1553 * we have data_len >= padlen here. */
1554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001557 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001558 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1559 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001560 * the protocol (known as part of POODLE), so we don't care if the
1561 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001562 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Elliottd48d5c62021-01-07 14:47:05 +00001565 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %" MBEDTLS_PRINTF_SIZET ", "
1566 "should be no more than %" MBEDTLS_PRINTF_SIZET,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001568#endif
Paul Bakker45829992013-01-03 14:52:21 +01001569 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001570 }
1571 }
1572 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1574#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1575 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001576 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001577 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001578 /* The padding check involves a series of up to 256
1579 * consecutive memory reads at the end of the record
1580 * plaintext buffer. In order to hide the length and
1581 * validity of the padding, always perform exactly
1582 * `min(256,plaintext_len)` reads (but take into account
1583 * only the last `padlen` bytes for the padding check). */
1584 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001585 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001586
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001587 /* Index of first padding byte; it has been ensured above
1588 * that the subtraction is safe. */
1589 size_t const padding_idx = rec->data_len - padlen;
1590 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1591 size_t const start_idx = rec->data_len - num_checks;
1592 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001593
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001594 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001595 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001596 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001597 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001598 */
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001599 const size_t mask = mbedtls_cf_size_mask_ge( idx, padding_idx );
1600 const size_t equal = mbedtls_cf_size_bool_eq( check[idx],
1601 padlen - 1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001602 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001603 }
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001604 correct &= mbedtls_cf_size_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001607 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001609#endif
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001610 padlen &= mbedtls_cf_size_mask( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001611 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001612 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1614 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001615 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1617 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001618 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001619
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 /* If the padding was found to be invalid, padlen == 0
1621 * and the subtraction is safe. If the padding was found valid,
1622 * padlen hasn't been changed and the previous assertion
1623 * data_len >= padlen still holds. */
1624 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001625 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001626 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001627#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1630 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001631 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001632
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001633#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001635 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001636#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001637
1638 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001639 * Authenticate if not done yet.
1640 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001641 */
Hanno Becker52344c22018-01-03 15:24:20 +00001642#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001643 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001644 {
Hanno Becker992b6872017-11-09 18:57:39 +00001645 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001646 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001647
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001648 /* If the initial value of padlen was such that
1649 * data_len < maclen + padlen + 1, then padlen
1650 * got reset to 1, and the initial check
1651 * data_len >= minlen + maclen + 1
1652 * guarantees that at this point we still
1653 * have at least data_len >= maclen.
1654 *
1655 * If the initial value of padlen was such that
1656 * data_len >= maclen + padlen + 1, then we have
1657 * subtracted either padlen + 1 (if the padding was correct)
1658 * or 0 (if the padding was incorrect) since then,
1659 * hence data_len >= maclen in any case.
1660 */
1661 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001662 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1663 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001666 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001667 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001668 ssl_mac( &transform->md_ctx_dec,
1669 transform->mac_dec,
1670 data, rec->data_len,
1671 rec->ctr, rec->type,
1672 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001673 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001674 }
1675 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1677#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1678 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001679 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001680 {
1681 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001682 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001683 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001684 *
1685 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001686 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001687 *
1688 * Note that max_len + maclen is never more than the buffer
1689 * length, as we previously did in_msglen -= maclen too.
1690 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001691 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001692 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1693
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001694 ret = mbedtls_cf_hmac( &transform->md_ctx_dec,
1695 add_data, add_data_len,
1696 data, rec->data_len, min_len, max_len,
1697 mac_expect );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001698 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001699 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001700 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1701 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001702 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001703
gabor-mezei-arme41e3e82021-09-28 16:14:47 +02001704 mbedtls_cf_memcpy_offset( mac_peer, data,
1705 rec->data_len,
1706 min_len, max_len,
1707 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001708 }
1709 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1711 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1714 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001715 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001717#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001718 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001719 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001720#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001722 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001723 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001724 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#if defined(MBEDTLS_SSL_DEBUG_ALL)
1726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001727#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001728 correct = 0;
1729 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001730 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001731 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001732
1733 /*
1734 * Finally check the correct flag
1735 */
1736 if( correct == 0 )
1737 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001738#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001739
1740 /* Make extra sure authentication was performed, exactly once */
1741 if( auth_done != 1 )
1742 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1744 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001745 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001746
Hanno Beckerccc13d02020-05-04 12:30:04 +01001747#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1748 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1749 {
1750 /* Remove inner padding and infer true content type. */
1751 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1752 &rec->type );
1753
1754 if( ret != 0 )
1755 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1756 }
1757#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1758
Hanno Beckera0e20d02019-05-15 14:03:01 +01001759#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001760 if( rec->cid_len != 0 )
1761 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001762 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1763 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001764 if( ret != 0 )
1765 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1766 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001767#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001770
1771 return( 0 );
1772}
1773
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001774#undef MAC_NONE
1775#undef MAC_PLAINTEXT
1776#undef MAC_CIPHERTEXT
1777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001779/*
1780 * Compression/decompression functions
1781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783{
Janos Follath865b3eb2019-12-16 11:46:15 +00001784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001785 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001786 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001787 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001788 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001789#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1790 size_t out_buf_len = ssl->out_buf_len;
1791#else
1792 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1793#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001796
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001797 if( len_pre == 0 )
1798 return( 0 );
1799
Paul Bakker2770fbd2012-07-03 13:30:23 +00001800 memcpy( msg_pre, ssl->out_msg, len_pre );
1801
Paul Elliottd48d5c62021-01-07 14:47:05 +00001802 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001803 ssl->out_msglen ) );
1804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001805 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001806 ssl->out_msg, ssl->out_msglen );
1807
Paul Bakker48916f92012-09-16 19:57:18 +00001808 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1809 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1810 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001811 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001812
Paul Bakker48916f92012-09-16 19:57:18 +00001813 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814 if( ret != Z_OK )
1815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1817 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001818 }
1819
Darryl Greenb33cc762019-11-28 14:29:44 +00001820 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001821 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001822
Paul Elliottd48d5c62021-01-07 14:47:05 +00001823 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001824 ssl->out_msglen ) );
1825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001827 ssl->out_msg, ssl->out_msglen );
1828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001829 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001830
1831 return( 0 );
1832}
1833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835{
Janos Follath865b3eb2019-12-16 11:46:15 +00001836 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001837 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001838 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001839 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001840 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001841#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1842 size_t in_buf_len = ssl->in_buf_len;
1843#else
1844 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1845#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001848
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001849 if( len_pre == 0 )
1850 return( 0 );
1851
Paul Bakker2770fbd2012-07-03 13:30:23 +00001852 memcpy( msg_pre, ssl->in_msg, len_pre );
1853
Paul Elliottd48d5c62021-01-07 14:47:05 +00001854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001855 ssl->in_msglen ) );
1856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001858 ssl->in_msg, ssl->in_msglen );
1859
Paul Bakker48916f92012-09-16 19:57:18 +00001860 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1861 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1862 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001863 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001864
Paul Bakker48916f92012-09-16 19:57:18 +00001865 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001866 if( ret != Z_OK )
1867 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1869 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001870 }
1871
Darryl Greenb33cc762019-11-28 14:29:44 +00001872 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001873 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874
Paul Elliottd48d5c62021-01-07 14:47:05 +00001875 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %" MBEDTLS_PRINTF_SIZET ", ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001876 ssl->in_msglen ) );
1877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001879 ssl->in_msg, ssl->in_msglen );
1880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001882
1883 return( 0 );
1884}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001886
Paul Bakker5121ce52009-01-03 21:22:43 +00001887/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001888 * Fill the input message buffer by appending data to it.
1889 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001890 *
1891 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1892 * available (from this read and/or a previous one). Otherwise, an error code
1893 * is returned (possibly EOF or WANT_READ).
1894 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001895 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1896 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1897 * since we always read a whole datagram at once.
1898 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001899 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001900 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001903{
Janos Follath865b3eb2019-12-16 11:46:15 +00001904 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001905 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001906#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1907 size_t in_buf_len = ssl->in_buf_len;
1908#else
1909 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1910#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001913
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001914 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1915 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001917 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001919 }
1920
Darryl Greenb33cc762019-11-28 14:29:44 +00001921 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001922 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1924 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001925 }
1926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001928 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001929 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001930 uint32_t timeout;
1931
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001932 /*
1933 * The point is, we need to always read a full datagram at once, so we
1934 * sometimes read more then requested, and handle the additional data.
1935 * It could be the rest of the current record (while fetching the
1936 * header) and/or some other records in the same datagram.
1937 */
1938
1939 /*
1940 * Move to the next record in the already read datagram if applicable
1941 */
1942 if( ssl->next_record_offset != 0 )
1943 {
1944 if( ssl->in_left < ssl->next_record_offset )
1945 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1947 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001948 }
1949
1950 ssl->in_left -= ssl->next_record_offset;
1951
1952 if( ssl->in_left != 0 )
1953 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00001954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %"
1955 MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001956 ssl->next_record_offset ) );
1957 memmove( ssl->in_hdr,
1958 ssl->in_hdr + ssl->next_record_offset,
1959 ssl->in_left );
1960 }
1961
1962 ssl->next_record_offset = 0;
1963 }
1964
Paul Elliottd48d5c62021-01-07 14:47:05 +00001965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
1966 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Paul Bakker5121ce52009-01-03 21:22:43 +00001967 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001968
1969 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001970 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001971 */
1972 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001975 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001976 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001977
1978 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001979 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001980 * are not at the beginning of a new record, the caller did something
1981 * wrong.
1982 */
1983 if( ssl->in_left != 0 )
1984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1986 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001987 }
1988
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001989 /*
1990 * Don't even try to read if time's out already.
1991 * This avoids by-passing the timer when repeatedly receiving messages
1992 * that will end up being dropped.
1993 */
Hanno Becker7876d122020-02-05 10:39:31 +00001994 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001995 {
1996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001997 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001998 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001999 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002000 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002001 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002004 timeout = ssl->handshake->retransmit_timeout;
2005 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002006 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002007
Paul Elliott9f352112020-12-09 14:55:45 +00002008 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %lu ms", (unsigned long) timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002009
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002010 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002011 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2012 timeout );
2013 else
2014 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002017
2018 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002020 }
2021
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002022 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002023 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002025 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002028 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002029 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002032 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002033 }
2034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002036 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002038 return( ret );
2039 }
2040
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002041 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002042 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002044 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002046 {
Hanno Becker786300f2020-02-05 10:46:40 +00002047 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002048 {
Hanno Becker786300f2020-02-05 10:46:40 +00002049 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2050 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002051 return( ret );
2052 }
2053
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002054 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002055 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002057 }
2058
Paul Bakker5121ce52009-01-03 21:22:43 +00002059 if( ret < 0 )
2060 return( ret );
2061
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002062 ssl->in_left = ret;
2063 }
2064 else
2065#endif
2066 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002067 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2068 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002069 ssl->in_left, nb_want ) );
2070
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002071 while( ssl->in_left < nb_want )
2072 {
2073 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002074
Hanno Becker7876d122020-02-05 10:39:31 +00002075 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002076 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2077 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002078 {
2079 if( ssl->f_recv_timeout != NULL )
2080 {
2081 ret = ssl->f_recv_timeout( ssl->p_bio,
2082 ssl->in_hdr + ssl->in_left, len,
2083 ssl->conf->read_timeout );
2084 }
2085 else
2086 {
2087 ret = ssl->f_recv( ssl->p_bio,
2088 ssl->in_hdr + ssl->in_left, len );
2089 }
2090 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002091
Paul Elliottd48d5c62021-01-07 14:47:05 +00002092 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %" MBEDTLS_PRINTF_SIZET
2093 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002094 ssl->in_left, nb_want ) );
2095 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002096
2097 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002098 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002099
2100 if( ret < 0 )
2101 return( ret );
2102
makise-homuraaf9513b2020-08-24 18:26:27 +03002103 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002104 {
Darryl Green11999bb2018-03-13 15:22:58 +00002105 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002106 ( "f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " were requested",
Paul Elliott9f352112020-12-09 14:55:45 +00002107 ret, len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002108 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2109 }
2110
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002111 ssl->in_left += ret;
2112 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002113 }
2114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002116
2117 return( 0 );
2118}
2119
2120/*
2121 * Flush any data not yet written
2122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002124{
Janos Follath865b3eb2019-12-16 11:46:15 +00002125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002126 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002127
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002129
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002130 if( ssl->f_send == NULL )
2131 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002133 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002135 }
2136
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002137 /* Avoid incrementing counter if data is flushed */
2138 if( ssl->out_left == 0 )
2139 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002141 return( 0 );
2142 }
2143
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 while( ssl->out_left > 0 )
2145 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002146 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %" MBEDTLS_PRINTF_SIZET
2147 ", out_left: %" MBEDTLS_PRINTF_SIZET,
Hanno Becker5903de42019-05-03 14:46:38 +01002148 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002149
Hanno Becker2b1e3542018-08-06 11:19:13 +01002150 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002151 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
2155 if( ret <= 0 )
2156 return( ret );
2157
makise-homuraaf9513b2020-08-24 18:26:27 +03002158 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002159 {
Darryl Green11999bb2018-03-13 15:22:58 +00002160 MBEDTLS_SSL_DEBUG_MSG( 1,
Paul Elliottd48d5c62021-01-07 14:47:05 +00002161 ( "f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET " bytes were sent",
Paul Elliott9f352112020-12-09 14:55:45 +00002162 ret, ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002163 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2164 }
2165
Paul Bakker5121ce52009-01-03 21:22:43 +00002166 ssl->out_left -= ret;
2167 }
2168
Hanno Becker2b1e3542018-08-06 11:19:13 +01002169#if defined(MBEDTLS_SSL_PROTO_DTLS)
2170 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002171 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002172 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002173 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002174 else
2175#endif
2176 {
2177 ssl->out_hdr = ssl->out_buf + 8;
2178 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002179 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
2183 return( 0 );
2184}
2185
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002186/*
2187 * Functions to handle the DTLS retransmission state machine
2188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190/*
2191 * Append current handshake message to current outgoing flight
2192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002194{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002196 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2197 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2198 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002199
2200 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002201 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002205 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002206 }
2207
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002208 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002209 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00002210 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2211 ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002213 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002214 }
2215
2216 /* Copy current handshake message with headers */
2217 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2218 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002219 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002220 msg->next = NULL;
2221
2222 /* Append to the current flight */
2223 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002224 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002225 else
2226 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002228 while( cur->next != NULL )
2229 cur = cur->next;
2230 cur->next = msg;
2231 }
2232
Hanno Becker3b235902018-08-06 09:54:53 +01002233 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002234 return( 0 );
2235}
2236
2237/*
2238 * Free the current flight of handshake messages
2239 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002240void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002241{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 mbedtls_ssl_flight_item *cur = flight;
2243 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244
2245 while( cur != NULL )
2246 {
2247 next = cur->next;
2248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249 mbedtls_free( cur->p );
2250 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002251
2252 cur = next;
2253 }
2254}
2255
2256/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002257 * Swap transform_out and out_ctr with the alternative ones
2258 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002259static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002260{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002262 unsigned char tmp_out_ctr[8];
2263
2264 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2265 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002266 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002267 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002268 }
2269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002271
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002272 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002273 tmp_transform = ssl->transform_out;
2274 ssl->transform_out = ssl->handshake->alt_transform_out;
2275 ssl->handshake->alt_transform_out = tmp_transform;
2276
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002277 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002278 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2279 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002280 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002281
2282 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002283 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002284
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2286 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002287 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002288 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2289 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002290 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002291 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2292 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002293 }
2294 }
2295#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002296
2297 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002298}
2299
2300/*
2301 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002302 */
2303int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2304{
2305 int ret = 0;
2306
2307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2308
2309 ret = mbedtls_ssl_flight_transmit( ssl );
2310
2311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2312
2313 return( ret );
2314}
2315
2316/*
2317 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002318 *
2319 * Need to remember the current message in case flush_output returns
2320 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002321 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002322 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002323int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002324{
Janos Follath865b3eb2019-12-16 11:46:15 +00002325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002326 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002329 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002331
2332 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002333 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002334 ret = ssl_swap_epochs( ssl );
2335 if( ret != 0 )
2336 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002339 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002340
2341 while( ssl->handshake->cur_msg != NULL )
2342 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002343 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002344 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002345
Hanno Beckere1dcb032018-08-17 16:47:58 +01002346 int const is_finished =
2347 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2348 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2349
Hanno Becker04da1892018-08-14 13:22:10 +01002350 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2351 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2352
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002353 /* Swap epochs before sending Finished: we can't do it after
2354 * sending ChangeCipherSpec, in case write returns WANT_READ.
2355 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002356 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002357 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002359 ret = ssl_swap_epochs( ssl );
2360 if( ret != 0 )
2361 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002362 }
2363
Hanno Becker67bc7c32018-08-06 11:33:50 +01002364 ret = ssl_get_remaining_payload_in_datagram( ssl );
2365 if( ret < 0 )
2366 return( ret );
2367 max_frag_len = (size_t) ret;
2368
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002369 /* CCS is copied as is, while HS messages may need fragmentation */
2370 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2371 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002372 if( max_frag_len == 0 )
2373 {
2374 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2375 return( ret );
2376
2377 continue;
2378 }
2379
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002380 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002381 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002382 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002383
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002384 /* Update position inside current message */
2385 ssl->handshake->cur_msg_p += cur->len;
2386 }
2387 else
2388 {
2389 const unsigned char * const p = ssl->handshake->cur_msg_p;
2390 const size_t hs_len = cur->len - 12;
2391 const size_t frag_off = p - ( cur->p + 12 );
2392 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002393 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394
Hanno Beckere1dcb032018-08-17 16:47:58 +01002395 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002396 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002397 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002398 {
2399 ret = ssl_swap_epochs( ssl );
2400 if( ret != 0 )
2401 return( ret );
2402 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002403
Hanno Becker67bc7c32018-08-06 11:33:50 +01002404 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2405 return( ret );
2406
2407 continue;
2408 }
2409 max_hs_frag_len = max_frag_len - 12;
2410
2411 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2412 max_hs_frag_len : rem_len;
2413
2414 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002415 {
2416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002417 (unsigned) cur_hs_frag_len,
2418 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002419 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002420
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002421 /* Messages are stored with handshake headers as if not fragmented,
2422 * copy beginning of headers then fill fragmentation fields.
2423 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2424 memcpy( ssl->out_msg, cur->p, 6 );
Joe Subbiani61f7d732021-06-24 09:06:23 +01002425
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002426 ssl->out_msg[6] = MBEDTLS_BYTE_2( frag_off );
2427 ssl->out_msg[7] = MBEDTLS_BYTE_1( frag_off );
2428 ssl->out_msg[8] = MBEDTLS_BYTE_0( frag_off );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002429
Joe Subbiani2bbafda2021-06-24 13:00:03 +01002430 ssl->out_msg[ 9] = MBEDTLS_BYTE_2( cur_hs_frag_len );
2431 ssl->out_msg[10] = MBEDTLS_BYTE_1( cur_hs_frag_len );
2432 ssl->out_msg[11] = MBEDTLS_BYTE_0( cur_hs_frag_len );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002433
2434 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2435
Hanno Becker3f7b9732018-08-28 09:53:25 +01002436 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002437 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2438 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002439 ssl->out_msgtype = cur->type;
2440
2441 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002442 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002443 }
2444
2445 /* If done with the current message move to the next one if any */
2446 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2447 {
2448 if( cur->next != NULL )
2449 {
2450 ssl->handshake->cur_msg = cur->next;
2451 ssl->handshake->cur_msg_p = cur->next->p + 12;
2452 }
2453 else
2454 {
2455 ssl->handshake->cur_msg = NULL;
2456 ssl->handshake->cur_msg_p = NULL;
2457 }
2458 }
2459
2460 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002461 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002462 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464 return( ret );
2465 }
2466 }
2467
Hanno Becker67bc7c32018-08-06 11:33:50 +01002468 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2469 return( ret );
2470
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002471 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2473 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002474 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002475 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002477 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002478 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002479
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002481
2482 return( 0 );
2483}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002484
2485/*
2486 * To be called when the last message of an incoming flight is received.
2487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002489{
2490 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002491 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002492 ssl->handshake->flight = NULL;
2493 ssl->handshake->cur_msg = NULL;
2494
2495 /* The next incoming flight will start with this msg_seq */
2496 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2497
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002498 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002499 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002500
Hanno Becker0271f962018-08-16 13:23:47 +01002501 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002502 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002503
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002504 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002505 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2508 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002511 }
2512 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002514}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002515
2516/*
2517 * To be called when the last message of an outgoing flight is send.
2518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002520{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002521 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002522 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2525 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002528 }
2529 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002531}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002533
Paul Bakker5121ce52009-01-03 21:22:43 +00002534/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002535 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002536 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002537
2538/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002539 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002540 *
2541 * - fill in handshake headers
2542 * - update handshake checksum
2543 * - DTLS: save message for resending
2544 * - then pass to the record layer
2545 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002546 * DTLS: except for HelloRequest, messages are only queued, and will only be
2547 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002548 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002549 * Inputs:
2550 * - ssl->out_msglen: 4 + actual handshake message len
2551 * (4 is the size of handshake headers for TLS)
2552 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2553 * - ssl->out_msg + 4: the handshake message body
2554 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002555 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002556 * - ssl->out_msglen: the length of the record contents
2557 * (including handshake headers but excluding record headers)
2558 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002560int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002561{
Janos Follath865b3eb2019-12-16 11:46:15 +00002562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002563 const size_t hs_len = ssl->out_msglen - 4;
2564 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002565
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002566 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2567
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002568 /*
2569 * Sanity checks
2570 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002571 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002572 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2573 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002574 /* In SSLv3, the client might send a NoCertificate alert. */
2575#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2576 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2577 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2578 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2579#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2580 {
2581 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2582 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2583 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002584 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002585
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002586 /* Whenever we send anything different from a
2587 * HelloRequest we should be in a handshake - double check. */
2588 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2589 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002590 ssl->handshake == NULL )
2591 {
2592 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2593 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2594 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002597 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002598 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002600 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002603 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002604#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002605
Hanno Beckerb50a2532018-08-06 11:52:54 +01002606 /* Double-check that we did not exceed the bounds
2607 * of the outgoing record buffer.
2608 * This should never fail as the various message
2609 * writing functions must obey the bounds of the
2610 * outgoing record buffer, but better be safe.
2611 *
2612 * Note: We deliberately do not check for the MTU or MFL here.
2613 */
2614 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2615 {
2616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002617 "size %" MBEDTLS_PRINTF_SIZET
2618 ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002619 ssl->out_msglen,
2620 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
Hanno Beckerb50a2532018-08-06 11:52:54 +01002621 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2622 }
2623
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002624 /*
2625 * Fill handshake headers
2626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002628 {
Joe Subbianiad1115a2021-07-16 14:27:50 +01002629 ssl->out_msg[1] = MBEDTLS_BYTE_2( hs_len );
2630 ssl->out_msg[2] = MBEDTLS_BYTE_1( hs_len );
2631 ssl->out_msg[3] = MBEDTLS_BYTE_0( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002632
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002633 /*
2634 * DTLS has additional fields in the Handshake layer,
2635 * between the length field and the actual payload:
2636 * uint16 message_seq;
2637 * uint24 fragment_offset;
2638 * uint24 fragment_length;
2639 */
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 )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002642 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002643 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002644 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002645 {
2646 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002647 "size %" MBEDTLS_PRINTF_SIZET ", maximum %" MBEDTLS_PRINTF_SIZET,
Paul Elliott3891caf2020-12-17 18:42:40 +00002648 hs_len,
2649 (size_t) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2651 }
2652
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002653 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002654 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002655
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002656 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002657 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002658 {
Joe Subbianic54e9082021-07-19 11:56:54 +01002659 MBEDTLS_PUT_UINT16_BE( ssl->handshake->out_msg_seq, ssl->out_msg, 4 );
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002660 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002661 }
2662 else
2663 {
2664 ssl->out_msg[4] = 0;
2665 ssl->out_msg[5] = 0;
2666 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002667
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002668 /* Handshake hashes are computed without fragmentation,
2669 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002670 memset( ssl->out_msg + 6, 0x00, 3 );
2671 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002672 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002674
Hanno Becker0207e532018-08-28 10:28:28 +01002675 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002676 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2677 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002678 }
2679
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002680 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002682 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002683 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2684 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002685 {
2686 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002689 return( ret );
2690 }
2691 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002692 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002693#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002694 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002695 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002696 {
2697 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2698 return( ret );
2699 }
2700 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002701
2702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2703
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002704 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002705}
2706
2707/*
2708 * Record layer functions
2709 */
2710
2711/*
2712 * Write current record.
2713 *
2714 * Uses:
2715 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2716 * - ssl->out_msglen: length of the record content (excl headers)
2717 * - ssl->out_msg: record content
2718 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002719int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002720{
2721 int ret, done = 0;
2722 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002723 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002724
2725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002728 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002730 {
2731 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002734 return( ret );
2735 }
2736
2737 len = ssl->out_msglen;
2738 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2742 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002743 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 ret = mbedtls_ssl_hw_record_write( ssl );
2747 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2750 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002751 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002752
2753 if( ret == 0 )
2754 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002755 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002757 if( !done )
2758 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002759 unsigned i;
2760 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002761#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2762 size_t out_buf_len = ssl->out_buf_len;
2763#else
2764 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2765#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002766 /* Skip writing the record content type to after the encryption,
2767 * as it may change when using the CID extension. */
2768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002770 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002771
Hanno Becker19859472018-08-06 09:40:20 +01002772 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Joe Subbianic54e9082021-07-19 11:56:54 +01002773 MBEDTLS_PUT_UINT16_BE( len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002774
Paul Bakker48916f92012-09-16 19:57:18 +00002775 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002776 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002777 mbedtls_record rec;
2778
2779 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002780 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002781 rec.data_len = ssl->out_msglen;
2782 rec.data_offset = ssl->out_msg - rec.buf;
2783
2784 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2785 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2786 ssl->conf->transport, rec.ver );
2787 rec.type = ssl->out_msgtype;
2788
Hanno Beckera0e20d02019-05-15 14:03:01 +01002789#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002790 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002791 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002792#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002793
Hanno Beckera18d1322018-01-03 14:27:32 +00002794 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002795 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002798 return( ret );
2799 }
2800
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002801 if( rec.data_offset != 0 )
2802 {
2803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2804 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2805 }
2806
Hanno Becker6430faf2019-05-08 11:57:13 +01002807 /* Update the record content type and CID. */
2808 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002809#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002810 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002811#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002812 ssl->out_msglen = len = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01002813 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->out_len, 0 );
Paul Bakker05ef8352012-05-08 09:17:57 +00002814 }
2815
Hanno Becker5903de42019-05-03 14:46:38 +01002816 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002817
2818#if defined(MBEDTLS_SSL_PROTO_DTLS)
2819 /* In case of DTLS, double-check that we don't exceed
2820 * the remaining space in the datagram. */
2821 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2822 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002823 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002824 if( ret < 0 )
2825 return( ret );
2826
2827 if( protected_record_size > (size_t) ret )
2828 {
2829 /* Should never happen */
2830 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2831 }
2832 }
2833#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002834
Hanno Becker6430faf2019-05-08 11:57:13 +01002835 /* Now write the potentially updated record content type. */
2836 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2837
Paul Elliott9f352112020-12-09 14:55:45 +00002838 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00002839 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002840 ssl->out_hdr[0], ssl->out_hdr[1],
2841 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002844 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002845
2846 ssl->out_left += protected_record_size;
2847 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002848 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002849
Hanno Beckerdd772292020-02-05 10:38:31 +00002850 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002851 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2852 break;
2853
2854 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002855 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002856 {
2857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2858 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2859 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002860 }
2861
Hanno Becker67bc7c32018-08-06 11:33:50 +01002862#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002863 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2864 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002865 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002866 size_t remaining;
2867 ret = ssl_get_remaining_payload_in_datagram( ssl );
2868 if( ret < 0 )
2869 {
2870 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2871 ret );
2872 return( ret );
2873 }
2874
2875 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002876 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002877 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002878 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002879 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002880 else
2881 {
Hanno Becker513815a2018-08-20 11:56:09 +01002882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002883 }
2884 }
2885#endif /* MBEDTLS_SSL_PROTO_DTLS */
2886
2887 if( ( flush == SSL_FORCE_FLUSH ) &&
2888 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002891 return( ret );
2892 }
2893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002895
2896 return( 0 );
2897}
2898
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002899#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002900
2901static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2902{
2903 if( ssl->in_msglen < ssl->in_hslen ||
2904 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2905 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2906 {
2907 return( 1 );
2908 }
2909 return( 0 );
2910}
Hanno Becker44650b72018-08-16 12:51:11 +01002911
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002912static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002913{
2914 return( ( ssl->in_msg[9] << 16 ) |
2915 ( ssl->in_msg[10] << 8 ) |
2916 ssl->in_msg[11] );
2917}
2918
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002919static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002920{
2921 return( ( ssl->in_msg[6] << 16 ) |
2922 ( ssl->in_msg[7] << 8 ) |
2923 ssl->in_msg[8] );
2924}
2925
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002926static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002927{
2928 uint32_t msg_len, frag_off, frag_len;
2929
2930 msg_len = ssl_get_hs_total_len( ssl );
2931 frag_off = ssl_get_hs_frag_off( ssl );
2932 frag_len = ssl_get_hs_frag_len( ssl );
2933
2934 if( frag_off > msg_len )
2935 return( -1 );
2936
2937 if( frag_len > msg_len - frag_off )
2938 return( -1 );
2939
2940 if( frag_len + 12 > ssl->in_msglen )
2941 return( -1 );
2942
2943 return( 0 );
2944}
2945
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002946/*
2947 * Mark bits in bitmask (used for DTLS HS reassembly)
2948 */
2949static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2950{
2951 unsigned int start_bits, end_bits;
2952
2953 start_bits = 8 - ( offset % 8 );
2954 if( start_bits != 8 )
2955 {
2956 size_t first_byte_idx = offset / 8;
2957
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002958 /* Special case */
2959 if( len <= start_bits )
2960 {
2961 for( ; len != 0; len-- )
2962 mask[first_byte_idx] |= 1 << ( start_bits - len );
2963
2964 /* Avoid potential issues with offset or len becoming invalid */
2965 return;
2966 }
2967
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002968 offset += start_bits; /* Now offset % 8 == 0 */
2969 len -= start_bits;
2970
2971 for( ; start_bits != 0; start_bits-- )
2972 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2973 }
2974
2975 end_bits = len % 8;
2976 if( end_bits != 0 )
2977 {
2978 size_t last_byte_idx = ( offset + len ) / 8;
2979
2980 len -= end_bits; /* Now len % 8 == 0 */
2981
2982 for( ; end_bits != 0; end_bits-- )
2983 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2984 }
2985
2986 memset( mask + offset / 8, 0xFF, len / 8 );
2987}
2988
2989/*
2990 * Check that bitmask is full
2991 */
2992static int ssl_bitmask_check( unsigned char *mask, size_t len )
2993{
2994 size_t i;
2995
2996 for( i = 0; i < len / 8; i++ )
2997 if( mask[i] != 0xFF )
2998 return( -1 );
2999
3000 for( i = 0; i < len % 8; i++ )
3001 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3002 return( -1 );
3003
3004 return( 0 );
3005}
3006
Hanno Becker56e205e2018-08-16 09:06:12 +01003007/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003008static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003009 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003010{
Hanno Becker56e205e2018-08-16 09:06:12 +01003011 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003012
Hanno Becker56e205e2018-08-16 09:06:12 +01003013 alloc_len = 12; /* Handshake header */
3014 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003015
Hanno Beckerd07df862018-08-16 09:14:58 +01003016 if( add_bitmap )
3017 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003018
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003019 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003020}
Hanno Becker56e205e2018-08-16 09:06:12 +01003021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003023
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003024static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003025{
3026 return( ( ssl->in_msg[1] << 16 ) |
3027 ( ssl->in_msg[2] << 8 ) |
3028 ssl->in_msg[3] );
3029}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003030
Simon Butcher99000142016-10-13 17:21:01 +01003031int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003032{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003034 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00003035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003036 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003038 }
3039
Hanno Becker12555c62018-08-16 12:47:53 +01003040 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Paul Elliottd48d5c62021-01-07 14:47:05 +00003043 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003044 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003047 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003048 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003049 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003050 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003051
Hanno Becker44650b72018-08-16 12:51:11 +01003052 if( ssl_check_hs_header( ssl ) != 0 )
3053 {
3054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3055 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3056 }
3057
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003058 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003059 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3060 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3061 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3062 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003063 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003064 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3065 {
3066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3067 recv_msg_seq,
3068 ssl->handshake->in_msg_seq ) );
3069 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3070 }
3071
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003072 /* Retransmit only on last message from previous flight, to avoid
3073 * too many retransmissions.
3074 * Besides, No sane server ever retransmits HelloVerifyRequest */
3075 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Paul Elliott9f352112020-12-09 14:55:45 +00003079 "message_seq = %u, start_of_flight = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003080 recv_msg_seq,
3081 ssl->handshake->in_flight_start_seq ) );
3082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003084 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003086 return( ret );
3087 }
3088 }
3089 else
3090 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Paul Elliott9f352112020-12-09 14:55:45 +00003092 "message_seq = %u, expected = %u",
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003093 recv_msg_seq,
3094 ssl->handshake->in_msg_seq ) );
3095 }
3096
Hanno Becker90333da2017-10-10 11:27:13 +01003097 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003098 }
3099 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003100
Hanno Becker6d97ef52018-08-16 13:09:04 +01003101 /* Message reassembly is handled alongside buffering of future
3102 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003103 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003104 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003105 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003106 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003108 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003109 }
3110 }
3111 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003113 /* With TLS we don't handle fragmentation (for now) */
3114 if( ssl->in_msglen < ssl->in_hslen )
3115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3117 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003118 }
3119
Simon Butcher99000142016-10-13 17:21:01 +01003120 return( 0 );
3121}
3122
3123void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3124{
Hanno Becker0271f962018-08-16 13:23:47 +01003125 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003126
Hanno Becker0271f962018-08-16 13:23:47 +01003127 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003128 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003129 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003130 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003131
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003132 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003134 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003135 ssl->handshake != NULL )
3136 {
Hanno Becker0271f962018-08-16 13:23:47 +01003137 unsigned offset;
3138 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003139
Hanno Becker0271f962018-08-16 13:23:47 +01003140 /* Increment handshake sequence number */
3141 hs->in_msg_seq++;
3142
3143 /*
3144 * Clear up handshake buffering and reassembly structure.
3145 */
3146
3147 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003148 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003149
3150 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003151 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3152 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003153 offset++, hs_buf++ )
3154 {
3155 *hs_buf = *(hs_buf + 1);
3156 }
3157
3158 /* Create a fresh last entry */
3159 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003160 }
3161#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003162}
3163
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003164/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003165 * DTLS anti-replay: RFC 6347 4.1.2.6
3166 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003167 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3168 * Bit n is set iff record number in_window_top - n has been seen.
3169 *
3170 * Usually, in_window_top is the last record number seen and the lsb of
3171 * in_window is set. The only exception is the initial state (record number 0
3172 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003175void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003176{
3177 ssl->in_window_top = 0;
3178 ssl->in_window = 0;
3179}
3180
3181static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3182{
3183 return( ( (uint64_t) buf[0] << 40 ) |
3184 ( (uint64_t) buf[1] << 32 ) |
3185 ( (uint64_t) buf[2] << 24 ) |
3186 ( (uint64_t) buf[3] << 16 ) |
3187 ( (uint64_t) buf[4] << 8 ) |
3188 ( (uint64_t) buf[5] ) );
3189}
3190
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003191static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3192{
Janos Follath865b3eb2019-12-16 11:46:15 +00003193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003194 unsigned char *original_in_ctr;
3195
3196 // save original in_ctr
3197 original_in_ctr = ssl->in_ctr;
3198
3199 // use counter from record
3200 ssl->in_ctr = record_in_ctr;
3201
3202 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3203
3204 // restore the counter
3205 ssl->in_ctr = original_in_ctr;
3206
3207 return ret;
3208}
3209
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003210/*
3211 * Return 0 if sequence number is acceptable, -1 otherwise
3212 */
Hanno Becker0183d692019-07-12 08:50:37 +01003213int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003214{
3215 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3216 uint64_t bit;
3217
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003218 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003219 return( 0 );
3220
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003221 if( rec_seqnum > ssl->in_window_top )
3222 return( 0 );
3223
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003224 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003225
3226 if( bit >= 64 )
3227 return( -1 );
3228
3229 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3230 return( -1 );
3231
3232 return( 0 );
3233}
3234
3235/*
3236 * Update replay window on new validated record
3237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003239{
3240 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3241
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003242 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003243 return;
3244
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003245 if( rec_seqnum > ssl->in_window_top )
3246 {
3247 /* Update window_top and the contents of the window */
3248 uint64_t shift = rec_seqnum - ssl->in_window_top;
3249
3250 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003251 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003252 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003253 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003254 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003255 ssl->in_window |= 1;
3256 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003257
3258 ssl->in_window_top = rec_seqnum;
3259 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260 else
3261 {
3262 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003263 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003264
3265 if( bit < 64 ) /* Always true, but be extra sure */
3266 ssl->in_window |= (uint64_t) 1 << bit;
3267 }
3268}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003270
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003271#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003272/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003273 * Without any SSL context, check if a datagram looks like a ClientHello with
3274 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003275 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003276 *
3277 * - if cookie is valid, return 0
3278 * - if ClientHello looks superficially valid but cookie is not,
3279 * fill obuf and set olen, then
3280 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3281 * - otherwise return a specific error code
3282 */
3283static int ssl_check_dtls_clihlo_cookie(
3284 mbedtls_ssl_cookie_write_t *f_cookie_write,
3285 mbedtls_ssl_cookie_check_t *f_cookie_check,
3286 void *p_cookie,
3287 const unsigned char *cli_id, size_t cli_id_len,
3288 const unsigned char *in, size_t in_len,
3289 unsigned char *obuf, size_t buf_len, size_t *olen )
3290{
3291 size_t sid_len, cookie_len;
3292 unsigned char *p;
3293
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003294 /*
3295 * Structure of ClientHello with record and handshake headers,
3296 * and expected values. We don't need to check a lot, more checks will be
3297 * done when actually parsing the ClientHello - skipping those checks
3298 * avoids code duplication and does not make cookie forging any easier.
3299 *
3300 * 0-0 ContentType type; copied, must be handshake
3301 * 1-2 ProtocolVersion version; copied
3302 * 3-4 uint16 epoch; copied, must be 0
3303 * 5-10 uint48 sequence_number; copied
3304 * 11-12 uint16 length; (ignored)
3305 *
3306 * 13-13 HandshakeType msg_type; (ignored)
3307 * 14-16 uint24 length; (ignored)
3308 * 17-18 uint16 message_seq; copied
3309 * 19-21 uint24 fragment_offset; copied, must be 0
3310 * 22-24 uint24 fragment_length; (ignored)
3311 *
3312 * 25-26 ProtocolVersion client_version; (ignored)
3313 * 27-58 Random random; (ignored)
3314 * 59-xx SessionID session_id; 1 byte len + sid_len content
3315 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3316 * ...
3317 *
3318 * Minimum length is 61 bytes.
3319 */
3320 if( in_len < 61 ||
3321 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3322 in[3] != 0 || in[4] != 0 ||
3323 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3324 {
3325 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3326 }
3327
3328 sid_len = in[59];
3329 if( sid_len > in_len - 61 )
3330 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3331
3332 cookie_len = in[60 + sid_len];
3333 if( cookie_len > in_len - 60 )
3334 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3335
3336 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3337 cli_id, cli_id_len ) == 0 )
3338 {
3339 /* Valid cookie */
3340 return( 0 );
3341 }
3342
3343 /*
3344 * If we get here, we've got an invalid cookie, let's prepare HVR.
3345 *
3346 * 0-0 ContentType type; copied
3347 * 1-2 ProtocolVersion version; copied
3348 * 3-4 uint16 epoch; copied
3349 * 5-10 uint48 sequence_number; copied
3350 * 11-12 uint16 length; olen - 13
3351 *
3352 * 13-13 HandshakeType msg_type; hello_verify_request
3353 * 14-16 uint24 length; olen - 25
3354 * 17-18 uint16 message_seq; copied
3355 * 19-21 uint24 fragment_offset; copied
3356 * 22-24 uint24 fragment_length; olen - 25
3357 *
3358 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3359 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3360 *
3361 * Minimum length is 28.
3362 */
3363 if( buf_len < 28 )
3364 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3365
3366 /* Copy most fields and adapt others */
3367 memcpy( obuf, in, 25 );
3368 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3369 obuf[25] = 0xfe;
3370 obuf[26] = 0xff;
3371
3372 /* Generate and write actual cookie */
3373 p = obuf + 28;
3374 if( f_cookie_write( p_cookie,
3375 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3376 {
3377 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3378 }
3379
3380 *olen = p - obuf;
3381
3382 /* Go back and fill length fields */
3383 obuf[27] = (unsigned char)( *olen - 28 );
3384
Joe Subbianiad1115a2021-07-16 14:27:50 +01003385 obuf[14] = obuf[22] = MBEDTLS_BYTE_2( *olen - 25 );
3386 obuf[15] = obuf[23] = MBEDTLS_BYTE_1( *olen - 25 );
3387 obuf[16] = obuf[24] = MBEDTLS_BYTE_0( *olen - 25 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003388
Joe Subbianic54e9082021-07-19 11:56:54 +01003389 MBEDTLS_PUT_UINT16_BE( *olen - 13, obuf, 11 );
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003390
3391 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3392}
3393
3394/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003395 * Handle possible client reconnect with the same UDP quadruplet
3396 * (RFC 6347 Section 4.2.8).
3397 *
3398 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3399 * that looks like a ClientHello.
3400 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003401 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003402 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003403 * - if the input looks like a ClientHello with a valid cookie,
3404 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003405 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003406 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003407 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003408 * This function is called (through ssl_check_client_reconnect()) when an
3409 * unexpected record is found in ssl_get_next_record(), which will discard the
3410 * record if we return 0, and bubble up the return value otherwise (this
3411 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3412 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003413 */
3414static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3415{
Janos Follath865b3eb2019-12-16 11:46:15 +00003416 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003417 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003418
Hanno Becker2fddd372019-07-10 14:37:41 +01003419 if( ssl->conf->f_cookie_write == NULL ||
3420 ssl->conf->f_cookie_check == NULL )
3421 {
3422 /* If we can't use cookies to verify reachability of the peer,
3423 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3425 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003426 return( 0 );
3427 }
3428
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003429 ret = ssl_check_dtls_clihlo_cookie(
3430 ssl->conf->f_cookie_write,
3431 ssl->conf->f_cookie_check,
3432 ssl->conf->p_cookie,
3433 ssl->cli_id, ssl->cli_id_len,
3434 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003435 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003436
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003437 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3438
3439 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003440 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003441 int send_ret;
3442 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3443 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3444 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003445 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003446 * If the error is permanent we'll catch it later,
3447 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003448 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3449 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3450 (void) send_ret;
3451
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003452 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003453 }
3454
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003455 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003456 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003458 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003459 {
3460 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3461 return( ret );
3462 }
3463
3464 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003465 }
3466
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003467 return( ret );
3468}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003469#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003470
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003471static int ssl_check_record_type( uint8_t record_type )
3472{
3473 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3474 record_type != MBEDTLS_SSL_MSG_ALERT &&
3475 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3476 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3477 {
3478 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3479 }
3480
3481 return( 0 );
3482}
3483
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003484/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003485 * ContentType type;
3486 * ProtocolVersion version;
3487 * uint16 epoch; // DTLS only
3488 * uint48 sequence_number; // DTLS only
3489 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003490 *
3491 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003492 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003493 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3494 *
3495 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003496 * 1. proceed with the record if this function returns 0
3497 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3498 * 3. return CLIENT_RECONNECT if this function return that value
3499 * 4. drop the whole datagram if this function returns anything else.
3500 * Point 2 is needed when the peer is resending, and we have already received
3501 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003502 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003503static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003504 unsigned char *buf,
3505 size_t len,
3506 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003507{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003508 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003509
Hanno Beckere5e7e782019-07-11 12:29:35 +01003510 size_t const rec_hdr_type_offset = 0;
3511 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003512
Hanno Beckere5e7e782019-07-11 12:29:35 +01003513 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3514 rec_hdr_type_len;
3515 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003516
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 size_t const rec_hdr_ctr_len = 8;
3518#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003519 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003520 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3521 rec_hdr_version_len;
3522
Hanno Beckera0e20d02019-05-15 14:03:01 +01003523#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3525 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003526 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003527#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3528#endif /* MBEDTLS_SSL_PROTO_DTLS */
3529
3530 size_t rec_hdr_len_offset; /* To be determined */
3531 size_t const rec_hdr_len_len = 2;
3532
3533 /*
3534 * Check minimum lengths for record header.
3535 */
3536
3537#if defined(MBEDTLS_SSL_PROTO_DTLS)
3538 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3539 {
3540 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3541 }
3542 else
3543#endif /* MBEDTLS_SSL_PROTO_DTLS */
3544 {
3545 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3546 }
3547
3548 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3549 {
3550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3551 (unsigned) len,
3552 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3553 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3554 }
3555
3556 /*
3557 * Parse and validate record content type
3558 */
3559
3560 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003561
3562 /* Check record content type */
3563#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3564 rec->cid_len = 0;
3565
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003566 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567 ssl->conf->cid_len != 0 &&
3568 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003569 {
3570 /* Shift pointers to account for record header including CID
3571 * struct {
3572 * ContentType special_type = tls12_cid;
3573 * ProtocolVersion version;
3574 * uint16 epoch;
3575 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003576 * opaque cid[cid_length]; // Additional field compared to
3577 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003578 * uint16 length;
3579 * opaque enc_content[DTLSCiphertext.length];
3580 * } DTLSCiphertext;
3581 */
3582
3583 /* So far, we only support static CID lengths
3584 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003585 rec_hdr_cid_len = ssl->conf->cid_len;
3586 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003587
Hanno Beckere5e7e782019-07-11 12:29:35 +01003588 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003589 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3591 (unsigned) len,
3592 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003593 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003594 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003595
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003596 /* configured CID len is guaranteed at most 255, see
3597 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3598 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003599 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003600 }
3601 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003602#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003603 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003604 if( ssl_check_record_type( rec->type ) )
3605 {
Hanno Becker54229812019-07-12 14:40:00 +01003606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3607 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3609 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003610 }
3611
Hanno Beckere5e7e782019-07-11 12:29:35 +01003612 /*
3613 * Parse and validate record version
3614 */
3615
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003616 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3617 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003618 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3619 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003620 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003621
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003622 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003623 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3625 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003626 }
3627
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003628 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3631 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003632 }
3633
Hanno Beckere5e7e782019-07-11 12:29:35 +01003634 /*
3635 * Parse/Copy record sequence number.
3636 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003637
Hanno Beckere5e7e782019-07-11 12:29:35 +01003638#if defined(MBEDTLS_SSL_PROTO_DTLS)
3639 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003640 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003641 /* Copy explicit record sequence number from input buffer. */
3642 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3643 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003644 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003645 else
3646#endif /* MBEDTLS_SSL_PROTO_DTLS */
3647 {
3648 /* Copy implicit record sequence number from SSL context structure. */
3649 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3650 }
Paul Bakker40e46942009-01-03 21:51:57 +00003651
Hanno Beckere5e7e782019-07-11 12:29:35 +01003652 /*
3653 * Parse record length.
3654 */
3655
Hanno Beckere5e7e782019-07-11 12:29:35 +01003656 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003657 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3658 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003659 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003660
Paul Elliott9f352112020-12-09 14:55:45 +00003661 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %u, "
Paul Elliottd48d5c62021-01-07 14:47:05 +00003662 "version = [%d:%d], msglen = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003663 rec->type,
3664 major_ver, minor_ver, rec->data_len ) );
3665
3666 rec->buf = buf;
3667 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003668
Hanno Beckerd417cc92019-07-26 08:20:27 +01003669 if( rec->data_len == 0 )
3670 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003671
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003672 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003673 * DTLS-related tests.
3674 * Check epoch before checking length constraint because
3675 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3676 * message gets duplicated before the corresponding Finished message,
3677 * the second ChangeCipherSpec should be discarded because it belongs
3678 * to an old epoch, but not because its length is shorter than
3679 * the minimum record length for packets using the new record transform.
3680 * Note that these two kinds of failures are handled differently,
3681 * as an unexpected record is silently skipped but an invalid
3682 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003683 */
3684#if defined(MBEDTLS_SSL_PROTO_DTLS)
3685 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3686 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003687 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003688
Hanno Becker955a5c92019-07-10 17:12:07 +01003689 /* Check that the datagram is large enough to contain a record
3690 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003691 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003692 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3694 (unsigned) len,
3695 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003696 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3697 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003698
Hanno Becker37cfe732019-07-10 17:20:01 +01003699 /* Records from other, non-matching epochs are silently discarded.
3700 * (The case of same-port Client reconnects must be considered in
3701 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 if( rec_epoch != ssl->in_epoch )
3703 {
3704 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
Paul Elliott9f352112020-12-09 14:55:45 +00003705 "expected %u, received %lu",
3706 ssl->in_epoch, (unsigned long) rec_epoch ) );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003707
Hanno Becker552f7472019-07-19 10:59:12 +01003708 /* Records from the next epoch are considered for buffering
3709 * (concretely: early Finished messages). */
3710 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 {
Hanno Becker552f7472019-07-19 10:59:12 +01003712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3713 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003714 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003715
Hanno Becker2fddd372019-07-10 14:37:41 +01003716 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003717 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003718#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003719 /* For records from the correct epoch, check whether their
3720 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003721 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3722 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003723 {
3724 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3725 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3726 }
3727#endif
3728 }
3729#endif /* MBEDTLS_SSL_PROTO_DTLS */
3730
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003731 return( 0 );
3732}
Paul Bakker5121ce52009-01-03 21:22:43 +00003733
Paul Bakker5121ce52009-01-03 21:22:43 +00003734
Hanno Becker2fddd372019-07-10 14:37:41 +01003735#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3736static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3737{
3738 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3739
3740 /*
3741 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3742 * access the first byte of record content (handshake type), as we
3743 * have an active transform (possibly iv_len != 0), so use the
3744 * fact that the record header len is 13 instead.
3745 */
3746 if( rec_epoch == 0 &&
3747 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3748 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3749 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3750 ssl->in_left > 13 &&
3751 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3752 {
3753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3754 "from the same port" ) );
3755 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003756 }
3757
3758 return( 0 );
3759}
Hanno Becker2fddd372019-07-10 14:37:41 +01003760#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003761
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003762/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003763 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003764 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003765static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3766 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003767{
3768 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003771 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3774 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778 ret = mbedtls_ssl_hw_record_read( ssl );
3779 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3782 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003783 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003784
3785 if( ret == 0 )
3786 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003787 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003788#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003789 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003790 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003791 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003792
Hanno Beckera18d1322018-01-03 14:27:32 +00003793 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003794 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003795 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003796 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003797
Hanno Beckera0e20d02019-05-15 14:03:01 +01003798#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003799 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3800 ssl->conf->ignore_unexpected_cid
3801 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3802 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003803 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003804 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003805 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003806#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003807
Paul Bakker5121ce52009-01-03 21:22:43 +00003808 return( ret );
3809 }
3810
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003811 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003812 {
3813 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003814 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003815 }
3816
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003817 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003818 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003819
Hanno Beckera0e20d02019-05-15 14:03:01 +01003820#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003821 /* We have already checked the record content type
3822 * in ssl_parse_record_header(), failing or silently
3823 * dropping the record in the case of an unknown type.
3824 *
3825 * Since with the use of CIDs, the record content type
3826 * might change during decryption, re-check the record
3827 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003828 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003829 {
3830 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3831 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3832 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003833#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003834
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003835 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003836 {
3837#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3838 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003839 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003840 {
3841 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3842 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3843 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3844 }
3845#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3846
3847 ssl->nb_zero++;
3848
3849 /*
3850 * Three or more empty messages may be a DoS attack
3851 * (excessive CPU consumption).
3852 */
3853 if( ssl->nb_zero > 3 )
3854 {
3855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003856 "messages, possible DoS attack" ) );
3857 /* Treat the records as if they were not properly authenticated,
3858 * thereby failing the connection if we see more than allowed
3859 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003860 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3861 }
3862 }
3863 else
3864 ssl->nb_zero = 0;
3865
3866#if defined(MBEDTLS_SSL_PROTO_DTLS)
3867 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3868 {
3869 ; /* in_ctr read from peer, not maintained internally */
3870 }
3871 else
3872#endif
3873 {
3874 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003875 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003876 if( ++ssl->in_ctr[i - 1] != 0 )
3877 break;
3878
3879 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003880 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003881 {
3882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3883 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3884 }
3885 }
3886
Paul Bakker5121ce52009-01-03 21:22:43 +00003887 }
3888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003890 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003891 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003892 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003893 }
3894#endif
3895
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003896 /* Check actual (decrypted) record content length against
3897 * configured maximum. */
3898 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3899 {
3900 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3901 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3902 }
3903
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003904 return( 0 );
3905}
3906
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003907/*
3908 * Read a record.
3909 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003910 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3911 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3912 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003913 */
Hanno Becker1097b342018-08-15 14:09:41 +01003914
3915/* Helper functions for mbedtls_ssl_read_record(). */
3916static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003917static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3918static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003919
Hanno Becker327c93b2018-08-15 13:56:18 +01003920int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003921 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003922{
Janos Follath865b3eb2019-12-16 11:46:15 +00003923 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003926
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003927 if( ssl->keep_current_message == 0 )
3928 {
3929 do {
Simon Butcher99000142016-10-13 17:21:01 +01003930
Hanno Becker26994592018-08-15 14:14:59 +01003931 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003932 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003933 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003934
Hanno Beckere74d5562018-08-15 14:26:08 +01003935 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003936 {
Hanno Becker40f50842018-08-15 14:48:01 +01003937#if defined(MBEDTLS_SSL_PROTO_DTLS)
3938 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003939
Hanno Becker40f50842018-08-15 14:48:01 +01003940 /* We only check for buffered messages if the
3941 * current datagram is fully consumed. */
3942 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003943 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003944 {
Hanno Becker40f50842018-08-15 14:48:01 +01003945 if( ssl_load_buffered_message( ssl ) == 0 )
3946 have_buffered = 1;
3947 }
3948
3949 if( have_buffered == 0 )
3950#endif /* MBEDTLS_SSL_PROTO_DTLS */
3951 {
3952 ret = ssl_get_next_record( ssl );
3953 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3954 continue;
3955
3956 if( ret != 0 )
3957 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003958 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003959 return( ret );
3960 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003961 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003962 }
3963
3964 ret = mbedtls_ssl_handle_message_type( ssl );
3965
Hanno Becker40f50842018-08-15 14:48:01 +01003966#if defined(MBEDTLS_SSL_PROTO_DTLS)
3967 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3968 {
3969 /* Buffer future message */
3970 ret = ssl_buffer_message( ssl );
3971 if( ret != 0 )
3972 return( ret );
3973
3974 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3975 }
3976#endif /* MBEDTLS_SSL_PROTO_DTLS */
3977
Hanno Becker90333da2017-10-10 11:27:13 +01003978 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3979 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003980
3981 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003982 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003983 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003984 return( ret );
3985 }
3986
Hanno Becker327c93b2018-08-15 13:56:18 +01003987 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003988 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003989 {
3990 mbedtls_ssl_update_handshake_status( ssl );
3991 }
Simon Butcher99000142016-10-13 17:21:01 +01003992 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003993 else
Simon Butcher99000142016-10-13 17:21:01 +01003994 {
Hanno Becker02f59072018-08-15 14:00:24 +01003995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003996 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003997 }
3998
3999 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4000
4001 return( 0 );
4002}
4003
Hanno Becker40f50842018-08-15 14:48:01 +01004004#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004005static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004006{
Hanno Becker40f50842018-08-15 14:48:01 +01004007 if( ssl->in_left > ssl->next_record_offset )
4008 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004009
Hanno Becker40f50842018-08-15 14:48:01 +01004010 return( 0 );
4011}
4012
4013static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4014{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004015 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004016 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004017 int ret = 0;
4018
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004019 if( hs == NULL )
4020 return( -1 );
4021
Hanno Beckere00ae372018-08-20 09:39:42 +01004022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4023
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004024 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4025 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4026 {
4027 /* Check if we have seen a ChangeCipherSpec before.
4028 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004029 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004030 {
4031 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4032 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004033 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004034 }
4035
Hanno Becker39b8bc92018-08-28 17:17:13 +01004036 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004037 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4038 ssl->in_msglen = 1;
4039 ssl->in_msg[0] = 1;
4040
4041 /* As long as they are equal, the exact value doesn't matter. */
4042 ssl->in_left = 0;
4043 ssl->next_record_offset = 0;
4044
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004045 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004046 goto exit;
4047 }
Hanno Becker37f95322018-08-16 13:55:32 +01004048
Hanno Beckerb8f50142018-08-28 10:01:34 +01004049#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004050 /* Debug only */
4051 {
4052 unsigned offset;
4053 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4054 {
4055 hs_buf = &hs->buffering.hs[offset];
4056 if( hs_buf->is_valid == 1 )
4057 {
4058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4059 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004060 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004061 }
4062 }
4063 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004064#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004065
4066 /* Check if we have buffered and/or fully reassembled the
4067 * next handshake message. */
4068 hs_buf = &hs->buffering.hs[0];
4069 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4070 {
4071 /* Synthesize a record containing the buffered HS message. */
4072 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4073 ( hs_buf->data[2] << 8 ) |
4074 hs_buf->data[3];
4075
4076 /* Double-check that we haven't accidentally buffered
4077 * a message that doesn't fit into the input buffer. */
4078 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4079 {
4080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4081 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4082 }
4083
4084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4085 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4086 hs_buf->data, msg_len + 12 );
4087
4088 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4089 ssl->in_hslen = msg_len + 12;
4090 ssl->in_msglen = msg_len + 12;
4091 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4092
4093 ret = 0;
4094 goto exit;
4095 }
4096 else
4097 {
4098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4099 hs->in_msg_seq ) );
4100 }
4101
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004102 ret = -1;
4103
4104exit:
4105
4106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4107 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004108}
4109
Hanno Beckera02b0b42018-08-21 17:20:27 +01004110static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4111 size_t desired )
4112{
4113 int offset;
4114 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4116 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004117
Hanno Becker01315ea2018-08-21 17:22:17 +01004118 /* Get rid of future records epoch first, if such exist. */
4119 ssl_free_buffered_record( ssl );
4120
4121 /* Check if we have enough space available now. */
4122 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4123 hs->buffering.total_bytes_buffered ) )
4124 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004125 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004126 return( 0 );
4127 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004128
Hanno Becker4f432ad2018-08-28 10:02:32 +01004129 /* We don't have enough space to buffer the next expected handshake
4130 * message. Remove buffers used for future messages to gain space,
4131 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004132 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4133 offset >= 0; offset-- )
4134 {
4135 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4136 offset ) );
4137
Hanno Beckerb309b922018-08-23 13:18:05 +01004138 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004139
4140 /* Check if we have enough space available now. */
4141 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4142 hs->buffering.total_bytes_buffered ) )
4143 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004145 return( 0 );
4146 }
4147 }
4148
4149 return( -1 );
4150}
4151
Hanno Becker40f50842018-08-15 14:48:01 +01004152static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4153{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004154 int ret = 0;
4155 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4156
4157 if( hs == NULL )
4158 return( 0 );
4159
4160 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4161
4162 switch( ssl->in_msgtype )
4163 {
4164 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4165 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004166
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004167 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004168 break;
4169
4170 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004171 {
4172 unsigned recv_msg_seq_offset;
4173 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4174 mbedtls_ssl_hs_buffer *hs_buf;
4175 size_t msg_len = ssl->in_hslen - 12;
4176
4177 /* We should never receive an old handshake
4178 * message - double-check nonetheless. */
4179 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4180 {
4181 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4182 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4183 }
4184
4185 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4186 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4187 {
4188 /* Silently ignore -- message too far in the future */
4189 MBEDTLS_SSL_DEBUG_MSG( 2,
4190 ( "Ignore future HS message with sequence number %u, "
4191 "buffering window %u - %u",
4192 recv_msg_seq, ssl->handshake->in_msg_seq,
4193 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4194
4195 goto exit;
4196 }
4197
4198 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4199 recv_msg_seq, recv_msg_seq_offset ) );
4200
4201 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4202
4203 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004204 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004205 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004206 size_t reassembly_buf_sz;
4207
Hanno Becker37f95322018-08-16 13:55:32 +01004208 hs_buf->is_fragmented =
4209 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4210
4211 /* We copy the message back into the input buffer
4212 * after reassembly, so check that it's not too large.
4213 * This is an implementation-specific limitation
4214 * and not one from the standard, hence it is not
4215 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004216 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004217 {
4218 /* Ignore message */
4219 goto exit;
4220 }
4221
Hanno Beckere0b150f2018-08-21 15:51:03 +01004222 /* Check if we have enough space to buffer the message. */
4223 if( hs->buffering.total_bytes_buffered >
4224 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4225 {
4226 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4227 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4228 }
4229
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004230 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4231 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004232
4233 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4234 hs->buffering.total_bytes_buffered ) )
4235 {
4236 if( recv_msg_seq_offset > 0 )
4237 {
4238 /* If we can't buffer a future message because
4239 * of space limitations -- ignore. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004240 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4241 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4242 " (already %" MBEDTLS_PRINTF_SIZET
4243 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004244 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004245 hs->buffering.total_bytes_buffered ) );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004246 goto exit;
4247 }
Hanno Beckere1801392018-08-21 16:51:05 +01004248 else
4249 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004250 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %" MBEDTLS_PRINTF_SIZET
4251 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4252 " (already %" MBEDTLS_PRINTF_SIZET
4253 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004254 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004255 hs->buffering.total_bytes_buffered ) );
Hanno Beckere1801392018-08-21 16:51:05 +01004256 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004257
Hanno Beckera02b0b42018-08-21 17:20:27 +01004258 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004259 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %" MBEDTLS_PRINTF_SIZET
4261 " (%" MBEDTLS_PRINTF_SIZET " with bitmap) would exceed"
4262 " the compile-time limit %" MBEDTLS_PRINTF_SIZET
4263 " (already %" MBEDTLS_PRINTF_SIZET
4264 " bytes buffered) -- fail\n",
Paul Elliott9f352112020-12-09 14:55:45 +00004265 msg_len,
4266 reassembly_buf_sz,
Paul Elliott3891caf2020-12-17 18:42:40 +00004267 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004268 hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004269 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4270 goto exit;
4271 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004272 }
4273
Paul Elliottd48d5c62021-01-07 14:47:05 +00004274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004275 msg_len ) );
4276
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004277 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4278 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004279 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004280 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004281 goto exit;
4282 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004283 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004284
4285 /* Prepare final header: copy msg_type, length and message_seq,
4286 * then add standardised fragment_offset and fragment_length */
4287 memcpy( hs_buf->data, ssl->in_msg, 6 );
4288 memset( hs_buf->data + 6, 0, 3 );
4289 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4290
4291 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004292
4293 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004294 }
4295 else
4296 {
4297 /* Make sure msg_type and length are consistent */
4298 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4299 {
4300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4301 /* Ignore */
4302 goto exit;
4303 }
4304 }
4305
Hanno Becker4422bbb2018-08-20 09:40:19 +01004306 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004307 {
4308 size_t frag_len, frag_off;
4309 unsigned char * const msg = hs_buf->data + 12;
4310
4311 /*
4312 * Check and copy current fragment
4313 */
4314
4315 /* Validation of header fields already done in
4316 * mbedtls_ssl_prepare_handshake_record(). */
4317 frag_off = ssl_get_hs_frag_off( ssl );
4318 frag_len = ssl_get_hs_frag_len( ssl );
4319
Paul Elliottd48d5c62021-01-07 14:47:05 +00004320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4321 ", length = %" MBEDTLS_PRINTF_SIZET,
Hanno Becker37f95322018-08-16 13:55:32 +01004322 frag_off, frag_len ) );
4323 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4324
4325 if( hs_buf->is_fragmented )
4326 {
4327 unsigned char * const bitmask = msg + msg_len;
4328 ssl_bitmask_set( bitmask, frag_off, frag_len );
4329 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4330 msg_len ) == 0 );
4331 }
4332 else
4333 {
4334 hs_buf->is_complete = 1;
4335 }
4336
4337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4338 hs_buf->is_complete ? "" : "not yet " ) );
4339 }
4340
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004341 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004342 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004343
4344 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004345 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004346 break;
4347 }
4348
4349exit:
4350
4351 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4352 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004353}
4354#endif /* MBEDTLS_SSL_PROTO_DTLS */
4355
Hanno Becker1097b342018-08-15 14:09:41 +01004356static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004357{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004358 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004359 * Consume last content-layer message and potentially
4360 * update in_msglen which keeps track of the contents'
4361 * consumption state.
4362 *
4363 * (1) Handshake messages:
4364 * Remove last handshake message, move content
4365 * and adapt in_msglen.
4366 *
4367 * (2) Alert messages:
4368 * Consume whole record content, in_msglen = 0.
4369 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004370 * (3) Change cipher spec:
4371 * Consume whole record content, in_msglen = 0.
4372 *
4373 * (4) Application data:
4374 * Don't do anything - the record layer provides
4375 * the application data as a stream transport
4376 * and consumes through mbedtls_ssl_read only.
4377 *
4378 */
4379
4380 /* Case (1): Handshake messages */
4381 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004382 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004383 /* Hard assertion to be sure that no application data
4384 * is in flight, as corrupting ssl->in_msglen during
4385 * ssl->in_offt != NULL is fatal. */
4386 if( ssl->in_offt != NULL )
4387 {
4388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4389 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4390 }
4391
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004392 /*
4393 * Get next Handshake message in the current record
4394 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004395
Hanno Becker4a810fb2017-05-24 16:27:30 +01004396 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004397 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004398 * current handshake content: If DTLS handshake
4399 * fragmentation is used, that's the fragment
4400 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004401 * size here is faulty and should be changed at
4402 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004403 * (2) While it doesn't seem to cause problems, one
4404 * has to be very careful not to assume that in_hslen
4405 * is always <= in_msglen in a sensible communication.
4406 * Again, it's wrong for DTLS handshake fragmentation.
4407 * The following check is therefore mandatory, and
4408 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004409 * Additionally, ssl->in_hslen might be arbitrarily out of
4410 * bounds after handling a DTLS message with an unexpected
4411 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004412 */
4413 if( ssl->in_hslen < ssl->in_msglen )
4414 {
4415 ssl->in_msglen -= ssl->in_hslen;
4416 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4417 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004418
Hanno Becker4a810fb2017-05-24 16:27:30 +01004419 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4420 ssl->in_msg, ssl->in_msglen );
4421 }
4422 else
4423 {
4424 ssl->in_msglen = 0;
4425 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004426
Hanno Becker4a810fb2017-05-24 16:27:30 +01004427 ssl->in_hslen = 0;
4428 }
4429 /* Case (4): Application data */
4430 else if( ssl->in_offt != NULL )
4431 {
4432 return( 0 );
4433 }
4434 /* Everything else (CCS & Alerts) */
4435 else
4436 {
4437 ssl->in_msglen = 0;
4438 }
4439
Hanno Becker1097b342018-08-15 14:09:41 +01004440 return( 0 );
4441}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004442
Hanno Beckere74d5562018-08-15 14:26:08 +01004443static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4444{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004445 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004446 return( 1 );
4447
4448 return( 0 );
4449}
4450
Hanno Becker5f066e72018-08-16 14:56:31 +01004451#if defined(MBEDTLS_SSL_PROTO_DTLS)
4452
4453static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4454{
4455 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4456 if( hs == NULL )
4457 return;
4458
Hanno Becker01315ea2018-08-21 17:22:17 +01004459 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004460 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004461 hs->buffering.total_bytes_buffered -=
4462 hs->buffering.future_record.len;
4463
4464 mbedtls_free( hs->buffering.future_record.data );
4465 hs->buffering.future_record.data = NULL;
4466 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004467}
4468
4469static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4470{
4471 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4472 unsigned char * rec;
4473 size_t rec_len;
4474 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004475#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4476 size_t in_buf_len = ssl->in_buf_len;
4477#else
4478 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4479#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004480 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4481 return( 0 );
4482
4483 if( hs == NULL )
4484 return( 0 );
4485
Hanno Becker5f066e72018-08-16 14:56:31 +01004486 rec = hs->buffering.future_record.data;
4487 rec_len = hs->buffering.future_record.len;
4488 rec_epoch = hs->buffering.future_record.epoch;
4489
4490 if( rec == NULL )
4491 return( 0 );
4492
Hanno Becker4cb782d2018-08-20 11:19:05 +01004493 /* Only consider loading future records if the
4494 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004495 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004496 return( 0 );
4497
Hanno Becker5f066e72018-08-16 14:56:31 +01004498 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4499
4500 if( rec_epoch != ssl->in_epoch )
4501 {
4502 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4503 goto exit;
4504 }
4505
4506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4507
4508 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004509 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004510 {
4511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4513 }
4514
4515 memcpy( ssl->in_hdr, rec, rec_len );
4516 ssl->in_left = rec_len;
4517 ssl->next_record_offset = 0;
4518
4519 ssl_free_buffered_record( ssl );
4520
4521exit:
4522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4523 return( 0 );
4524}
4525
Hanno Becker519f15d2019-07-11 12:43:20 +01004526static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4527 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004528{
4529 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004530
4531 /* Don't buffer future records outside handshakes. */
4532 if( hs == NULL )
4533 return( 0 );
4534
4535 /* Only buffer handshake records (we are only interested
4536 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004537 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004538 return( 0 );
4539
4540 /* Don't buffer more than one future epoch record. */
4541 if( hs->buffering.future_record.data != NULL )
4542 return( 0 );
4543
Hanno Becker01315ea2018-08-21 17:22:17 +01004544 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004545 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004546 hs->buffering.total_bytes_buffered ) )
4547 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004548 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4549 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4550 " (already %" MBEDTLS_PRINTF_SIZET
4551 " bytes buffered) -- ignore\n",
Paul Elliott3891caf2020-12-17 18:42:40 +00004552 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Paul Elliott9f352112020-12-09 14:55:45 +00004553 hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004554 return( 0 );
4555 }
4556
Hanno Becker5f066e72018-08-16 14:56:31 +01004557 /* Buffer record */
4558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
Paul Elliott9f352112020-12-09 14:55:45 +00004559 ssl->in_epoch + 1U ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004560 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004561
4562 /* ssl_parse_record_header() only considers records
4563 * of the next epoch as candidates for buffering. */
4564 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004565 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004566
4567 hs->buffering.future_record.data =
4568 mbedtls_calloc( 1, hs->buffering.future_record.len );
4569 if( hs->buffering.future_record.data == NULL )
4570 {
4571 /* If we run out of RAM trying to buffer a
4572 * record from the next epoch, just ignore. */
4573 return( 0 );
4574 }
4575
Hanno Becker519f15d2019-07-11 12:43:20 +01004576 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004577
Hanno Becker519f15d2019-07-11 12:43:20 +01004578 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004579 return( 0 );
4580}
4581
4582#endif /* MBEDTLS_SSL_PROTO_DTLS */
4583
Hanno Beckere74d5562018-08-15 14:26:08 +01004584static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004585{
Janos Follath865b3eb2019-12-16 11:46:15 +00004586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004587 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004588
Hanno Becker5f066e72018-08-16 14:56:31 +01004589#if defined(MBEDTLS_SSL_PROTO_DTLS)
4590 /* We might have buffered a future record; if so,
4591 * and if the epoch matches now, load it.
4592 * On success, this call will set ssl->in_left to
4593 * the length of the buffered record, so that
4594 * the calls to ssl_fetch_input() below will
4595 * essentially be no-ops. */
4596 ret = ssl_load_buffered_record( ssl );
4597 if( ret != 0 )
4598 return( ret );
4599#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004600
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004601 /* Ensure that we have enough space available for the default form
4602 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4603 * with no space for CIDs counted in). */
4604 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4605 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004606 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004608 return( ret );
4609 }
4610
Hanno Beckere5e7e782019-07-11 12:29:35 +01004611 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4612 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004614#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004615 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004616 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004617 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4618 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004619 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004620 if( ret != 0 )
4621 return( ret );
4622
4623 /* Fall through to handling of unexpected records */
4624 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4625 }
4626
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004627 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4628 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004629#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004630 /* Reset in pointers to default state for TLS/DTLS records,
4631 * assuming no CID and no offset between record content and
4632 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004633 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004634
Hanno Becker7ae20e02019-07-12 08:33:49 +01004635 /* Setup internal message pointers from record structure. */
4636 ssl->in_msgtype = rec.type;
4637#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4638 ssl->in_len = ssl->in_cid + rec.cid_len;
4639#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4640 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4641 ssl->in_msglen = rec.data_len;
4642
Hanno Becker2fddd372019-07-10 14:37:41 +01004643 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004644 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004645 if( ret != 0 )
4646 return( ret );
4647#endif
4648
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004649 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004650 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004651
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4653 "(header)" ) );
4654 }
4655 else
4656 {
4657 /* Skip invalid record and the rest of the datagram */
4658 ssl->next_record_offset = 0;
4659 ssl->in_left = 0;
4660
4661 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4662 "(header)" ) );
4663 }
4664
4665 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004666 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004667 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004668 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004669#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004670 {
4671 return( ret );
4672 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004673 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004675#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004676 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004677 {
Hanno Beckera8814792019-07-10 15:01:45 +01004678 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004679 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004680 if( ssl->next_record_offset < ssl->in_left )
4681 {
4682 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4683 }
4684 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004685 else
4686#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004687 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004688 /*
4689 * Fetch record contents from underlying transport.
4690 */
Hanno Beckera3175662019-07-11 12:50:29 +01004691 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004692 if( ret != 0 )
4693 {
4694 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4695 return( ret );
4696 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004697
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004698 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004699 }
4700
4701 /*
4702 * Decrypt record contents.
4703 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004704
Hanno Beckerfdf66042019-07-11 13:07:45 +01004705 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004706 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004707#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004708 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004709 {
4710 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004711 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004712 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004713 /* Except when waiting for Finished as a bad mac here
4714 * probably means something went wrong in the handshake
4715 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4716 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4717 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4718 {
4719#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4720 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4721 {
4722 mbedtls_ssl_send_alert_message( ssl,
4723 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4724 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4725 }
4726#endif
4727 return( ret );
4728 }
4729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004731 if( ssl->conf->badmac_limit != 0 &&
4732 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004733 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4735 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004736 }
4737#endif
4738
Hanno Becker4a810fb2017-05-24 16:27:30 +01004739 /* As above, invalid records cause
4740 * dismissal of the whole datagram. */
4741
4742 ssl->next_record_offset = 0;
4743 ssl->in_left = 0;
4744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004746 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004747 }
4748
4749 return( ret );
4750 }
4751 else
4752#endif
4753 {
4754 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4756 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 mbedtls_ssl_send_alert_message( ssl,
4759 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4760 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004761 }
4762#endif
4763 return( ret );
4764 }
4765 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004766
Hanno Becker44d89b22019-07-12 09:40:44 +01004767
4768 /* Reset in pointers to default state for TLS/DTLS records,
4769 * assuming no CID and no offset between record content and
4770 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004771 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004772#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4773 ssl->in_len = ssl->in_cid + rec.cid_len;
4774#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004775 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004776
Hanno Becker8685c822019-07-12 09:37:30 +01004777 /* The record content type may change during decryption,
4778 * so re-read it. */
4779 ssl->in_msgtype = rec.type;
4780 /* Also update the input buffer, because unfortunately
4781 * the server-side ssl_parse_client_hello() reparses the
4782 * record header when receiving a ClientHello initiating
4783 * a renegotiation. */
4784 ssl->in_hdr[0] = rec.type;
4785 ssl->in_msg = rec.buf + rec.data_offset;
4786 ssl->in_msglen = rec.data_len;
Joe Subbianic54e9082021-07-19 11:56:54 +01004787 MBEDTLS_PUT_UINT16_BE( rec.data_len, ssl->in_len, 0 );
Hanno Becker8685c822019-07-12 09:37:30 +01004788
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004789#if defined(MBEDTLS_ZLIB_SUPPORT)
4790 if( ssl->transform_in != NULL &&
4791 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4792 {
4793 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4794 {
4795 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4796 return( ret );
4797 }
4798
4799 /* Check actual (decompress) record content length against
4800 * configured maximum. */
4801 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4802 {
4803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4804 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4805 }
4806 }
4807#endif /* MBEDTLS_ZLIB_SUPPORT */
4808
Simon Butcher99000142016-10-13 17:21:01 +01004809 return( 0 );
4810}
4811
4812int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4813{
Janos Follath865b3eb2019-12-16 11:46:15 +00004814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004815
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004816 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004817 * Handle particular types of records
4818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004820 {
Simon Butcher99000142016-10-13 17:21:01 +01004821 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4822 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004823 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004824 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004825 }
4826
Hanno Beckere678eaa2018-08-21 14:57:46 +01004827 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004828 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004829 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004830 {
Paul Elliottd48d5c62021-01-07 14:47:05 +00004831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
Hanno Beckere678eaa2018-08-21 14:57:46 +01004832 ssl->in_msglen ) );
4833 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004834 }
4835
Hanno Beckere678eaa2018-08-21 14:57:46 +01004836 if( ssl->in_msg[0] != 1 )
4837 {
4838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4839 ssl->in_msg[0] ) );
4840 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4841 }
4842
4843#if defined(MBEDTLS_SSL_PROTO_DTLS)
4844 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4845 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4846 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4847 {
4848 if( ssl->handshake == NULL )
4849 {
4850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4851 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4852 }
4853
4854 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4855 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4856 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004857#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004858 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004861 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004862 if( ssl->in_msglen != 2 )
4863 {
4864 /* Note: Standard allows for more than one 2 byte alert
4865 to be packed in a single message, but Mbed TLS doesn't
4866 currently support this. */
Paul Elliottd48d5c62021-01-07 14:47:05 +00004867 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004868 ssl->in_msglen ) );
4869 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4870 }
4871
Paul Elliott9f352112020-12-09 14:55:45 +00004872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%u:%u]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004873 ssl->in_msg[0], ssl->in_msg[1] ) );
4874
4875 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004876 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004878 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004881 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004882 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004883 }
4884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004885 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4886 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4889 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004890 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004891
4892#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4893 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4894 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4895 {
Hanno Becker90333da2017-10-10 11:27:13 +01004896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004897 /* Will be handled when trying to parse ServerHello */
4898 return( 0 );
4899 }
4900#endif
4901
4902#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4903 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4904 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4905 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4906 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4907 {
4908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4909 /* Will be handled in mbedtls_ssl_parse_certificate() */
4910 return( 0 );
4911 }
4912#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4913
4914 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004915 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004916 }
4917
Hanno Beckerc76c6192017-06-06 10:03:17 +01004918#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004919 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004920 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004921 /* Drop unexpected ApplicationData records,
4922 * except at the beginning of renegotiations */
4923 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4924 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4925#if defined(MBEDTLS_SSL_RENEGOTIATION)
4926 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4927 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004928#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004929 )
4930 {
4931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4932 return( MBEDTLS_ERR_SSL_NON_FATAL );
4933 }
4934
4935 if( ssl->handshake != NULL &&
4936 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4937 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004938 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004939 }
4940 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004941#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004942
Paul Bakker5121ce52009-01-03 21:22:43 +00004943 return( 0 );
4944}
4945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004946int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004947{
irwir6c0da642019-09-26 21:07:41 +03004948 return( mbedtls_ssl_send_alert_message( ssl,
4949 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4950 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004951}
4952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004954 unsigned char level,
4955 unsigned char message )
4956{
Janos Follath865b3eb2019-12-16 11:46:15 +00004957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004958
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004959 if( ssl == NULL || ssl->conf == NULL )
4960 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004963 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004965 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004966 ssl->out_msglen = 2;
4967 ssl->out_msg[0] = level;
4968 ssl->out_msg[1] = message;
4969
Hanno Becker67bc7c32018-08-06 11:33:50 +01004970 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004971 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004973 return( ret );
4974 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004976
4977 return( 0 );
4978}
4979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004980int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004981{
Janos Follath865b3eb2019-12-16 11:46:15 +00004982 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004984 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004987 ssl->out_msglen = 1;
4988 ssl->out_msg[0] = 1;
4989
Paul Bakker5121ce52009-01-03 21:22:43 +00004990 ssl->state++;
4991
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004992 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004993 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004994 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004995 return( ret );
4996 }
4997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004999
5000 return( 0 );
5001}
5002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005004{
Janos Follath865b3eb2019-12-16 11:46:15 +00005005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005008
Hanno Becker327c93b2018-08-15 13:56:18 +01005009 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005010 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005012 return( ret );
5013 }
5014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005016 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005018 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5019 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005020 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005021 }
5022
Hanno Beckere678eaa2018-08-21 14:57:46 +01005023 /* CCS records are only accepted if they have length 1 and content '1',
5024 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005025
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005026 /*
5027 * Switch to our negotiated transform and session parameters for inbound
5028 * data.
5029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005030 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005031 ssl->transform_in = ssl->transform_negotiate;
5032 ssl->session_in = ssl->session_negotiate;
5033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005035 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005036 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005037#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005038 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005039#endif
5040
5041 /* Increment epoch */
5042 if( ++ssl->in_epoch == 0 )
5043 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005045 /* This is highly unlikely to happen for legitimate reasons, so
5046 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005047 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005048 }
5049 }
5050 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005051#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005052 memset( ssl->in_ctr, 0, 8 );
5053
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005054 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005056#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5057 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005058 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005060 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005061 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005062 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5063 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005064 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005065 }
5066 }
5067#endif
5068
Paul Bakker5121ce52009-01-03 21:22:43 +00005069 ssl->state++;
5070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005072
5073 return( 0 );
5074}
5075
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005076/* Once ssl->out_hdr as the address of the beginning of the
5077 * next outgoing record is set, deduce the other pointers.
5078 *
5079 * Note: For TLS, we save the implicit record sequence number
5080 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5081 * and the caller has to make sure there's space for this.
5082 */
5083
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005084static size_t ssl_transform_get_explicit_iv_len(
5085 mbedtls_ssl_transform const *transform )
5086{
5087 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5088 return( 0 );
5089
5090 return( transform->ivlen - transform->fixed_ivlen );
5091}
5092
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005093void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5094 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005095{
5096#if defined(MBEDTLS_SSL_PROTO_DTLS)
5097 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5098 {
5099 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005100#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005101 ssl->out_cid = ssl->out_ctr + 8;
5102 ssl->out_len = ssl->out_cid;
5103 if( transform != NULL )
5104 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005105#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005106 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005107#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005108 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005109 }
5110 else
5111#endif
5112 {
5113 ssl->out_ctr = ssl->out_hdr - 8;
5114 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005115#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005116 ssl->out_cid = ssl->out_len;
5117#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005118 ssl->out_iv = ssl->out_hdr + 5;
5119 }
5120
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005121 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005122 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005123 if( transform != NULL )
5124 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005125}
5126
5127/* Once ssl->in_hdr as the address of the beginning of the
5128 * next incoming record is set, deduce the other pointers.
5129 *
5130 * Note: For TLS, we save the implicit record sequence number
5131 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5132 * and the caller has to make sure there's space for this.
5133 */
5134
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005135void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005136{
Hanno Becker79594fd2019-05-08 09:38:41 +01005137 /* This function sets the pointers to match the case
5138 * of unprotected TLS/DTLS records, with both ssl->in_iv
5139 * and ssl->in_msg pointing to the beginning of the record
5140 * content.
5141 *
5142 * When decrypting a protected record, ssl->in_msg
5143 * will be shifted to point to the beginning of the
5144 * record plaintext.
5145 */
5146
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005147#if defined(MBEDTLS_SSL_PROTO_DTLS)
5148 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5149 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005150 /* This sets the header pointers to match records
5151 * without CID. When we receive a record containing
5152 * a CID, the fields are shifted accordingly in
5153 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005154 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005155#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005156 ssl->in_cid = ssl->in_ctr + 8;
5157 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005158#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005159 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005160#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005161 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005162 }
5163 else
5164#endif
5165 {
5166 ssl->in_ctr = ssl->in_hdr - 8;
5167 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005168#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005169 ssl->in_cid = ssl->in_len;
5170#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005171 ssl->in_iv = ssl->in_hdr + 5;
5172 }
5173
Hanno Becker79594fd2019-05-08 09:38:41 +01005174 /* This will be adjusted at record decryption time. */
5175 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005176}
5177
Paul Bakker5121ce52009-01-03 21:22:43 +00005178/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005179 * Setup an SSL context
5180 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005181
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005182void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005183{
5184 /* Set the incoming and outgoing record pointers. */
5185#if defined(MBEDTLS_SSL_PROTO_DTLS)
5186 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5187 {
5188 ssl->out_hdr = ssl->out_buf;
5189 ssl->in_hdr = ssl->in_buf;
5190 }
5191 else
5192#endif /* MBEDTLS_SSL_PROTO_DTLS */
5193 {
5194 ssl->out_hdr = ssl->out_buf + 8;
5195 ssl->in_hdr = ssl->in_buf + 8;
5196 }
5197
5198 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005199 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5200 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005201}
5202
Paul Bakker5121ce52009-01-03 21:22:43 +00005203/*
5204 * SSL get accessors
5205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005207{
5208 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5209}
5210
Hanno Becker8b170a02017-10-10 11:51:19 +01005211int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5212{
5213 /*
5214 * Case A: We're currently holding back
5215 * a message for further processing.
5216 */
5217
5218 if( ssl->keep_current_message == 1 )
5219 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005220 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005221 return( 1 );
5222 }
5223
5224 /*
5225 * Case B: Further records are pending in the current datagram.
5226 */
5227
5228#if defined(MBEDTLS_SSL_PROTO_DTLS)
5229 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5230 ssl->in_left > ssl->next_record_offset )
5231 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005232 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005233 return( 1 );
5234 }
5235#endif /* MBEDTLS_SSL_PROTO_DTLS */
5236
5237 /*
5238 * Case C: A handshake message is being processed.
5239 */
5240
Hanno Becker8b170a02017-10-10 11:51:19 +01005241 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5242 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005243 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005244 return( 1 );
5245 }
5246
5247 /*
5248 * Case D: An application data message is being processed
5249 */
5250 if( ssl->in_offt != NULL )
5251 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005252 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005253 return( 1 );
5254 }
5255
5256 /*
5257 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005258 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005259 * we implement support for multiple alerts in single records.
5260 */
5261
5262 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5263 return( 0 );
5264}
5265
Paul Bakker43ca69c2011-01-15 17:35:19 +00005266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005268{
Hanno Becker3136ede2018-08-17 15:28:19 +01005269 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005270 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005271 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005272
Hanno Becker5903de42019-05-03 14:46:38 +01005273 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5274
Hanno Becker78640902018-08-13 16:35:15 +01005275 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005276 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005278#if defined(MBEDTLS_ZLIB_SUPPORT)
5279 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5280 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005281#endif
5282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005283 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005285 case MBEDTLS_MODE_GCM:
5286 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005287 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005289 transform_expansion = transform->minlen;
5290 break;
5291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005292 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005293
5294 block_size = mbedtls_cipher_get_block_size(
5295 &transform->cipher_ctx_enc );
5296
Hanno Becker3136ede2018-08-17 15:28:19 +01005297 /* Expansion due to the addition of the MAC. */
5298 transform_expansion += transform->maclen;
5299
5300 /* Expansion due to the addition of CBC padding;
5301 * Theoretically up to 256 bytes, but we never use
5302 * more than the block size of the underlying cipher. */
5303 transform_expansion += block_size;
5304
5305 /* For TLS 1.1 or higher, an explicit IV is added
5306 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005307#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5308 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005309 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005310#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005311
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005312 break;
5313
5314 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005315 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005316 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005317 }
5318
Hanno Beckera0e20d02019-05-15 14:03:01 +01005319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005320 if( transform->out_cid_len != 0 )
5321 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005322#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005323
Hanno Becker5903de42019-05-03 14:46:38 +01005324 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005325}
5326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005327#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005328/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005329 * Check record counters and renegotiate if they're above the limit.
5330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005332{
Hanno Beckerdd772292020-02-05 10:38:31 +00005333 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005334 int in_ctr_cmp;
5335 int out_ctr_cmp;
5336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5338 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005339 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005340 {
5341 return( 0 );
5342 }
5343
Andres AG2196c7f2016-12-15 17:01:16 +00005344 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5345 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005346 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005347 ssl->conf->renego_period + ep_len, 8 - ep_len );
5348
5349 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005350 {
5351 return( 0 );
5352 }
5353
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005354 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005356}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005358
5359/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005360 * Receive application data decrypted from the SSL layer
5361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005363{
Janos Follath865b3eb2019-12-16 11:46:15 +00005364 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005365 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005366
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005367 if( ssl == NULL || ssl->conf == NULL )
5368 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005373 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005374 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005375 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005376 return( ret );
5377
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005378 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005379 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005380 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005381 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005382 return( ret );
5383 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005384 }
5385#endif
5386
Hanno Becker4a810fb2017-05-24 16:27:30 +01005387 /*
5388 * Check if renegotiation is necessary and/or handshake is
5389 * in process. If yes, perform/continue, and fall through
5390 * if an unexpected packet is received while the client
5391 * is waiting for the ServerHello.
5392 *
5393 * (There is no equivalent to the last condition on
5394 * the server-side as it is not treated as within
5395 * a handshake while waiting for the ClientHello
5396 * after a renegotiation request.)
5397 */
5398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005400 ret = ssl_check_ctr_renegotiate( ssl );
5401 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5402 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005403 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005404 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005405 return( ret );
5406 }
5407#endif
5408
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005409 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005410 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005412 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5413 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005414 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005415 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005416 return( ret );
5417 }
5418 }
5419
Hanno Beckere41158b2017-10-23 13:30:32 +01005420 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005421 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005422 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005423 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005424 if( ssl->f_get_timer != NULL &&
5425 ssl->f_get_timer( ssl->p_timer ) == -1 )
5426 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005427 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005428 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005429
Hanno Becker327c93b2018-08-15 13:56:18 +01005430 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005431 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005432 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5433 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005434
Hanno Becker4a810fb2017-05-24 16:27:30 +01005435 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5436 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005437 }
5438
5439 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005441 {
5442 /*
5443 * OpenSSL sends empty messages to randomize the IV
5444 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005445 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005448 return( 0 );
5449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005450 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005451 return( ret );
5452 }
5453 }
5454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005458
Hanno Becker4a810fb2017-05-24 16:27:30 +01005459 /*
5460 * - For client-side, expect SERVER_HELLO_REQUEST.
5461 * - For server-side, expect CLIENT_HELLO.
5462 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5463 */
5464
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005466 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005468 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005471
5472 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005474 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005475 {
5476 continue;
5477 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005478#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005480 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005481#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005482
Hanno Becker4a810fb2017-05-24 16:27:30 +01005483#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005484 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005485 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005486 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005487 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005488
5489 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005490#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005491 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005492 {
5493 continue;
5494 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005495#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005497 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005498#endif /* MBEDTLS_SSL_SRV_C */
5499
Hanno Becker21df7f92017-10-17 11:03:26 +01005500#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005501 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005502 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5503 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5504 ssl->conf->allow_legacy_renegotiation ==
5505 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5506 {
5507 /*
5508 * Accept renegotiation request
5509 */
Paul Bakker48916f92012-09-16 19:57:18 +00005510
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005511 /* DTLS clients need to know renego is server-initiated */
5512#if defined(MBEDTLS_SSL_PROTO_DTLS)
5513 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5514 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5515 {
5516 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5517 }
5518#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005519 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005520 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5521 ret != 0 )
5522 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005523 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5524 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005525 return( ret );
5526 }
5527 }
5528 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005529#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005530 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005531 /*
5532 * Refuse renegotiation
5533 */
5534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537#if defined(MBEDTLS_SSL_PROTO_SSL3)
5538 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005539 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005540 /* SSLv3 does not have a "no_renegotiation" warning, so
5541 we send a fatal alert and abort the connection. */
5542 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5543 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5544 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005545 }
5546 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5548#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5549 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5550 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005552 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5553 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5554 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005555 {
5556 return( ret );
5557 }
Paul Bakker48916f92012-09-16 19:57:18 +00005558 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005559 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005560#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5561 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5564 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005565 }
Paul Bakker48916f92012-09-16 19:57:18 +00005566 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005567
Hanno Becker90333da2017-10-10 11:27:13 +01005568 /* At this point, we don't know whether the renegotiation has been
5569 * completed or not. The cases to consider are the following:
5570 * 1) The renegotiation is complete. In this case, no new record
5571 * has been read yet.
5572 * 2) The renegotiation is incomplete because the client received
5573 * an application data record while awaiting the ServerHello.
5574 * 3) The renegotiation is incomplete because the client received
5575 * a non-handshake, non-application data message while awaiting
5576 * the ServerHello.
5577 * In each of these case, looping will be the proper action:
5578 * - For 1), the next iteration will read a new record and check
5579 * if it's application data.
5580 * - For 2), the loop condition isn't satisfied as application data
5581 * is present, hence continue is the same as break
5582 * - For 3), the loop condition is satisfied and read_record
5583 * will re-deliver the message that was held back by the client
5584 * when expecting the ServerHello.
5585 */
5586 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005587 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005588#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005589 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005590 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005591 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005592 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005593 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005596 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005598 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005599 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005600 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005601#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005603 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5604 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005605 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005607 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005608 }
5609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005610 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5613 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005614 }
5615
5616 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005617
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005618 /* We're going to return something now, cancel timer,
5619 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005621 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005622
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005623#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005624 /* If we requested renego but received AppData, resend HelloRequest.
5625 * Do it now, after setting in_offt, to avoid taking this branch
5626 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005627#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005628 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005629 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005630 {
Hanno Becker786300f2020-02-05 10:46:40 +00005631 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005632 {
Hanno Becker786300f2020-02-05 10:46:40 +00005633 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5634 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005635 return( ret );
5636 }
5637 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005639#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005640 }
5641
5642 n = ( len < ssl->in_msglen )
5643 ? len : ssl->in_msglen;
5644
5645 memcpy( buf, ssl->in_offt, n );
5646 ssl->in_msglen -= n;
5647
gabor-mezei-arma3214132020-07-15 10:55:00 +02005648 /* Zeroising the plaintext buffer to erase unused application data
5649 from the memory. */
5650 mbedtls_platform_zeroize( ssl->in_offt, n );
5651
Paul Bakker5121ce52009-01-03 21:22:43 +00005652 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005653 {
5654 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005655 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005656 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005657 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005658 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005659 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005660 /* more data available */
5661 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005662 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005664 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005665
Paul Bakker23986e52011-04-24 08:57:21 +00005666 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005667}
5668
5669/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005670 * Send application data to be encrypted by the SSL layer, taking care of max
5671 * fragment length and buffer size.
5672 *
5673 * According to RFC 5246 Section 6.2.1:
5674 *
5675 * Zero-length fragments of Application data MAY be sent as they are
5676 * potentially useful as a traffic analysis countermeasure.
5677 *
5678 * Therefore, it is possible that the input message length is 0 and the
5679 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005680 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005681static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005682 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005683{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005684 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5685 const size_t max_len = (size_t) ret;
5686
5687 if( ret < 0 )
5688 {
5689 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5690 return( ret );
5691 }
5692
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005693 if( len > max_len )
5694 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005696 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005697 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Paul Elliottd48d5c62021-01-07 14:47:05 +00005699 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5700 " > %" MBEDTLS_PRINTF_SIZET,
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005701 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005703 }
5704 else
5705#endif
5706 len = max_len;
5707 }
Paul Bakker887bd502011-06-08 13:10:54 +00005708
Paul Bakker5121ce52009-01-03 21:22:43 +00005709 if( ssl->out_left != 0 )
5710 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005711 /*
5712 * The user has previously tried to send the data and
5713 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5714 * written. In this case, we expect the high-level write function
5715 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005718 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005720 return( ret );
5721 }
5722 }
Paul Bakker887bd502011-06-08 13:10:54 +00005723 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005724 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005725 /*
5726 * The user is trying to send a message the first time, so we need to
5727 * copy the data into the internal buffers and setup the data structure
5728 * to keep track of partial writes
5729 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005730 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005731 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005732 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005733
Hanno Becker67bc7c32018-08-06 11:33:50 +01005734 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005735 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005736 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005737 return( ret );
5738 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005739 }
5740
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005741 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005742}
5743
5744/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005745 * Write application data, doing 1/n-1 splitting if necessary.
5746 *
5747 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005748 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005749 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005752static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005753 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005754{
Janos Follath865b3eb2019-12-16 11:46:15 +00005755 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005756
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005757 if( ssl->conf->cbc_record_splitting ==
5758 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005759 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5761 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5762 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005763 {
5764 return( ssl_write_real( ssl, buf, len ) );
5765 }
5766
5767 if( ssl->split_done == 0 )
5768 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005769 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005770 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005771 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005772 }
5773
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005774 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5775 return( ret );
5776 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005777
5778 return( ret + 1 );
5779}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005781
5782/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005783 * Write application data (public-facing wrapper)
5784 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005785int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005786{
Janos Follath865b3eb2019-12-16 11:46:15 +00005787 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005788
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005790
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005791 if( ssl == NULL || ssl->conf == NULL )
5792 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5793
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005794#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005795 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5796 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005797 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005798 return( ret );
5799 }
5800#endif
5801
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005802 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005803 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005804 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005805 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005806 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005807 return( ret );
5808 }
5809 }
5810
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005811#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005812 ret = ssl_write_split( ssl, buf, len );
5813#else
5814 ret = ssl_write_real( ssl, buf, len );
5815#endif
5816
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005818
5819 return( ret );
5820}
5821
5822/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005823 * Notify the peer that the connection is being closed
5824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005825int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005826{
Janos Follath865b3eb2019-12-16 11:46:15 +00005827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005828
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005829 if( ssl == NULL || ssl->conf == NULL )
5830 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
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 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005835 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005837 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005838 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005839 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5840 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5841 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005842 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005843 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005844 return( ret );
5845 }
5846 }
5847
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005848 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005849
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005850 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005851}
5852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005853void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005854{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005855 if( transform == NULL )
5856 return;
5857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005858#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005859 deflateEnd( &transform->ctx_deflate );
5860 inflateEnd( &transform->ctx_inflate );
5861#endif
5862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005863 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5864 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005865
Hanno Beckerd56ed242018-01-03 15:32:51 +00005866#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005867 mbedtls_md_free( &transform->md_ctx_enc );
5868 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005869#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005870
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005871 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005872}
5873
Hanno Becker0271f962018-08-16 13:23:47 +01005874#if defined(MBEDTLS_SSL_PROTO_DTLS)
5875
Hanno Becker533ab5f2020-02-05 10:49:13 +00005876void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005877{
5878 unsigned offset;
5879 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5880
5881 if( hs == NULL )
5882 return;
5883
Hanno Becker283f5ef2018-08-24 09:34:47 +01005884 ssl_free_buffered_record( ssl );
5885
Hanno Becker0271f962018-08-16 13:23:47 +01005886 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005887 ssl_buffering_free_slot( ssl, offset );
5888}
5889
5890static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5891 uint8_t slot )
5892{
5893 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5894 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005895
5896 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5897 return;
5898
Hanno Beckere605b192018-08-21 15:59:07 +01005899 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005900 {
Hanno Beckere605b192018-08-21 15:59:07 +01005901 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005902 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005903 mbedtls_free( hs_buf->data );
5904 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005905 }
5906}
5907
5908#endif /* MBEDTLS_SSL_PROTO_DTLS */
5909
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005910/*
5911 * Convert version numbers to/from wire format
5912 * and, for DTLS, to/from TLS equivalent.
5913 *
5914 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005915 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005916 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5917 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005919void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005920 unsigned char ver[2] )
5921{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005922#if defined(MBEDTLS_SSL_PROTO_DTLS)
5923 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005925 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005926 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5927
5928 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5929 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5930 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005931 else
5932#else
5933 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005934#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005935 {
5936 ver[0] = (unsigned char) major;
5937 ver[1] = (unsigned char) minor;
5938 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005939}
5940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005941void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005942 const unsigned char ver[2] )
5943{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005944#if defined(MBEDTLS_SSL_PROTO_DTLS)
5945 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005946 {
5947 *major = 255 - ver[0] + 2;
5948 *minor = 255 - ver[1] + 1;
5949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005950 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005951 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5952 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005953 else
5954#else
5955 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005956#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005957 {
5958 *major = ver[0];
5959 *minor = ver[1];
5960 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005961}
5962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005963#endif /* MBEDTLS_SSL_TLS_C */