blob: 597494ead92f5f0737088f026a2d0f3db90b9887 [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"
Paul Bakker0be444a2013-08-27 21:55:01 +020047
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020048#include "ssl_invasive.h"
49
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Hanno Beckercd9dcda2018-08-28 17:18:56 +010061static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010062
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063/*
64 * Start a timer.
65 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020066 */
Hanno Becker0f57a652020-02-05 10:37:26 +000067void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020069 if( ssl->f_set_timer == NULL )
70 return;
71
72 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
73 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020074}
75
76/*
77 * Return -1 is timer is expired, 0 if it isn't.
78 */
Hanno Becker7876d122020-02-05 10:39:31 +000079int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020080{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020081 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020082 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020083
84 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 {
86 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020087 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020088 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
90 return( 0 );
91}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020092
Hanno Beckercfe45792019-07-03 16:13:00 +010093#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010094static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t len,
97 mbedtls_record *rec );
98
Hanno Beckercfe45792019-07-03 16:13:00 +010099int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
100 unsigned char *buf,
101 size_t buflen )
102{
Hanno Becker54229812019-07-12 14:40:00 +0100103 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
105 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
106
107 /* We don't support record checking in TLS because
108 * (a) there doesn't seem to be a usecase for it, and
109 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
110 * and we'd need to backup the transform here.
111 */
112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
113 {
114 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
115 goto exit;
116 }
117#if defined(MBEDTLS_SSL_PROTO_DTLS)
118 else
119 {
irwir734f0cf2019-09-26 21:03:24 +0300120 mbedtls_record rec;
121
Hanno Becker54229812019-07-12 14:40:00 +0100122 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
123 if( ret != 0 )
124 {
125 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
126 goto exit;
127 }
128
129 if( ssl->transform_in != NULL )
130 {
131 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
132 if( ret != 0 )
133 {
134 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
135 goto exit;
136 }
137 }
138 }
139#endif /* MBEDTLS_SSL_PROTO_DTLS */
140
141exit:
142 /* On success, we have decrypted the buffer in-place, so make
143 * sure we don't leak any plaintext data. */
144 mbedtls_platform_zeroize( buf, buflen );
145
146 /* For the purpose of this API, treat messages with unexpected CID
147 * as well as such from future epochs as unexpected. */
148 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
149 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
150 {
151 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
152 }
153
154 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
155 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100156}
157#endif /* MBEDTLS_SSL_RECORD_CHECKING */
158
Hanno Becker67bc7c32018-08-06 11:33:50 +0100159#define SSL_DONT_FORCE_FLUSH 0
160#define SSL_FORCE_FLUSH 1
161
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100163
Hanno Beckerd5847772018-08-28 10:09:23 +0100164/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100165static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
166 uint8_t slot );
167static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
168static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
170static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100171static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
172 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100173static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100174
Hanno Becker11682cc2018-08-22 14:41:02 +0100175static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176{
Hanno Becker89490712020-02-05 10:50:12 +0000177 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000178#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
179 size_t out_buf_len = ssl->out_buf_len;
180#else
181 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
182#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183
Darryl Greenb33cc762019-11-28 14:29:44 +0000184 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186
Darryl Greenb33cc762019-11-28 14:29:44 +0000187 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188}
189
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
191{
Hanno Becker11682cc2018-08-22 14:41:02 +0100192 size_t const bytes_written = ssl->out_left;
193 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194
195 /* Double-check that the write-index hasn't gone
196 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100197 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198 {
199 /* Should never happen... */
200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
201 }
202
203 return( (int) ( mtu - bytes_written ) );
204}
205
206static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
207{
Janos Follath865b3eb2019-12-16 11:46:15 +0000208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400210 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211
212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400213 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100214
215 if( max_len > mfl )
216 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100217
218 /* By the standard (RFC 6066 Sect. 4), the MFL extension
219 * only limits the maximum record payload size, so in theory
220 * we would be allowed to pack multiple records of payload size
221 * MFL into a single datagram. However, this would mean that there's
222 * no way to explicitly communicate MTU restrictions to the peer.
223 *
224 * The following reduction of max_len makes sure that we never
225 * write datagrams larger than MFL + Record Expansion Overhead.
226 */
227 if( max_len <= ssl->out_left )
228 return( 0 );
229
230 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100231#endif
232
233 ret = ssl_get_remaining_space_in_datagram( ssl );
234 if( ret < 0 )
235 return( ret );
236 remaining = (size_t) ret;
237
238 ret = mbedtls_ssl_get_record_expansion( ssl );
239 if( ret < 0 )
240 return( ret );
241 expansion = (size_t) ret;
242
243 if( remaining <= expansion )
244 return( 0 );
245
246 remaining -= expansion;
247 if( remaining >= max_len )
248 remaining = max_len;
249
250 return( (int) remaining );
251}
252
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253/*
254 * Double the retransmit timeout value, within the allowed range,
255 * returning -1 if the maximum value has already been reached.
256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200258{
259 uint32_t new_timeout;
260
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200261 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200262 return( -1 );
263
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
265 * in the following way: after the initial transmission and a first
266 * retransmission, back off to a temporary estimated MTU of 508 bytes.
267 * This value is guaranteed to be deliverable (if not guaranteed to be
268 * delivered) of any compliant IPv4 (and IPv6) network, and should work
269 * on most non-IP stacks too. */
270 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400271 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200272 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
274 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200275
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 new_timeout = 2 * ssl->handshake->retransmit_timeout;
277
278 /* Avoid arithmetic overflow and range overflow */
279 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200280 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200282 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283 }
284
285 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200287 ssl->handshake->retransmit_timeout ) );
288
289 return( 0 );
290}
291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200293{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200294 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200296 ssl->handshake->retransmit_timeout ) );
297}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
301int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200302 const unsigned char *key_enc, const unsigned char *key_dec,
303 size_t keylen,
304 const unsigned char *iv_enc, const unsigned char *iv_dec,
305 size_t ivlen,
306 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200307 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
309int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
310int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
313#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000314
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100315/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000316 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200317 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000318
Hanno Beckerccc13d02020-05-04 12:30:04 +0100319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
320 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100321
322static size_t ssl_compute_padding_length( size_t len,
323 size_t granularity )
324{
325 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
326}
327
Hanno Becker581bc1b2020-05-04 12:20:03 +0100328/* This functions transforms a (D)TLS plaintext fragment and a record content
329 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
330 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
331 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100332 *
333 * struct {
334 * opaque content[DTLSPlaintext.length];
335 * ContentType real_type;
336 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100337 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338 *
339 * Input:
340 * - `content`: The beginning of the buffer holding the
341 * plaintext to be wrapped.
342 * - `*content_size`: The length of the plaintext in Bytes.
343 * - `max_len`: The number of Bytes available starting from
344 * `content`. This must be `>= *content_size`.
345 * - `rec_type`: The desired record content type.
346 *
347 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100348 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
349 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100350 *
351 * Returns:
352 * - `0` on success.
353 * - A negative error code if `max_len` didn't offer enough space
354 * for the expansion.
355 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100356static int ssl_build_inner_plaintext( unsigned char *content,
357 size_t *content_size,
358 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100359 uint8_t rec_type,
360 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361{
362 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363
364 /* Write real content type */
365 if( remaining == 0 )
366 return( -1 );
367 content[ len ] = rec_type;
368 len++;
369 remaining--;
370
371 if( remaining < pad )
372 return( -1 );
373 memset( content + len, 0, pad );
374 len += pad;
375 remaining -= pad;
376
377 *content_size = len;
378 return( 0 );
379}
380
Hanno Becker581bc1b2020-05-04 12:20:03 +0100381/* This function parses a (D)TLSInnerPlaintext structure.
382 * See ssl_build_inner_plaintext() for details. */
383static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384 size_t *content_size,
385 uint8_t *rec_type )
386{
387 size_t remaining = *content_size;
388
389 /* Determine length of padding by skipping zeroes from the back. */
390 do
391 {
392 if( remaining == 0 )
393 return( -1 );
394 remaining--;
395 } while( content[ remaining ] == 0 );
396
397 *content_size = remaining;
398 *rec_type = content[ remaining ];
399
400 return( 0 );
401}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100402#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
403 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100404
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100406 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000407static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 mbedtls_record *rec,
410 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000411{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100412 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 *
414 * additional_data = seq_num + TLSCompressed.type +
415 * TLSCompressed.version + TLSCompressed.length;
416 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100417 * For the CID extension, this is extended as follows
418 * (quoting draft-ietf-tls-dtls-connection-id-05,
419 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 *
421 * additional_data = seq_num + DTLSPlaintext.type +
422 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100423 * cid +
424 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100425 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426 *
427 * For TLS 1.3, the record sequence number is dropped from the AAD
428 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100429 */
430
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100431 unsigned char *cur = add_data;
432
433#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
434 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
435#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
436 {
437 ((void) minor_ver);
438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
457 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
458 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
459 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 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
465 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468
469 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000470}
471
Hanno Becker9d062f92020-02-07 10:26:36 +0000472#if defined(MBEDTLS_SSL_PROTO_SSL3)
473
474#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
475
476/*
477 * SSLv3.0 MAC functions
478 */
479static void ssl_mac( mbedtls_md_context_t *md_ctx,
480 const unsigned char *secret,
481 const unsigned char *buf, size_t len,
482 const unsigned char *ctr, int type,
483 unsigned char out[SSL3_MAC_MAX_BYTES] )
484{
485 unsigned char header[11];
486 unsigned char padding[48];
487 int padlen;
488 int md_size = mbedtls_md_get_size( md_ctx->md_info );
489 int md_type = mbedtls_md_get_type( md_ctx->md_info );
490
491 /* Only MD5 and SHA-1 supported */
492 if( md_type == MBEDTLS_MD_MD5 )
493 padlen = 48;
494 else
495 padlen = 40;
496
497 memcpy( header, ctr, 8 );
498 header[ 8] = (unsigned char) type;
499 header[ 9] = (unsigned char)( len >> 8 );
500 header[10] = (unsigned char)( len );
501
502 memset( padding, 0x36, padlen );
503 mbedtls_md_starts( md_ctx );
504 mbedtls_md_update( md_ctx, secret, md_size );
505 mbedtls_md_update( md_ctx, padding, padlen );
506 mbedtls_md_update( md_ctx, header, 11 );
507 mbedtls_md_update( md_ctx, buf, len );
508 mbedtls_md_finish( md_ctx, out );
509
510 memset( padding, 0x5C, padlen );
511 mbedtls_md_starts( md_ctx );
512 mbedtls_md_update( md_ctx, secret, md_size );
513 mbedtls_md_update( md_ctx, padding, padlen );
514 mbedtls_md_update( md_ctx, out, md_size );
515 mbedtls_md_finish( md_ctx, out );
516}
517#endif /* MBEDTLS_SSL_PROTO_SSL3 */
518
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#if defined(MBEDTLS_GCM_C) || \
520 defined(MBEDTLS_CCM_C) || \
521 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100522static int ssl_transform_aead_dynamic_iv_is_explicit(
523 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524{
Hanno Becker17263802020-05-28 07:05:48 +0100525 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100526}
527
Hanno Becker17263802020-05-28 07:05:48 +0100528/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
529 *
530 * Concretely, this occurs in two variants:
531 *
532 * a) Fixed and dynamic IV lengths add up to total IV length, giving
533 * IV = fixed_iv || dynamic_iv
534 *
Hanno Becker15952812020-06-04 13:31:46 +0100535 * This variant is used in TLS 1.2 when used with GCM or CCM.
536 *
Hanno Becker17263802020-05-28 07:05:48 +0100537 * b) Fixed IV lengths matches total IV length, giving
538 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100539 *
540 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
541 *
542 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100543 *
544 * This function has the precondition that
545 *
546 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
547 *
548 * which has to be ensured by the caller. If this precondition
549 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100550 */
551static void ssl_build_record_nonce( unsigned char *dst_iv,
552 size_t dst_iv_len,
553 unsigned char const *fixed_iv,
554 size_t fixed_iv_len,
555 unsigned char const *dynamic_iv,
556 size_t dynamic_iv_len )
557{
558 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100559
560 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100561 memset( dst_iv, 0, dst_iv_len );
562 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100563
Hanno Becker17263802020-05-28 07:05:48 +0100564 dst_iv += dst_iv_len - dynamic_iv_len;
565 for( i = 0; i < dynamic_iv_len; i++ )
566 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567}
Hanno Becker67a37db2020-05-28 16:27:07 +0100568#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100569
Hanno Beckera18d1322018-01-03 14:27:32 +0000570int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
571 mbedtls_ssl_transform *transform,
572 mbedtls_record *rec,
573 int (*f_rng)(void *, unsigned char *, size_t),
574 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000575{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100577 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000578 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100579 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100580 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 size_t post_avail;
582
583 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000584#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200585 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000586 ((void) ssl);
587#endif
588
589 /* The PRNG is used for dynamic IV generation that's used
590 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200591#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000592 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
593 ((void) f_rng);
594 ((void) p_rng);
595#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000598
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100600 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
603 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100604 if( rec == NULL
605 || rec->buf == NULL
606 || rec->buf_len < rec->data_offset
607 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100608#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100609 || rec->cid_len != 0
610#endif
611 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000612 {
613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100615 }
616
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000617 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100618 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000620 data, rec->data_len );
621
622 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
623
624 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
625 {
626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
627 (unsigned) rec->data_len,
628 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
630 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100631
Hanno Becker92313402020-05-20 13:58:58 +0100632 /* The following two code paths implement the (D)TLSInnerPlaintext
633 * structure present in TLS 1.3 and DTLS 1.2 + CID.
634 *
635 * See ssl_build_inner_plaintext() for more information.
636 *
637 * Note that this changes `rec->data_len`, and hence
638 * `post_avail` needs to be recalculated afterwards.
639 *
640 * Note also that the two code paths cannot occur simultaneously
641 * since they apply to different versions of the protocol. There
642 * is hence no risk of double-addition of the inner plaintext.
643 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100644#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
645 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
646 {
Hanno Becker13996922020-05-28 16:15:19 +0100647 size_t padding =
648 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100649 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100650 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100651 &rec->data_len,
652 post_avail,
653 rec->type,
654 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100655 {
656 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
657 }
658
659 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
660 }
661#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
662
Hanno Beckera0e20d02019-05-15 14:03:01 +0100663#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100664 /*
665 * Add CID information
666 */
667 rec->cid_len = transform->out_cid_len;
668 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
669 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100670
671 if( rec->cid_len != 0 )
672 {
Hanno Becker13996922020-05-28 16:15:19 +0100673 size_t padding =
674 ssl_compute_padding_length( rec->data_len,
675 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100676 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100677 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100678 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100679 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100680 * Note that this changes `rec->data_len`, and hence
681 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100682 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100683 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100684 &rec->data_len,
685 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100686 rec->type,
687 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100688 {
689 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
690 }
691
692 rec->type = MBEDTLS_SSL_MSG_CID;
693 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100694#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100695
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100696 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
697
Paul Bakker5121ce52009-01-03 21:22:43 +0000698 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100699 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000700 */
Hanno Becker52344c22018-01-03 15:24:20 +0000701#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 if( mode == MBEDTLS_MODE_STREAM ||
703 ( mode == MBEDTLS_MODE_CBC
704#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000705 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100706#endif
707 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000708 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000709 if( post_avail < transform->maclen )
710 {
711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
712 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
713 }
714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200717 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000718 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
720 data, rec->data_len, rec->ctr, rec->type, mac );
721 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722 }
723 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200724#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
726 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000727 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200728 {
Hanno Becker992b6872017-11-09 18:57:39 +0000729 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
730
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100731 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
732 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000733
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000734 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100735 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000736 mbedtls_md_hmac_update( &transform->md_ctx_enc,
737 data, rec->data_len );
738 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
739 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
740
741 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200742 }
743 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200744#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
747 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200748 }
749
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000750 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
751 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200752
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 rec->data_len += transform->maclen;
754 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100755 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200756 }
Hanno Becker52344c22018-01-03 15:24:20 +0000757#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000758
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200759 /*
760 * Encrypt
761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
763 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000764 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000766 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 "including %d bytes of padding",
769 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000770
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000771 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
772 transform->iv_enc, transform->ivlen,
773 data, rec->data_len,
774 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200777 return( ret );
778 }
779
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
783 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200784 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000785 }
Paul Bakker68884e32013-01-07 18:20:04 +0100786 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000788
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200789#if defined(MBEDTLS_GCM_C) || \
790 defined(MBEDTLS_CCM_C) || \
791 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200793 mode == MBEDTLS_MODE_CCM ||
794 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000795 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000796 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200797 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100798 unsigned char *dynamic_iv;
799 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100800 int dynamic_iv_is_explicit =
801 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000802
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100803 /* Check that there's space for the authentication tag. */
804 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 {
806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
807 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
808 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000809
Paul Bakker68884e32013-01-07 18:20:04 +0100810 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100811 * Build nonce for AEAD encryption.
812 *
813 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
814 * part of the IV is prepended to the ciphertext and
815 * can be chosen freely - in particular, it need not
816 * agree with the record sequence number.
817 * However, since ChaChaPoly as well as all AEAD modes
818 * in TLS 1.3 use the record sequence number as the
819 * dynamic part of the nonce, we uniformly use the
820 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100821 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100822 dynamic_iv = rec->ctr;
823 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200824
Hanno Becker17263802020-05-28 07:05:48 +0100825 ssl_build_record_nonce( iv, sizeof( iv ),
826 transform->iv_enc,
827 transform->fixed_ivlen,
828 dynamic_iv,
829 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100830
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 /*
832 * Build additional data for AEAD encryption.
833 * This depends on the TLS version.
834 */
835 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
836 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100837
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200838 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100839 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200840 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100841 dynamic_iv,
842 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000843 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100844 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200846 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000848
Paul Bakker68884e32013-01-07 18:20:04 +0100849 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200850 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200851 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100853 if( ( ret = mbedtls_cipher_auth_encrypt_ext( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000854 iv, transform->ivlen,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100855 add_data, add_data_len,
856 data, rec->data_len, /* src */
857 data, rec->buf_len - (data - rec->buf), /* dst */
858 &rec->data_len,
859 transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200860 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200861 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200862 return( ret );
863 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +0100865 data + rec->data_len - transform->taglen,
866 transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100867 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000868 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100869
870 /*
871 * Prefix record content with dynamic IV in case it is explicit.
872 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100873 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100874 {
875 if( rec->data_offset < dynamic_iv_len )
876 {
877 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
878 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
879 }
880
881 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
882 rec->data_offset -= dynamic_iv_len;
883 rec->data_len += dynamic_iv_len;
884 }
885
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100886 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000887 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000888 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100889#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200890#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000892 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000893 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000894 size_t padlen, i;
895 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000896
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000897 /* Currently we're always using minimal padding
898 * (up to 255 bytes would be allowed). */
899 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
900 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000901 padlen = 0;
902
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000903 /* Check there's enough space in the buffer for the padding. */
904 if( post_avail < padlen + 1 )
905 {
906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
907 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
908 }
909
Paul Bakker5121ce52009-01-03 21:22:43 +0000910 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000912
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000913 rec->data_len += padlen + 1;
914 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000917 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000918 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
919 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000920 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000921 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000922 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000923 if( f_rng == NULL )
924 {
925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
927 }
928
929 if( rec->data_offset < transform->ivlen )
930 {
931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
932 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
933 }
934
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000935 /*
936 * Generate IV
937 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000939 if( ret != 0 )
940 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000941
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000942 memcpy( data - transform->ivlen, transform->iv_enc,
943 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000945 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000949 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000950 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200951 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000952
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
954 transform->iv_enc,
955 transform->ivlen,
956 data, rec->data_len,
957 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200958 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200960 return( ret );
961 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200967 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000970 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200971 {
972 /*
973 * Save IV in SSL3 and TLS1
974 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000975 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
976 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200979#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 {
981 data -= transform->ivlen;
982 rec->data_offset -= transform->ivlen;
983 rec->data_len += transform->ivlen;
984 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100987 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100988 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000989 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
990
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100991 /*
992 * MAC(MAC_write_key, seq_num +
993 * TLSCipherText.type +
994 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100995 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100996 * IV + // except for TLS 1.0
997 * ENC(content + padding + padding_length));
998 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999
1000 if( post_avail < transform->maclen)
1001 {
1002 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1003 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1004 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001005
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001006 ssl_extract_add_data_from_record( add_data, &add_data_len,
1007 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001010 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001011 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001012
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001013 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001014 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001015 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1016 data, rec->data_len );
1017 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1018 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001019
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001021
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 rec->data_len += transform->maclen;
1023 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001024 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001025 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001028 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001034
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001035 /* Make extra sure authentication was performed, exactly once */
1036 if( auth_done != 1 )
1037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001040 }
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001043
1044 return( 0 );
1045}
1046
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001048/*
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001049 * Turn a bit into a mask:
1050 * - if bit == 1, return the all-bits 1 mask, aka (size_t) -1
1051 * - if bit == 0, return the all-bits 0 mask, aka 0
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001052 *
1053 * This function can be used to write constant-time code by replacing branches
1054 * with bit operations using masks.
1055 *
1056 * This function is implemented without using comparison operators, as those
1057 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001058 */
1059static size_t mbedtls_ssl_cf_mask_from_bit( size_t bit )
1060{
1061 /* MSVC has a warning about unary minus on unsigned integer types,
1062 * but this is well-defined and precisely what we want to do here. */
1063#if defined(_MSC_VER)
1064#pragma warning( push )
1065#pragma warning( disable : 4146 )
1066#endif
1067 return -bit;
1068#if defined(_MSC_VER)
1069#pragma warning( pop )
1070#endif
1071}
1072
1073/*
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001074 * Constant-flow mask generation for "less than" comparison:
1075 * - if x < y, return all bits 1, that is (size_t) -1
1076 * - otherwise, return all bits 0, that is 0
1077 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001078 * This function can be used to write constant-time code by replacing branches
1079 * with bit operations using masks.
1080 *
1081 * This function is implemented without using comparison operators, as those
1082 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001083 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001084static size_t mbedtls_ssl_cf_mask_lt( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001085{
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001086 /* This has the most significant bit set if and only if x < y */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001087 const size_t sub = x - y;
1088
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001089 /* sub1 = (x < y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001090 const size_t sub1 = sub >> ( sizeof( sub ) * 8 - 1 );
1091
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001092 /* mask = (x < y) ? 0xff... : 0x00... */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001093 const size_t mask = mbedtls_ssl_cf_mask_from_bit( sub1 );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001094
1095 return( mask );
1096}
1097
1098/*
1099 * Constant-flow mask generation for "greater or equal" comparison:
1100 * - if x >= y, return all bits 1, that is (size_t) -1
1101 * - otherwise, return all bits 0, that is 0
1102 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001103 * This function can be used to write constant-time code by replacing branches
1104 * with bit operations using masks.
1105 *
1106 * This function is implemented without using comparison operators, as those
1107 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001108 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001109static size_t mbedtls_ssl_cf_mask_ge( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001110{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001111 return( ~mbedtls_ssl_cf_mask_lt( x, y ) );
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001112}
1113
1114/*
1115 * Constant-flow boolean "equal" comparison:
1116 * return x == y
1117 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001118 * This function can be used to write constant-time code by replacing branches
1119 * with bit operations - it can be used in conjunction with
1120 * mbedtls_ssl_cf_mask_from_bit().
1121 *
1122 * This function is implemented without using comparison operators, as those
1123 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001124 */
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001125static size_t mbedtls_ssl_cf_bool_eq( size_t x, size_t y )
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001126{
1127 /* diff = 0 if x == y, non-zero otherwise */
1128 const size_t diff = x ^ y;
1129
1130 /* MSVC has a warning about unary minus on unsigned integer types,
1131 * but this is well-defined and precisely what we want to do here. */
1132#if defined(_MSC_VER)
1133#pragma warning( push )
1134#pragma warning( disable : 4146 )
1135#endif
1136
1137 /* diff_msb's most significant bit is equal to x != y */
1138 const size_t diff_msb = ( diff | -diff );
1139
1140#if defined(_MSC_VER)
1141#pragma warning( pop )
1142#endif
1143
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001144 /* diff1 = (x != y) ? 1 : 0 */
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001145 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1146
1147 return( 1 ^ diff1 );
1148}
1149
1150/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001151 * Constant-flow conditional memcpy:
1152 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1153 * - otherwise, a no-op,
1154 * but with execution flow independent of the values of c1 and c2.
1155 *
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001156 * This function is implemented without using comparison operators, as those
1157 * might be translated to branches by some compilers on some platforms.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001158 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001159static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1160 const unsigned char *src,
1161 size_t len,
1162 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001163{
Manuel Pégourié-Gonnard6e2a9a72020-08-25 10:01:00 +02001164 /* mask = c1 == c2 ? 0xff : 0x00 */
1165 const size_t equal = mbedtls_ssl_cf_bool_eq( c1, c2 );
Manuel Pégourié-Gonnard2a59fb42020-08-25 11:51:46 +02001166 const unsigned char mask = (unsigned char) mbedtls_ssl_cf_mask_from_bit( equal );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001167
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001168 /* dst[i] = c1 == c2 ? src[i] : dst[i] */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001169 for( size_t i = 0; i < len; i++ )
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001170 dst[i] = ( src[i] & mask ) | ( dst[i] & ~mask );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001171}
1172
1173/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001174 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001175 *
1176 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1177 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001178 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001179MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001180 mbedtls_md_context_t *ctx,
1181 const unsigned char *add_data, size_t add_data_len,
1182 const unsigned char *data, size_t data_len_secret,
1183 size_t min_data_len, size_t max_data_len,
1184 unsigned char *output )
1185{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001186 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001187 * This function breaks the HMAC abstraction and uses the md_clone()
1188 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001189 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001190 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001191 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001192 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001193 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001194 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1195 * minlen, then cloning the context, and for each byte up to maxlen
1196 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001197 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001198 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001199 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001200 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001201 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1202 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001203 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001204 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001205 const unsigned char * const okey = ikey + block_size;
1206 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001207
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001208 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1209 mbedtls_md_context_t aux;
1210 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001212
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001213 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001214
1215#define MD_CHK( func_call ) \
1216 do { \
1217 ret = (func_call); \
1218 if( ret != 0 ) \
1219 goto cleanup; \
1220 } while( 0 )
1221
1222 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001223
1224 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1225 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001226 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1227 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001228
1229 /* For each possible length, compute the hash up to that point */
1230 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001231 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001232 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1233 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001234 /* Keep only the correct inner_hash in the output buffer */
1235 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1236 offset, data_len_secret );
1237
1238 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001239 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001240 }
1241
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001242 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001243 MD_CHK( mbedtls_md_starts( ctx ) );
1244 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1245 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1246 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001247
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001248 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001249 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001250
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001251#undef MD_CHK
1252
1253cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001254 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001255 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001256}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001257
1258/*
1259 * Constant-flow memcpy from variable position in buffer.
1260 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001261 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001262 */
1263MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1264 unsigned char *dst,
1265 const unsigned char *src_base,
1266 size_t offset_secret,
1267 size_t offset_min, size_t offset_max,
1268 size_t len )
1269{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001270 size_t offset;
1271
1272 for( offset = offset_min; offset <= offset_max; offset++ )
1273 {
1274 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1275 offset, offset_secret );
1276 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001277}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001278#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001279
Hanno Becker605949f2019-07-12 08:23:59 +01001280int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001281 mbedtls_ssl_transform *transform,
1282 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001283{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001284 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001286 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001287#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001288 size_t padlen = 0, correct = 1;
1289#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001290 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001291 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001292 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001293
Hanno Beckera18d1322018-01-03 14:27:32 +00001294#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001295 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001296 ((void) ssl);
1297#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001300 if( rec == NULL ||
1301 rec->buf == NULL ||
1302 rec->buf_len < rec->data_offset ||
1303 rec->buf_len - rec->data_offset < rec->data_len )
1304 {
1305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001307 }
1308
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309 data = rec->buf + rec->data_offset;
1310 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Hanno Beckera0e20d02019-05-15 14:03:01 +01001312#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001313 /*
1314 * Match record's CID with incoming CID.
1315 */
Hanno Becker938489a2019-05-08 13:02:22 +01001316 if( rec->cid_len != transform->in_cid_len ||
1317 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1318 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001319 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001320 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001321#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1324 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001325 {
1326 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1328 transform->iv_dec,
1329 transform->ivlen,
1330 data, rec->data_len,
1331 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001332 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001334 return( ret );
1335 }
1336
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001337 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1340 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001341 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001342 }
Paul Bakker68884e32013-01-07 18:20:04 +01001343 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001345#if defined(MBEDTLS_GCM_C) || \
1346 defined(MBEDTLS_CCM_C) || \
1347 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001349 mode == MBEDTLS_MODE_CCM ||
1350 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001351 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001352 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001353 unsigned char *dynamic_iv;
1354 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001355
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001356 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001357 * Extract dynamic part of nonce for AEAD decryption.
1358 *
1359 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1360 * part of the IV is prepended to the ciphertext and
1361 * can be chosen freely - in particular, it need not
1362 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001363 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001364 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001365 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001366 {
1367 if( rec->data_len < dynamic_iv_len )
1368 {
1369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1370 rec->data_len,
1371 dynamic_iv_len ) );
1372 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1373 }
1374 dynamic_iv = data;
1375
1376 data += dynamic_iv_len;
1377 rec->data_offset += dynamic_iv_len;
1378 rec->data_len -= dynamic_iv_len;
1379 }
Hanno Becker17263802020-05-28 07:05:48 +01001380 else
1381 {
1382 dynamic_iv = rec->ctr;
1383 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001384
1385 /* Check that there's space for the authentication tag. */
1386 if( rec->data_len < transform->taglen )
1387 {
1388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001390 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001391 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001392
Hanno Beckerdf8be222020-05-21 15:30:57 +01001393 /*
1394 * Prepare nonce from dynamic and static parts.
1395 */
Hanno Becker17263802020-05-28 07:05:48 +01001396 ssl_build_record_nonce( iv, sizeof( iv ),
1397 transform->iv_dec,
1398 transform->fixed_ivlen,
1399 dynamic_iv,
1400 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001401
Hanno Beckerdf8be222020-05-21 15:30:57 +01001402 /*
1403 * Build additional data for AEAD encryption.
1404 * This depends on the TLS version.
1405 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001406 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1407 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001408 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001409 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001410
Hanno Beckerd96a6522019-07-10 13:55:25 +01001411 /* Because of the check above, we know that there are
1412 * explicit_iv_len Bytes preceeding data, and taglen
1413 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001414 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001415 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001417 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001418 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001419 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001420
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001421 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001422 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001423 */
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001424 if( ( ret = mbedtls_cipher_auth_decrypt_ext( &transform->cipher_ctx_dec,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001425 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001426 add_data, add_data_len,
Manuel Pégourié-Gonnardf5cf71e2020-12-01 11:43:40 +01001427 data, rec->data_len + transform->taglen, /* src */
1428 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001429 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001430 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001433 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1434 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001435
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001436 return( ret );
1437 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001438 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001439
Hanno Beckerd96a6522019-07-10 13:55:25 +01001440 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001442 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001443 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1444 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001445 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001446 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001447 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001449#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001451 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001452 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001453
Paul Bakker5121ce52009-01-03 21:22:43 +00001454 /*
Paul Bakker45829992013-01-03 14:52:21 +01001455 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1459 {
1460 /* The ciphertext is prefixed with the CBC IV. */
1461 minlen += transform->ivlen;
1462 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001463#endif
Paul Bakker45829992013-01-03 14:52:21 +01001464
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001465 /* Size considerations:
1466 *
1467 * - The CBC cipher text must not be empty and hence
1468 * at least of size transform->ivlen.
1469 *
1470 * Together with the potential IV-prefix, this explains
1471 * the first of the two checks below.
1472 *
1473 * - The record must contain a MAC, either in plain or
1474 * encrypted, depending on whether Encrypt-then-MAC
1475 * is used or not.
1476 * - If it is, the message contains the IV-prefix,
1477 * the CBC ciphertext, and the MAC.
1478 * - If it is not, the padded plaintext, and hence
1479 * the CBC ciphertext, has at least length maclen + 1
1480 * because there is at least the padding length byte.
1481 *
1482 * As the CBC ciphertext is not empty, both cases give the
1483 * lower bound minlen + maclen + 1 on the record size, which
1484 * we test for in the second check below.
1485 */
1486 if( rec->data_len < minlen + transform->ivlen ||
1487 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001490 "+ 1 ) ( + expl IV )", rec->data_len,
1491 transform->ivlen,
1492 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001494 }
1495
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001496 /*
1497 * Authenticate before decrypt if enabled
1498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001501 {
Hanno Becker992b6872017-11-09 18:57:39 +00001502 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001505
Hanno Beckerd96a6522019-07-10 13:55:25 +01001506 /* Update data_len in tandem with add_data.
1507 *
1508 * The subtraction is safe because of the previous check
1509 * data_len >= minlen + maclen + 1.
1510 *
1511 * Afterwards, we know that data + data_len is followed by at
1512 * least maclen Bytes, which justifies the call to
1513 * mbedtls_ssl_safer_memcmp() below.
1514 *
1515 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001517 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1518 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001519
Hanno Beckerd96a6522019-07-10 13:55:25 +01001520 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001521 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1522 add_data_len );
1523 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1524 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001525 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1526 data, rec->data_len );
1527 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1528 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001529
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001530 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1531 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001532 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001533 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001534
Hanno Beckerd96a6522019-07-10 13:55:25 +01001535 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001536 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1537 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001538 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001541 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001542 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001543 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001545
1546 /*
1547 * Check length sanity
1548 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001549
1550 /* We know from above that data_len > minlen >= 0,
1551 * so the following check in particular implies that
1552 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001553 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001554 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001558 }
1559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001561 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001562 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001563 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001565 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001566 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001568
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001569 data += transform->ivlen;
1570 rec->data_offset += transform->ivlen;
1571 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001572 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001574
Hanno Beckerd96a6522019-07-10 13:55:25 +01001575 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1576
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001577 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1578 transform->iv_dec, transform->ivlen,
1579 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001582 return( ret );
1583 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001584
Hanno Beckerd96a6522019-07-10 13:55:25 +01001585 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1589 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001590 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001594 {
1595 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001596 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1597 * records is equivalent to CBC decryption of the concatenation
1598 * of the records; in other words, IVs are maintained across
1599 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001600 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001601 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1602 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001603 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001604#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001605
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001606 /* Safe since data_len >= minlen + maclen + 1, so after having
1607 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001608 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1609 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001610 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001611
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612 if( auth_done == 1 )
1613 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001614 const size_t mask = mbedtls_ssl_cf_mask_ge(
1615 rec->data_len,
1616 padlen + 1 );
1617 correct &= mask;
1618 padlen &= mask;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001619 }
1620 else
Paul Bakker45829992013-01-03 14:52:21 +01001621 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001623 if( rec->data_len < transform->maclen + padlen + 1 )
1624 {
1625 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1626 rec->data_len,
1627 transform->maclen,
1628 padlen + 1 ) );
1629 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001630#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001631
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001632 const size_t mask = mbedtls_ssl_cf_mask_ge(
1633 rec->data_len,
1634 transform->maclen + padlen + 1 );
1635 correct &= mask;
1636 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001637 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001638
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001639 padlen++;
1640
1641 /* Regardless of the validity of the padding,
1642 * we have data_len >= padlen here. */
1643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001645 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001646 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001647 /* This is the SSL 3.0 path, we don't have to worry about Lucky
1648 * 13, because there's a strictly worse padding attack built in
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001649 * the protocol (known as part of POODLE), so we don't care if the
1650 * code is not constant-time, in particular branches are OK. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001651 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_SSL_DEBUG_ALL)
1654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001655 "should be no more than %d",
1656 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001657#endif
Paul Bakker45829992013-01-03 14:52:21 +01001658 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001659 }
1660 }
1661 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1663#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1664 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001665 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001666 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001667 /* The padding check involves a series of up to 256
1668 * consecutive memory reads at the end of the record
1669 * plaintext buffer. In order to hide the length and
1670 * validity of the padding, always perform exactly
1671 * `min(256,plaintext_len)` reads (but take into account
1672 * only the last `padlen` bytes for the padding check). */
1673 size_t pad_count = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001675
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001676 /* Index of first padding byte; it has been ensured above
1677 * that the subtraction is safe. */
1678 size_t const padding_idx = rec->data_len - padlen;
1679 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1680 size_t const start_idx = rec->data_len - num_checks;
1681 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001682
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001683 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001684 {
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001685 /* pad_count += (idx >= padding_idx) &&
Manuel Pégourié-Gonnard6d6f8a42020-09-25 09:56:53 +02001686 * (check[idx] == padlen - 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001687 */
1688 const size_t mask = mbedtls_ssl_cf_mask_ge( idx, padding_idx );
1689 const size_t equal = mbedtls_ssl_cf_bool_eq( check[idx],
1690 padlen - 1 );
1691 pad_count += mask & equal;
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001692 }
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001693 correct &= mbedtls_ssl_cf_bool_eq( pad_count, padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001695#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001696 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001698#endif
Manuel Pégourié-Gonnard822b3722020-09-18 09:54:01 +02001699 padlen &= mbedtls_ssl_cf_mask_from_bit( correct );
Paul Bakker5121ce52009-01-03 21:22:43 +00001700 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001701 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1703 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001707 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001708
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001709 /* If the padding was found to be invalid, padlen == 0
1710 * and the subtraction is safe. If the padding was found valid,
1711 * padlen hasn't been changed and the previous assertion
1712 * data_len >= padlen still holds. */
1713 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001714 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001715 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001716#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001717 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1719 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001720 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001722#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001724 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001725#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
1727 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001728 * Authenticate if not done yet.
1729 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001730 */
Hanno Becker52344c22018-01-03 15:24:20 +00001731#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001732 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001733 {
Hanno Becker992b6872017-11-09 18:57:39 +00001734 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001735 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001736
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001737 /* If the initial value of padlen was such that
1738 * data_len < maclen + padlen + 1, then padlen
1739 * got reset to 1, and the initial check
1740 * data_len >= minlen + maclen + 1
1741 * guarantees that at this point we still
1742 * have at least data_len >= maclen.
1743 *
1744 * If the initial value of padlen was such that
1745 * data_len >= maclen + padlen + 1, then we have
1746 * subtracted either padlen + 1 (if the padding was correct)
1747 * or 0 (if the padding was incorrect) since then,
1748 * hence data_len >= maclen in any case.
1749 */
1750 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001751 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1752 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001755 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001756 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001757 ssl_mac( &transform->md_ctx_dec,
1758 transform->mac_dec,
1759 data, rec->data_len,
1760 rec->ctr, rec->type,
1761 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001762 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001763 }
1764 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1766#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1767 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001768 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001769 {
1770 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001771 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001772 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001773 *
1774 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001775 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001776 *
1777 * Note that max_len + maclen is never more than the buffer
1778 * length, as we previously did in_msglen -= maclen too.
1779 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001780 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001781 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1782
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001783 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1784 add_data, add_data_len,
1785 data, rec->data_len, min_len, max_len,
1786 mac_expect );
1787 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001788 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001789 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1790 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001791 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001792
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001793 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1794 rec->data_len,
1795 min_len, max_len,
1796 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001797 }
1798 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1800 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001801 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1803 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001804 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001805
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001806#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001807 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001808 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001809#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001810
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001811 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001812 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001813 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814#if defined(MBEDTLS_SSL_DEBUG_ALL)
1815 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001816#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001817 correct = 0;
1818 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001819 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001820 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001821
1822 /*
1823 * Finally check the correct flag
1824 */
1825 if( correct == 0 )
1826 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001827#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001828
1829 /* Make extra sure authentication was performed, exactly once */
1830 if( auth_done != 1 )
1831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1833 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001834 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001835
Hanno Beckerccc13d02020-05-04 12:30:04 +01001836#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1837 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1838 {
1839 /* Remove inner padding and infer true content type. */
1840 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1841 &rec->type );
1842
1843 if( ret != 0 )
1844 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1845 }
1846#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1847
Hanno Beckera0e20d02019-05-15 14:03:01 +01001848#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001849 if( rec->cid_len != 0 )
1850 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001851 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1852 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001853 if( ret != 0 )
1854 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1855 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001856#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001859
1860 return( 0 );
1861}
1862
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001863#undef MAC_NONE
1864#undef MAC_PLAINTEXT
1865#undef MAC_CIPHERTEXT
1866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001868/*
1869 * Compression/decompression functions
1870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001872{
Janos Follath865b3eb2019-12-16 11:46:15 +00001873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001875 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001876 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001877 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001878#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1879 size_t out_buf_len = ssl->out_buf_len;
1880#else
1881 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1882#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001885
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001886 if( len_pre == 0 )
1887 return( 0 );
1888
Paul Bakker2770fbd2012-07-03 13:30:23 +00001889 memcpy( msg_pre, ssl->out_msg, len_pre );
1890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001892 ssl->out_msglen ) );
1893
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001895 ssl->out_msg, ssl->out_msglen );
1896
Paul Bakker48916f92012-09-16 19:57:18 +00001897 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1898 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1899 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001900 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001901
Paul Bakker48916f92012-09-16 19:57:18 +00001902 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001903 if( ret != Z_OK )
1904 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1906 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001907 }
1908
Darryl Greenb33cc762019-11-28 14:29:44 +00001909 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001910 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001913 ssl->out_msglen ) );
1914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001916 ssl->out_msg, ssl->out_msglen );
1917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001919
1920 return( 0 );
1921}
1922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001924{
Janos Follath865b3eb2019-12-16 11:46:15 +00001925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001926 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001927 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001928 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001929 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001930#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1931 size_t in_buf_len = ssl->in_buf_len;
1932#else
1933 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1934#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001935
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001937
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001938 if( len_pre == 0 )
1939 return( 0 );
1940
Paul Bakker2770fbd2012-07-03 13:30:23 +00001941 memcpy( msg_pre, ssl->in_msg, len_pre );
1942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001944 ssl->in_msglen ) );
1945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001947 ssl->in_msg, ssl->in_msglen );
1948
Paul Bakker48916f92012-09-16 19:57:18 +00001949 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1950 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1951 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001952 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001953
Paul Bakker48916f92012-09-16 19:57:18 +00001954 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001955 if( ret != Z_OK )
1956 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1958 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001959 }
1960
Darryl Greenb33cc762019-11-28 14:29:44 +00001961 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001962 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001965 ssl->in_msglen ) );
1966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001968 ssl->in_msg, ssl->in_msglen );
1969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001971
1972 return( 0 );
1973}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001975
Paul Bakker5121ce52009-01-03 21:22:43 +00001976/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001977 * Fill the input message buffer by appending data to it.
1978 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001979 *
1980 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1981 * available (from this read and/or a previous one). Otherwise, an error code
1982 * is returned (possibly EOF or WANT_READ).
1983 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001984 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1985 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1986 * since we always read a whole datagram at once.
1987 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001988 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001989 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001992{
Janos Follath865b3eb2019-12-16 11:46:15 +00001993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001994 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1996 size_t in_buf_len = ssl->in_buf_len;
1997#else
1998 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1999#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002002
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002003 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
2004 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002006 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002008 }
2009
Darryl Greenb33cc762019-11-28 14:29:44 +00002010 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002011 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
2013 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002014 }
2015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002017 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00002018 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002019 uint32_t timeout;
2020
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002021 /*
2022 * The point is, we need to always read a full datagram at once, so we
2023 * sometimes read more then requested, and handle the additional data.
2024 * It could be the rest of the current record (while fetching the
2025 * header) and/or some other records in the same datagram.
2026 */
2027
2028 /*
2029 * Move to the next record in the already read datagram if applicable
2030 */
2031 if( ssl->next_record_offset != 0 )
2032 {
2033 if( ssl->in_left < ssl->next_record_offset )
2034 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2036 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002037 }
2038
2039 ssl->in_left -= ssl->next_record_offset;
2040
2041 if( ssl->in_left != 0 )
2042 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002044 ssl->next_record_offset ) );
2045 memmove( ssl->in_hdr,
2046 ssl->in_hdr + ssl->next_record_offset,
2047 ssl->in_left );
2048 }
2049
2050 ssl->next_record_offset = 0;
2051 }
2052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00002054 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
2056 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002057 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002058 */
2059 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002060 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002062 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002063 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002064
2065 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002066 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002067 * are not at the beginning of a new record, the caller did something
2068 * wrong.
2069 */
2070 if( ssl->in_left != 0 )
2071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2073 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002074 }
2075
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002076 /*
2077 * Don't even try to read if time's out already.
2078 * This avoids by-passing the timer when repeatedly receiving messages
2079 * that will end up being dropped.
2080 */
Hanno Becker7876d122020-02-05 10:39:31 +00002081 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01002082 {
2083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002084 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01002085 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002086 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002087 {
Darryl Greenb33cc762019-11-28 14:29:44 +00002088 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002091 timeout = ssl->handshake->retransmit_timeout;
2092 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002093 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002094
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002096
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002097 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002098 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2099 timeout );
2100 else
2101 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002104
2105 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002106 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002107 }
2108
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002109 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002110 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002112 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002115 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002116 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2117 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002119 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002120 }
2121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002123 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002125 return( ret );
2126 }
2127
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002128 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002129 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002131 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002133 {
Hanno Becker786300f2020-02-05 10:46:40 +00002134 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002135 {
Hanno Becker786300f2020-02-05 10:46:40 +00002136 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2137 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002138 return( ret );
2139 }
2140
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002141 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002142 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002144 }
2145
Paul Bakker5121ce52009-01-03 21:22:43 +00002146 if( ret < 0 )
2147 return( ret );
2148
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002149 ssl->in_left = ret;
2150 }
2151 else
2152#endif
2153 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002155 ssl->in_left, nb_want ) );
2156
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002157 while( ssl->in_left < nb_want )
2158 {
2159 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002160
Hanno Becker7876d122020-02-05 10:39:31 +00002161 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002162 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2163 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002164 {
2165 if( ssl->f_recv_timeout != NULL )
2166 {
2167 ret = ssl->f_recv_timeout( ssl->p_bio,
2168 ssl->in_hdr + ssl->in_left, len,
2169 ssl->conf->read_timeout );
2170 }
2171 else
2172 {
2173 ret = ssl->f_recv( ssl->p_bio,
2174 ssl->in_hdr + ssl->in_left, len );
2175 }
2176 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002179 ssl->in_left, nb_want ) );
2180 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002181
2182 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002184
2185 if( ret < 0 )
2186 return( ret );
2187
makise-homuraaf9513b2020-08-24 18:26:27 +03002188 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002189 {
Darryl Green11999bb2018-03-13 15:22:58 +00002190 MBEDTLS_SSL_DEBUG_MSG( 1,
2191 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002192 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002193 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2194 }
2195
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002196 ssl->in_left += ret;
2197 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002198 }
2199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002201
2202 return( 0 );
2203}
2204
2205/*
2206 * Flush any data not yet written
2207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002209{
Janos Follath865b3eb2019-12-16 11:46:15 +00002210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002211 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002214
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002215 if( ssl->f_send == NULL )
2216 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002218 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002220 }
2221
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002222 /* Avoid incrementing counter if data is flushed */
2223 if( ssl->out_left == 0 )
2224 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002226 return( 0 );
2227 }
2228
Paul Bakker5121ce52009-01-03 21:22:43 +00002229 while( ssl->out_left > 0 )
2230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002232 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002233
Hanno Becker2b1e3542018-08-06 11:19:13 +01002234 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002235 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002238
2239 if( ret <= 0 )
2240 return( ret );
2241
makise-homuraaf9513b2020-08-24 18:26:27 +03002242 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002243 {
Darryl Green11999bb2018-03-13 15:22:58 +00002244 MBEDTLS_SSL_DEBUG_MSG( 1,
2245 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002246 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002247 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2248 }
2249
Paul Bakker5121ce52009-01-03 21:22:43 +00002250 ssl->out_left -= ret;
2251 }
2252
Hanno Becker2b1e3542018-08-06 11:19:13 +01002253#if defined(MBEDTLS_SSL_PROTO_DTLS)
2254 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002255 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002256 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002257 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002258 else
2259#endif
2260 {
2261 ssl->out_hdr = ssl->out_buf + 8;
2262 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002263 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002266
2267 return( 0 );
2268}
2269
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002270/*
2271 * Functions to handle the DTLS retransmission state machine
2272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002274/*
2275 * Append current handshake message to current outgoing flight
2276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002278{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002280 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2281 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2282 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283
2284 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002285 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002286 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002289 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002290 }
2291
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002292 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002293 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002296 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002297 }
2298
2299 /* Copy current handshake message with headers */
2300 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2301 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002302 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002303 msg->next = NULL;
2304
2305 /* Append to the current flight */
2306 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002307 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002308 else
2309 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002311 while( cur->next != NULL )
2312 cur = cur->next;
2313 cur->next = msg;
2314 }
2315
Hanno Becker3b235902018-08-06 09:54:53 +01002316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002317 return( 0 );
2318}
2319
2320/*
2321 * Free the current flight of handshake messages
2322 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002323void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002324{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325 mbedtls_ssl_flight_item *cur = flight;
2326 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002327
2328 while( cur != NULL )
2329 {
2330 next = cur->next;
2331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 mbedtls_free( cur->p );
2333 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002334
2335 cur = next;
2336 }
2337}
2338
2339/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002340 * Swap transform_out and out_ctr with the alternative ones
2341 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002342static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002343{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002345 unsigned char tmp_out_ctr[8];
2346
2347 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002350 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002351 }
2352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002354
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002355 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002356 tmp_transform = ssl->transform_out;
2357 ssl->transform_out = ssl->handshake->alt_transform_out;
2358 ssl->handshake->alt_transform_out = tmp_transform;
2359
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002360 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002361 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2362 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002363 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002364
2365 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002366 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2369 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002370 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002371 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2372 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002373 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2375 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002376 }
2377 }
2378#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002379
2380 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002381}
2382
2383/*
2384 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002385 */
2386int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2387{
2388 int ret = 0;
2389
2390 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2391
2392 ret = mbedtls_ssl_flight_transmit( ssl );
2393
2394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2395
2396 return( ret );
2397}
2398
2399/*
2400 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002401 *
2402 * Need to remember the current message in case flush_output returns
2403 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002404 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002405 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002406int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002407{
Janos Follath865b3eb2019-12-16 11:46:15 +00002408 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002409 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002412 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002413 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002414
2415 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002416 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002417 ret = ssl_swap_epochs( ssl );
2418 if( ret != 0 )
2419 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423
2424 while( ssl->handshake->cur_msg != NULL )
2425 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002426 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002427 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002428
Hanno Beckere1dcb032018-08-17 16:47:58 +01002429 int const is_finished =
2430 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2431 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2432
Hanno Becker04da1892018-08-14 13:22:10 +01002433 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2434 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2435
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002436 /* Swap epochs before sending Finished: we can't do it after
2437 * sending ChangeCipherSpec, in case write returns WANT_READ.
2438 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002439 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002440 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002441 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002442 ret = ssl_swap_epochs( ssl );
2443 if( ret != 0 )
2444 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002445 }
2446
Hanno Becker67bc7c32018-08-06 11:33:50 +01002447 ret = ssl_get_remaining_payload_in_datagram( ssl );
2448 if( ret < 0 )
2449 return( ret );
2450 max_frag_len = (size_t) ret;
2451
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002452 /* CCS is copied as is, while HS messages may need fragmentation */
2453 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2454 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002455 if( max_frag_len == 0 )
2456 {
2457 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2458 return( ret );
2459
2460 continue;
2461 }
2462
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002463 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002464 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002465 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002467 /* Update position inside current message */
2468 ssl->handshake->cur_msg_p += cur->len;
2469 }
2470 else
2471 {
2472 const unsigned char * const p = ssl->handshake->cur_msg_p;
2473 const size_t hs_len = cur->len - 12;
2474 const size_t frag_off = p - ( cur->p + 12 );
2475 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002476 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002477
Hanno Beckere1dcb032018-08-17 16:47:58 +01002478 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002479 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002480 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002481 {
2482 ret = ssl_swap_epochs( ssl );
2483 if( ret != 0 )
2484 return( ret );
2485 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486
Hanno Becker67bc7c32018-08-06 11:33:50 +01002487 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2488 return( ret );
2489
2490 continue;
2491 }
2492 max_hs_frag_len = max_frag_len - 12;
2493
2494 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2495 max_hs_frag_len : rem_len;
2496
2497 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002498 {
2499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002500 (unsigned) cur_hs_frag_len,
2501 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002502 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002503
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002504 /* Messages are stored with handshake headers as if not fragmented,
2505 * copy beginning of headers then fill fragmentation fields.
2506 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2507 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002509 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2510 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2511 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2512
Hanno Becker67bc7c32018-08-06 11:33:50 +01002513 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2514 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2515 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002516
2517 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2518
Hanno Becker3f7b9732018-08-28 09:53:25 +01002519 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002520 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2521 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002522 ssl->out_msgtype = cur->type;
2523
2524 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002525 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002526 }
2527
2528 /* If done with the current message move to the next one if any */
2529 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2530 {
2531 if( cur->next != NULL )
2532 {
2533 ssl->handshake->cur_msg = cur->next;
2534 ssl->handshake->cur_msg_p = cur->next->p + 12;
2535 }
2536 else
2537 {
2538 ssl->handshake->cur_msg = NULL;
2539 ssl->handshake->cur_msg_p = NULL;
2540 }
2541 }
2542
2543 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002544 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002545 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547 return( ret );
2548 }
2549 }
2550
Hanno Becker67bc7c32018-08-06 11:33:50 +01002551 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2552 return( ret );
2553
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002554 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2556 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002557 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002558 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002560 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002561 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002562
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002564
2565 return( 0 );
2566}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002567
2568/*
2569 * To be called when the last message of an incoming flight is received.
2570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002572{
2573 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002574 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002575 ssl->handshake->flight = NULL;
2576 ssl->handshake->cur_msg = NULL;
2577
2578 /* The next incoming flight will start with this msg_seq */
2579 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2580
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002581 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002582 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002583
Hanno Becker0271f962018-08-16 13:23:47 +01002584 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002585 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002586
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002587 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002588 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2591 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002594 }
2595 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002597}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002598
2599/*
2600 * To be called when the last message of an outgoing flight is send.
2601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002603{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002604 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002605 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2608 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002609 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002611 }
2612 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002614}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002616
Paul Bakker5121ce52009-01-03 21:22:43 +00002617/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002618 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002619 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002620
2621/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002622 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002623 *
2624 * - fill in handshake headers
2625 * - update handshake checksum
2626 * - DTLS: save message for resending
2627 * - then pass to the record layer
2628 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002629 * DTLS: except for HelloRequest, messages are only queued, and will only be
2630 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002631 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002632 * Inputs:
2633 * - ssl->out_msglen: 4 + actual handshake message len
2634 * (4 is the size of handshake headers for TLS)
2635 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2636 * - ssl->out_msg + 4: the handshake message body
2637 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002638 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002639 * - ssl->out_msglen: the length of the record contents
2640 * (including handshake headers but excluding record headers)
2641 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002642 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002643int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002644{
Janos Follath865b3eb2019-12-16 11:46:15 +00002645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002646 const size_t hs_len = ssl->out_msglen - 4;
2647 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002648
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2650
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002651 /*
2652 * Sanity checks
2653 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002654 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002655 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2656 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002657 /* In SSLv3, the client might send a NoCertificate alert. */
2658#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2659 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2660 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2661 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2662#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2663 {
2664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2665 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2666 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002667 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002668
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002669 /* Whenever we send anything different from a
2670 * HelloRequest we should be in a handshake - double check. */
2671 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2672 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002673 ssl->handshake == NULL )
2674 {
2675 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2676 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2677 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002680 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002681 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002683 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002684 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2685 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002686 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002687#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002688
Hanno Beckerb50a2532018-08-06 11:52:54 +01002689 /* Double-check that we did not exceed the bounds
2690 * of the outgoing record buffer.
2691 * This should never fail as the various message
2692 * writing functions must obey the bounds of the
2693 * outgoing record buffer, but better be safe.
2694 *
2695 * Note: We deliberately do not check for the MTU or MFL here.
2696 */
2697 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2698 {
2699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2700 "size %u, maximum %u",
2701 (unsigned) ssl->out_msglen,
2702 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2703 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2704 }
2705
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002706 /*
2707 * Fill handshake headers
2708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002710 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002711 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2712 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2713 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002714
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002715 /*
2716 * DTLS has additional fields in the Handshake layer,
2717 * between the length field and the actual payload:
2718 * uint16 message_seq;
2719 * uint24 fragment_offset;
2720 * uint24 fragment_length;
2721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002723 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002724 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002725 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002726 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002727 {
2728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2729 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002730 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002731 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2733 }
2734
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002735 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002736 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002737
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002738 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002739 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002740 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002741 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2742 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2743 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002744 }
2745 else
2746 {
2747 ssl->out_msg[4] = 0;
2748 ssl->out_msg[5] = 0;
2749 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002750
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002751 /* Handshake hashes are computed without fragmentation,
2752 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002753 memset( ssl->out_msg + 6, 0x00, 3 );
2754 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002755 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002757
Hanno Becker0207e532018-08-28 10:28:28 +01002758 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002759 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2760 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002761 }
2762
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002763 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002765 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002766 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2767 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002768 {
2769 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002772 return( ret );
2773 }
2774 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002775 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002776#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002777 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002778 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002779 {
2780 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2781 return( ret );
2782 }
2783 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002784
2785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2786
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002787 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002788}
2789
2790/*
2791 * Record layer functions
2792 */
2793
2794/*
2795 * Write current record.
2796 *
2797 * Uses:
2798 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2799 * - ssl->out_msglen: length of the record content (excl headers)
2800 * - ssl->out_msg: record content
2801 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002802int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002803{
2804 int ret, done = 0;
2805 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002806 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002807
2808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002811 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002813 {
2814 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2815 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002817 return( ret );
2818 }
2819
2820 len = ssl->out_msglen;
2821 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2825 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002828
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 ret = mbedtls_ssl_hw_record_write( ssl );
2830 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2833 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002834 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002835
2836 if( ret == 0 )
2837 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002838 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002840 if( !done )
2841 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002842 unsigned i;
2843 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002844#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2845 size_t out_buf_len = ssl->out_buf_len;
2846#else
2847 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2848#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002849 /* Skip writing the record content type to after the encryption,
2850 * as it may change when using the CID extension. */
2851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002853 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002854
Hanno Becker19859472018-08-06 09:40:20 +01002855 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002856 ssl->out_len[0] = (unsigned char)( len >> 8 );
2857 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002858
Paul Bakker48916f92012-09-16 19:57:18 +00002859 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002860 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002861 mbedtls_record rec;
2862
2863 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002864 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002865 rec.data_len = ssl->out_msglen;
2866 rec.data_offset = ssl->out_msg - rec.buf;
2867
2868 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2869 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2870 ssl->conf->transport, rec.ver );
2871 rec.type = ssl->out_msgtype;
2872
Hanno Beckera0e20d02019-05-15 14:03:01 +01002873#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002874 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002875 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002876#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002877
Hanno Beckera18d1322018-01-03 14:27:32 +00002878 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002879 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002882 return( ret );
2883 }
2884
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002885 if( rec.data_offset != 0 )
2886 {
2887 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2888 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2889 }
2890
Hanno Becker6430faf2019-05-08 11:57:13 +01002891 /* Update the record content type and CID. */
2892 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002893#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002894 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002895#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002896 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002897 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2898 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002899 }
2900
Hanno Becker5903de42019-05-03 14:46:38 +01002901 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002902
2903#if defined(MBEDTLS_SSL_PROTO_DTLS)
2904 /* In case of DTLS, double-check that we don't exceed
2905 * the remaining space in the datagram. */
2906 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2907 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002908 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002909 if( ret < 0 )
2910 return( ret );
2911
2912 if( protected_record_size > (size_t) ret )
2913 {
2914 /* Should never happen */
2915 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2916 }
2917 }
2918#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002919
Hanno Becker6430faf2019-05-08 11:57:13 +01002920 /* Now write the potentially updated record content type. */
2921 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002924 "version = [%d:%d], msglen = %d",
2925 ssl->out_hdr[0], ssl->out_hdr[1],
2926 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002929 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002930
2931 ssl->out_left += protected_record_size;
2932 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002933 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002934
Hanno Beckerdd772292020-02-05 10:38:31 +00002935 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002936 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2937 break;
2938
2939 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002940 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002941 {
2942 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2943 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2944 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002945 }
2946
Hanno Becker67bc7c32018-08-06 11:33:50 +01002947#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002948 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2949 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002950 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002951 size_t remaining;
2952 ret = ssl_get_remaining_payload_in_datagram( ssl );
2953 if( ret < 0 )
2954 {
2955 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2956 ret );
2957 return( ret );
2958 }
2959
2960 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002961 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002962 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002963 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002964 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002965 else
2966 {
Hanno Becker513815a2018-08-20 11:56:09 +01002967 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002968 }
2969 }
2970#endif /* MBEDTLS_SSL_PROTO_DTLS */
2971
2972 if( ( flush == SSL_FORCE_FLUSH ) &&
2973 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002974 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 return( ret );
2977 }
2978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002980
2981 return( 0 );
2982}
2983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002985
2986static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2987{
2988 if( ssl->in_msglen < ssl->in_hslen ||
2989 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2990 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2991 {
2992 return( 1 );
2993 }
2994 return( 0 );
2995}
Hanno Becker44650b72018-08-16 12:51:11 +01002996
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002997static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002998{
2999 return( ( ssl->in_msg[9] << 16 ) |
3000 ( ssl->in_msg[10] << 8 ) |
3001 ssl->in_msg[11] );
3002}
3003
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003004static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003005{
3006 return( ( ssl->in_msg[6] << 16 ) |
3007 ( ssl->in_msg[7] << 8 ) |
3008 ssl->in_msg[8] );
3009}
3010
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003011static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01003012{
3013 uint32_t msg_len, frag_off, frag_len;
3014
3015 msg_len = ssl_get_hs_total_len( ssl );
3016 frag_off = ssl_get_hs_frag_off( ssl );
3017 frag_len = ssl_get_hs_frag_len( ssl );
3018
3019 if( frag_off > msg_len )
3020 return( -1 );
3021
3022 if( frag_len > msg_len - frag_off )
3023 return( -1 );
3024
3025 if( frag_len + 12 > ssl->in_msglen )
3026 return( -1 );
3027
3028 return( 0 );
3029}
3030
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003031/*
3032 * Mark bits in bitmask (used for DTLS HS reassembly)
3033 */
3034static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
3035{
3036 unsigned int start_bits, end_bits;
3037
3038 start_bits = 8 - ( offset % 8 );
3039 if( start_bits != 8 )
3040 {
3041 size_t first_byte_idx = offset / 8;
3042
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003043 /* Special case */
3044 if( len <= start_bits )
3045 {
3046 for( ; len != 0; len-- )
3047 mask[first_byte_idx] |= 1 << ( start_bits - len );
3048
3049 /* Avoid potential issues with offset or len becoming invalid */
3050 return;
3051 }
3052
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003053 offset += start_bits; /* Now offset % 8 == 0 */
3054 len -= start_bits;
3055
3056 for( ; start_bits != 0; start_bits-- )
3057 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
3058 }
3059
3060 end_bits = len % 8;
3061 if( end_bits != 0 )
3062 {
3063 size_t last_byte_idx = ( offset + len ) / 8;
3064
3065 len -= end_bits; /* Now len % 8 == 0 */
3066
3067 for( ; end_bits != 0; end_bits-- )
3068 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
3069 }
3070
3071 memset( mask + offset / 8, 0xFF, len / 8 );
3072}
3073
3074/*
3075 * Check that bitmask is full
3076 */
3077static int ssl_bitmask_check( unsigned char *mask, size_t len )
3078{
3079 size_t i;
3080
3081 for( i = 0; i < len / 8; i++ )
3082 if( mask[i] != 0xFF )
3083 return( -1 );
3084
3085 for( i = 0; i < len % 8; i++ )
3086 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
3087 return( -1 );
3088
3089 return( 0 );
3090}
3091
Hanno Becker56e205e2018-08-16 09:06:12 +01003092/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003093static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003094 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003095{
Hanno Becker56e205e2018-08-16 09:06:12 +01003096 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003097
Hanno Becker56e205e2018-08-16 09:06:12 +01003098 alloc_len = 12; /* Handshake header */
3099 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003100
Hanno Beckerd07df862018-08-16 09:14:58 +01003101 if( add_bitmap )
3102 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003103
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003104 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003105}
Hanno Becker56e205e2018-08-16 09:06:12 +01003106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003108
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003109static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003110{
3111 return( ( ssl->in_msg[1] << 16 ) |
3112 ( ssl->in_msg[2] << 8 ) |
3113 ssl->in_msg[3] );
3114}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003115
Simon Butcher99000142016-10-13 17:21:01 +01003116int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003117{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003119 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003121 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003123 }
3124
Hanno Becker12555c62018-08-16 12:47:53 +01003125 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003128 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003129 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003133 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003135 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003136
Hanno Becker44650b72018-08-16 12:51:11 +01003137 if( ssl_check_hs_header( ssl ) != 0 )
3138 {
3139 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3140 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3141 }
3142
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003143 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003144 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3145 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3146 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3147 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003148 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003149 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3150 {
3151 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3152 recv_msg_seq,
3153 ssl->handshake->in_msg_seq ) );
3154 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3155 }
3156
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003157 /* Retransmit only on last message from previous flight, to avoid
3158 * too many retransmissions.
3159 * Besides, No sane server ever retransmits HelloVerifyRequest */
3160 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003163 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003164 "message_seq = %d, start_of_flight = %d",
3165 recv_msg_seq,
3166 ssl->handshake->in_flight_start_seq ) );
3167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003168 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003169 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003171 return( ret );
3172 }
3173 }
3174 else
3175 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003177 "message_seq = %d, expected = %d",
3178 recv_msg_seq,
3179 ssl->handshake->in_msg_seq ) );
3180 }
3181
Hanno Becker90333da2017-10-10 11:27:13 +01003182 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003183 }
3184 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003185
Hanno Becker6d97ef52018-08-16 13:09:04 +01003186 /* Message reassembly is handled alongside buffering of future
3187 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003188 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003189 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003190 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003191 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003193 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003194 }
3195 }
3196 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003198 /* With TLS we don't handle fragmentation (for now) */
3199 if( ssl->in_msglen < ssl->in_hslen )
3200 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3202 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003203 }
3204
Simon Butcher99000142016-10-13 17:21:01 +01003205 return( 0 );
3206}
3207
3208void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3209{
Hanno Becker0271f962018-08-16 13:23:47 +01003210 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003211
Hanno Becker0271f962018-08-16 13:23:47 +01003212 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003213 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003214 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003215 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003216
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003217 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003219 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003220 ssl->handshake != NULL )
3221 {
Hanno Becker0271f962018-08-16 13:23:47 +01003222 unsigned offset;
3223 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003224
Hanno Becker0271f962018-08-16 13:23:47 +01003225 /* Increment handshake sequence number */
3226 hs->in_msg_seq++;
3227
3228 /*
3229 * Clear up handshake buffering and reassembly structure.
3230 */
3231
3232 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003233 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003234
3235 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003236 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3237 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003238 offset++, hs_buf++ )
3239 {
3240 *hs_buf = *(hs_buf + 1);
3241 }
3242
3243 /* Create a fresh last entry */
3244 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003245 }
3246#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003247}
3248
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003249/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003250 * DTLS anti-replay: RFC 6347 4.1.2.6
3251 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003252 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3253 * Bit n is set iff record number in_window_top - n has been seen.
3254 *
3255 * Usually, in_window_top is the last record number seen and the lsb of
3256 * in_window is set. The only exception is the initial state (record number 0
3257 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003260void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003261{
3262 ssl->in_window_top = 0;
3263 ssl->in_window = 0;
3264}
3265
3266static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3267{
3268 return( ( (uint64_t) buf[0] << 40 ) |
3269 ( (uint64_t) buf[1] << 32 ) |
3270 ( (uint64_t) buf[2] << 24 ) |
3271 ( (uint64_t) buf[3] << 16 ) |
3272 ( (uint64_t) buf[4] << 8 ) |
3273 ( (uint64_t) buf[5] ) );
3274}
3275
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003276static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3277{
Janos Follath865b3eb2019-12-16 11:46:15 +00003278 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003279 unsigned char *original_in_ctr;
3280
3281 // save original in_ctr
3282 original_in_ctr = ssl->in_ctr;
3283
3284 // use counter from record
3285 ssl->in_ctr = record_in_ctr;
3286
3287 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3288
3289 // restore the counter
3290 ssl->in_ctr = original_in_ctr;
3291
3292 return ret;
3293}
3294
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003295/*
3296 * Return 0 if sequence number is acceptable, -1 otherwise
3297 */
Hanno Becker0183d692019-07-12 08:50:37 +01003298int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003299{
3300 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3301 uint64_t bit;
3302
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003303 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003304 return( 0 );
3305
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003306 if( rec_seqnum > ssl->in_window_top )
3307 return( 0 );
3308
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003309 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003310
3311 if( bit >= 64 )
3312 return( -1 );
3313
3314 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3315 return( -1 );
3316
3317 return( 0 );
3318}
3319
3320/*
3321 * Update replay window on new validated record
3322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003324{
3325 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3326
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003327 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003328 return;
3329
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003330 if( rec_seqnum > ssl->in_window_top )
3331 {
3332 /* Update window_top and the contents of the window */
3333 uint64_t shift = rec_seqnum - ssl->in_window_top;
3334
3335 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003336 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003337 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003338 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003339 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003340 ssl->in_window |= 1;
3341 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003342
3343 ssl->in_window_top = rec_seqnum;
3344 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003345 else
3346 {
3347 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003348 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003349
3350 if( bit < 64 ) /* Always true, but be extra sure */
3351 ssl->in_window |= (uint64_t) 1 << bit;
3352 }
3353}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003355
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003356#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003357/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003358 * Without any SSL context, check if a datagram looks like a ClientHello with
3359 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003360 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003361 *
3362 * - if cookie is valid, return 0
3363 * - if ClientHello looks superficially valid but cookie is not,
3364 * fill obuf and set olen, then
3365 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3366 * - otherwise return a specific error code
3367 */
3368static int ssl_check_dtls_clihlo_cookie(
3369 mbedtls_ssl_cookie_write_t *f_cookie_write,
3370 mbedtls_ssl_cookie_check_t *f_cookie_check,
3371 void *p_cookie,
3372 const unsigned char *cli_id, size_t cli_id_len,
3373 const unsigned char *in, size_t in_len,
3374 unsigned char *obuf, size_t buf_len, size_t *olen )
3375{
3376 size_t sid_len, cookie_len;
3377 unsigned char *p;
3378
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003379 /*
3380 * Structure of ClientHello with record and handshake headers,
3381 * and expected values. We don't need to check a lot, more checks will be
3382 * done when actually parsing the ClientHello - skipping those checks
3383 * avoids code duplication and does not make cookie forging any easier.
3384 *
3385 * 0-0 ContentType type; copied, must be handshake
3386 * 1-2 ProtocolVersion version; copied
3387 * 3-4 uint16 epoch; copied, must be 0
3388 * 5-10 uint48 sequence_number; copied
3389 * 11-12 uint16 length; (ignored)
3390 *
3391 * 13-13 HandshakeType msg_type; (ignored)
3392 * 14-16 uint24 length; (ignored)
3393 * 17-18 uint16 message_seq; copied
3394 * 19-21 uint24 fragment_offset; copied, must be 0
3395 * 22-24 uint24 fragment_length; (ignored)
3396 *
3397 * 25-26 ProtocolVersion client_version; (ignored)
3398 * 27-58 Random random; (ignored)
3399 * 59-xx SessionID session_id; 1 byte len + sid_len content
3400 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3401 * ...
3402 *
3403 * Minimum length is 61 bytes.
3404 */
3405 if( in_len < 61 ||
3406 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3407 in[3] != 0 || in[4] != 0 ||
3408 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3409 {
3410 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3411 }
3412
3413 sid_len = in[59];
3414 if( sid_len > in_len - 61 )
3415 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3416
3417 cookie_len = in[60 + sid_len];
3418 if( cookie_len > in_len - 60 )
3419 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3420
3421 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3422 cli_id, cli_id_len ) == 0 )
3423 {
3424 /* Valid cookie */
3425 return( 0 );
3426 }
3427
3428 /*
3429 * If we get here, we've got an invalid cookie, let's prepare HVR.
3430 *
3431 * 0-0 ContentType type; copied
3432 * 1-2 ProtocolVersion version; copied
3433 * 3-4 uint16 epoch; copied
3434 * 5-10 uint48 sequence_number; copied
3435 * 11-12 uint16 length; olen - 13
3436 *
3437 * 13-13 HandshakeType msg_type; hello_verify_request
3438 * 14-16 uint24 length; olen - 25
3439 * 17-18 uint16 message_seq; copied
3440 * 19-21 uint24 fragment_offset; copied
3441 * 22-24 uint24 fragment_length; olen - 25
3442 *
3443 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3444 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3445 *
3446 * Minimum length is 28.
3447 */
3448 if( buf_len < 28 )
3449 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3450
3451 /* Copy most fields and adapt others */
3452 memcpy( obuf, in, 25 );
3453 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3454 obuf[25] = 0xfe;
3455 obuf[26] = 0xff;
3456
3457 /* Generate and write actual cookie */
3458 p = obuf + 28;
3459 if( f_cookie_write( p_cookie,
3460 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3461 {
3462 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3463 }
3464
3465 *olen = p - obuf;
3466
3467 /* Go back and fill length fields */
3468 obuf[27] = (unsigned char)( *olen - 28 );
3469
3470 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3471 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3472 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3473
3474 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3475 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3476
3477 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3478}
3479
3480/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003481 * Handle possible client reconnect with the same UDP quadruplet
3482 * (RFC 6347 Section 4.2.8).
3483 *
3484 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3485 * that looks like a ClientHello.
3486 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003487 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003488 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003489 * - if the input looks like a ClientHello with a valid cookie,
3490 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003491 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003492 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003493 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003494 * This function is called (through ssl_check_client_reconnect()) when an
3495 * unexpected record is found in ssl_get_next_record(), which will discard the
3496 * record if we return 0, and bubble up the return value otherwise (this
3497 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3498 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003499 */
3500static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3501{
Janos Follath865b3eb2019-12-16 11:46:15 +00003502 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003503 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003504
Hanno Becker2fddd372019-07-10 14:37:41 +01003505 if( ssl->conf->f_cookie_write == NULL ||
3506 ssl->conf->f_cookie_check == NULL )
3507 {
3508 /* If we can't use cookies to verify reachability of the peer,
3509 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003510 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3511 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003512 return( 0 );
3513 }
3514
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003515 ret = ssl_check_dtls_clihlo_cookie(
3516 ssl->conf->f_cookie_write,
3517 ssl->conf->f_cookie_check,
3518 ssl->conf->p_cookie,
3519 ssl->cli_id, ssl->cli_id_len,
3520 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003521 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003522
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003523 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3524
3525 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003526 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003527 int send_ret;
3528 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3529 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3530 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003531 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003532 * If the error is permanent we'll catch it later,
3533 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003534 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3535 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3536 (void) send_ret;
3537
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003538 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003539 }
3540
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003541 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003542 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003544 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003545 {
3546 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3547 return( ret );
3548 }
3549
3550 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003551 }
3552
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003553 return( ret );
3554}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003555#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003556
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003557static int ssl_check_record_type( uint8_t record_type )
3558{
3559 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3560 record_type != MBEDTLS_SSL_MSG_ALERT &&
3561 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3562 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3563 {
3564 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3565 }
3566
3567 return( 0 );
3568}
3569
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003570/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003571 * ContentType type;
3572 * ProtocolVersion version;
3573 * uint16 epoch; // DTLS only
3574 * uint48 sequence_number; // DTLS only
3575 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003576 *
3577 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003578 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003579 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3580 *
3581 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003582 * 1. proceed with the record if this function returns 0
3583 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3584 * 3. return CLIENT_RECONNECT if this function return that value
3585 * 4. drop the whole datagram if this function returns anything else.
3586 * Point 2 is needed when the peer is resending, and we have already received
3587 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003588 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003589static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003590 unsigned char *buf,
3591 size_t len,
3592 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003593{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003594 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003595
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596 size_t const rec_hdr_type_offset = 0;
3597 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003598
Hanno Beckere5e7e782019-07-11 12:29:35 +01003599 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3600 rec_hdr_type_len;
3601 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003602
Hanno Beckere5e7e782019-07-11 12:29:35 +01003603 size_t const rec_hdr_ctr_len = 8;
3604#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003605 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003606 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3607 rec_hdr_version_len;
3608
Hanno Beckera0e20d02019-05-15 14:03:01 +01003609#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003610 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3611 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003612 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3614#endif /* MBEDTLS_SSL_PROTO_DTLS */
3615
3616 size_t rec_hdr_len_offset; /* To be determined */
3617 size_t const rec_hdr_len_len = 2;
3618
3619 /*
3620 * Check minimum lengths for record header.
3621 */
3622
3623#if defined(MBEDTLS_SSL_PROTO_DTLS)
3624 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3625 {
3626 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3627 }
3628 else
3629#endif /* MBEDTLS_SSL_PROTO_DTLS */
3630 {
3631 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3632 }
3633
3634 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3635 {
3636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3637 (unsigned) len,
3638 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3639 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3640 }
3641
3642 /*
3643 * Parse and validate record content type
3644 */
3645
3646 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647
3648 /* Check record content type */
3649#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3650 rec->cid_len = 0;
3651
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003652 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003653 ssl->conf->cid_len != 0 &&
3654 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003655 {
3656 /* Shift pointers to account for record header including CID
3657 * struct {
3658 * ContentType special_type = tls12_cid;
3659 * ProtocolVersion version;
3660 * uint16 epoch;
3661 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003662 * opaque cid[cid_length]; // Additional field compared to
3663 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003664 * uint16 length;
3665 * opaque enc_content[DTLSCiphertext.length];
3666 * } DTLSCiphertext;
3667 */
3668
3669 /* So far, we only support static CID lengths
3670 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003671 rec_hdr_cid_len = ssl->conf->cid_len;
3672 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003673
Hanno Beckere5e7e782019-07-11 12:29:35 +01003674 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003675 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3677 (unsigned) len,
3678 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003679 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003680 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003681
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003682 /* configured CID len is guaranteed at most 255, see
3683 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3684 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003685 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003686 }
3687 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003688#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003689 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003690 if( ssl_check_record_type( rec->type ) )
3691 {
Hanno Becker54229812019-07-12 14:40:00 +01003692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3693 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003694 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3695 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003696 }
3697
Hanno Beckere5e7e782019-07-11 12:29:35 +01003698 /*
3699 * Parse and validate record version
3700 */
3701
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003702 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3703 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003704 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3705 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003706 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003707
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003708 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003709 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3711 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003712 }
3713
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003714 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003715 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3717 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003718 }
3719
Hanno Beckere5e7e782019-07-11 12:29:35 +01003720 /*
3721 * Parse/Copy record sequence number.
3722 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003723
Hanno Beckere5e7e782019-07-11 12:29:35 +01003724#if defined(MBEDTLS_SSL_PROTO_DTLS)
3725 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003726 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003727 /* Copy explicit record sequence number from input buffer. */
3728 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3729 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003730 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003731 else
3732#endif /* MBEDTLS_SSL_PROTO_DTLS */
3733 {
3734 /* Copy implicit record sequence number from SSL context structure. */
3735 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3736 }
Paul Bakker40e46942009-01-03 21:51:57 +00003737
Hanno Beckere5e7e782019-07-11 12:29:35 +01003738 /*
3739 * Parse record length.
3740 */
3741
Hanno Beckere5e7e782019-07-11 12:29:35 +01003742 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003743 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3744 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003745 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003746
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003747 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003748 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003749 rec->type,
3750 major_ver, minor_ver, rec->data_len ) );
3751
3752 rec->buf = buf;
3753 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003754
Hanno Beckerd417cc92019-07-26 08:20:27 +01003755 if( rec->data_len == 0 )
3756 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003757
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003758 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003759 * DTLS-related tests.
3760 * Check epoch before checking length constraint because
3761 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3762 * message gets duplicated before the corresponding Finished message,
3763 * the second ChangeCipherSpec should be discarded because it belongs
3764 * to an old epoch, but not because its length is shorter than
3765 * the minimum record length for packets using the new record transform.
3766 * Note that these two kinds of failures are handled differently,
3767 * as an unexpected record is silently skipped but an invalid
3768 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003769 */
3770#if defined(MBEDTLS_SSL_PROTO_DTLS)
3771 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3772 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003773 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003774
Hanno Becker955a5c92019-07-10 17:12:07 +01003775 /* Check that the datagram is large enough to contain a record
3776 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003777 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003778 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003779 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3780 (unsigned) len,
3781 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003782 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3783 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003784
Hanno Becker37cfe732019-07-10 17:20:01 +01003785 /* Records from other, non-matching epochs are silently discarded.
3786 * (The case of same-port Client reconnects must be considered in
3787 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003788 if( rec_epoch != ssl->in_epoch )
3789 {
3790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3791 "expected %d, received %d",
3792 ssl->in_epoch, rec_epoch ) );
3793
Hanno Becker552f7472019-07-19 10:59:12 +01003794 /* Records from the next epoch are considered for buffering
3795 * (concretely: early Finished messages). */
3796 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003797 {
Hanno Becker552f7472019-07-19 10:59:12 +01003798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3799 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003800 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003801
Hanno Becker2fddd372019-07-10 14:37:41 +01003802 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003803 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003804#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003805 /* For records from the correct epoch, check whether their
3806 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003807 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3808 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003809 {
3810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3811 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3812 }
3813#endif
3814 }
3815#endif /* MBEDTLS_SSL_PROTO_DTLS */
3816
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003817 return( 0 );
3818}
Paul Bakker5121ce52009-01-03 21:22:43 +00003819
Paul Bakker5121ce52009-01-03 21:22:43 +00003820
Hanno Becker2fddd372019-07-10 14:37:41 +01003821#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3822static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3823{
3824 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3825
3826 /*
3827 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3828 * access the first byte of record content (handshake type), as we
3829 * have an active transform (possibly iv_len != 0), so use the
3830 * fact that the record header len is 13 instead.
3831 */
3832 if( rec_epoch == 0 &&
3833 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3834 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3835 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3836 ssl->in_left > 13 &&
3837 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3838 {
3839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3840 "from the same port" ) );
3841 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003842 }
3843
3844 return( 0 );
3845}
Hanno Becker2fddd372019-07-10 14:37:41 +01003846#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003847
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003848/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003849 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003850 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003851static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3852 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003853{
3854 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003857 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003859#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3860 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003861 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864 ret = mbedtls_ssl_hw_record_read( ssl );
3865 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003866 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003867 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3868 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003869 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003870
3871 if( ret == 0 )
3872 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003873 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003874#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003875 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003876 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003877 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003878
Hanno Beckera18d1322018-01-03 14:27:32 +00003879 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003880 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003882 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003883
Hanno Beckera0e20d02019-05-15 14:03:01 +01003884#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003885 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3886 ssl->conf->ignore_unexpected_cid
3887 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3888 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003890 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003891 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003892#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003893
Paul Bakker5121ce52009-01-03 21:22:43 +00003894 return( ret );
3895 }
3896
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003897 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003898 {
3899 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003900 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003901 }
3902
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003903 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003904 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003905
Hanno Beckera0e20d02019-05-15 14:03:01 +01003906#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003907 /* We have already checked the record content type
3908 * in ssl_parse_record_header(), failing or silently
3909 * dropping the record in the case of an unknown type.
3910 *
3911 * Since with the use of CIDs, the record content type
3912 * might change during decryption, re-check the record
3913 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003914 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003915 {
3916 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3917 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3918 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003919#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003920
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003921 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003922 {
3923#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3924 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003925 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003926 {
3927 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3929 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3930 }
3931#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3932
3933 ssl->nb_zero++;
3934
3935 /*
3936 * Three or more empty messages may be a DoS attack
3937 * (excessive CPU consumption).
3938 */
3939 if( ssl->nb_zero > 3 )
3940 {
3941 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003942 "messages, possible DoS attack" ) );
3943 /* Treat the records as if they were not properly authenticated,
3944 * thereby failing the connection if we see more than allowed
3945 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003946 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3947 }
3948 }
3949 else
3950 ssl->nb_zero = 0;
3951
3952#if defined(MBEDTLS_SSL_PROTO_DTLS)
3953 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3954 {
3955 ; /* in_ctr read from peer, not maintained internally */
3956 }
3957 else
3958#endif
3959 {
3960 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003961 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003962 if( ++ssl->in_ctr[i - 1] != 0 )
3963 break;
3964
3965 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003966 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003967 {
3968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3969 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3970 }
3971 }
3972
Paul Bakker5121ce52009-01-03 21:22:43 +00003973 }
3974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003976 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003977 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003979 }
3980#endif
3981
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003982 /* Check actual (decrypted) record content length against
3983 * configured maximum. */
3984 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3985 {
3986 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3987 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3988 }
3989
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003990 return( 0 );
3991}
3992
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003993/*
3994 * Read a record.
3995 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003996 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3997 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3998 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003999 */
Hanno Becker1097b342018-08-15 14:09:41 +01004000
4001/* Helper functions for mbedtls_ssl_read_record(). */
4002static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01004003static int ssl_get_next_record( mbedtls_ssl_context *ssl );
4004static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01004005
Hanno Becker327c93b2018-08-15 13:56:18 +01004006int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01004007 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004008{
Janos Follath865b3eb2019-12-16 11:46:15 +00004009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004011 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004012
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004013 if( ssl->keep_current_message == 0 )
4014 {
4015 do {
Simon Butcher99000142016-10-13 17:21:01 +01004016
Hanno Becker26994592018-08-15 14:14:59 +01004017 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01004018 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004019 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01004020
Hanno Beckere74d5562018-08-15 14:26:08 +01004021 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004022 {
Hanno Becker40f50842018-08-15 14:48:01 +01004023#if defined(MBEDTLS_SSL_PROTO_DTLS)
4024 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004025
Hanno Becker40f50842018-08-15 14:48:01 +01004026 /* We only check for buffered messages if the
4027 * current datagram is fully consumed. */
4028 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004029 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004030 {
Hanno Becker40f50842018-08-15 14:48:01 +01004031 if( ssl_load_buffered_message( ssl ) == 0 )
4032 have_buffered = 1;
4033 }
4034
4035 if( have_buffered == 0 )
4036#endif /* MBEDTLS_SSL_PROTO_DTLS */
4037 {
4038 ret = ssl_get_next_record( ssl );
4039 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
4040 continue;
4041
4042 if( ret != 0 )
4043 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01004044 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004045 return( ret );
4046 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004047 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004048 }
4049
4050 ret = mbedtls_ssl_handle_message_type( ssl );
4051
Hanno Becker40f50842018-08-15 14:48:01 +01004052#if defined(MBEDTLS_SSL_PROTO_DTLS)
4053 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4054 {
4055 /* Buffer future message */
4056 ret = ssl_buffer_message( ssl );
4057 if( ret != 0 )
4058 return( ret );
4059
4060 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4061 }
4062#endif /* MBEDTLS_SSL_PROTO_DTLS */
4063
Hanno Becker90333da2017-10-10 11:27:13 +01004064 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4065 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004066
4067 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01004068 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00004069 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01004070 return( ret );
4071 }
4072
Hanno Becker327c93b2018-08-15 13:56:18 +01004073 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01004074 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004075 {
4076 mbedtls_ssl_update_handshake_status( ssl );
4077 }
Simon Butcher99000142016-10-13 17:21:01 +01004078 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004079 else
Simon Butcher99000142016-10-13 17:21:01 +01004080 {
Hanno Becker02f59072018-08-15 14:00:24 +01004081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004082 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004083 }
4084
4085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
4086
4087 return( 0 );
4088}
4089
Hanno Becker40f50842018-08-15 14:48:01 +01004090#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004091static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004092{
Hanno Becker40f50842018-08-15 14:48:01 +01004093 if( ssl->in_left > ssl->next_record_offset )
4094 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004095
Hanno Becker40f50842018-08-15 14:48:01 +01004096 return( 0 );
4097}
4098
4099static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4100{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004101 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004102 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004103 int ret = 0;
4104
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004105 if( hs == NULL )
4106 return( -1 );
4107
Hanno Beckere00ae372018-08-20 09:39:42 +01004108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4109
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004110 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4111 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4112 {
4113 /* Check if we have seen a ChangeCipherSpec before.
4114 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004115 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004116 {
4117 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4118 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004119 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004120 }
4121
Hanno Becker39b8bc92018-08-28 17:17:13 +01004122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4124 ssl->in_msglen = 1;
4125 ssl->in_msg[0] = 1;
4126
4127 /* As long as they are equal, the exact value doesn't matter. */
4128 ssl->in_left = 0;
4129 ssl->next_record_offset = 0;
4130
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004131 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004132 goto exit;
4133 }
Hanno Becker37f95322018-08-16 13:55:32 +01004134
Hanno Beckerb8f50142018-08-28 10:01:34 +01004135#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004136 /* Debug only */
4137 {
4138 unsigned offset;
4139 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4140 {
4141 hs_buf = &hs->buffering.hs[offset];
4142 if( hs_buf->is_valid == 1 )
4143 {
4144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4145 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004146 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004147 }
4148 }
4149 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004150#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004151
4152 /* Check if we have buffered and/or fully reassembled the
4153 * next handshake message. */
4154 hs_buf = &hs->buffering.hs[0];
4155 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4156 {
4157 /* Synthesize a record containing the buffered HS message. */
4158 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4159 ( hs_buf->data[2] << 8 ) |
4160 hs_buf->data[3];
4161
4162 /* Double-check that we haven't accidentally buffered
4163 * a message that doesn't fit into the input buffer. */
4164 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4165 {
4166 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4167 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4168 }
4169
4170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4171 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4172 hs_buf->data, msg_len + 12 );
4173
4174 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4175 ssl->in_hslen = msg_len + 12;
4176 ssl->in_msglen = msg_len + 12;
4177 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4178
4179 ret = 0;
4180 goto exit;
4181 }
4182 else
4183 {
4184 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4185 hs->in_msg_seq ) );
4186 }
4187
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004188 ret = -1;
4189
4190exit:
4191
4192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4193 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004194}
4195
Hanno Beckera02b0b42018-08-21 17:20:27 +01004196static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4197 size_t desired )
4198{
4199 int offset;
4200 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004201 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4202 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004203
Hanno Becker01315ea2018-08-21 17:22:17 +01004204 /* Get rid of future records epoch first, if such exist. */
4205 ssl_free_buffered_record( ssl );
4206
4207 /* Check if we have enough space available now. */
4208 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4209 hs->buffering.total_bytes_buffered ) )
4210 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004212 return( 0 );
4213 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004214
Hanno Becker4f432ad2018-08-28 10:02:32 +01004215 /* We don't have enough space to buffer the next expected handshake
4216 * message. Remove buffers used for future messages to gain space,
4217 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004218 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4219 offset >= 0; offset-- )
4220 {
4221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4222 offset ) );
4223
Hanno Beckerb309b922018-08-23 13:18:05 +01004224 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004225
4226 /* Check if we have enough space available now. */
4227 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4228 hs->buffering.total_bytes_buffered ) )
4229 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004230 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004231 return( 0 );
4232 }
4233 }
4234
4235 return( -1 );
4236}
4237
Hanno Becker40f50842018-08-15 14:48:01 +01004238static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4239{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004240 int ret = 0;
4241 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4242
4243 if( hs == NULL )
4244 return( 0 );
4245
4246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4247
4248 switch( ssl->in_msgtype )
4249 {
4250 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4251 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004252
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004253 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004254 break;
4255
4256 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004257 {
4258 unsigned recv_msg_seq_offset;
4259 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4260 mbedtls_ssl_hs_buffer *hs_buf;
4261 size_t msg_len = ssl->in_hslen - 12;
4262
4263 /* We should never receive an old handshake
4264 * message - double-check nonetheless. */
4265 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4266 {
4267 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4268 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4269 }
4270
4271 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4272 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4273 {
4274 /* Silently ignore -- message too far in the future */
4275 MBEDTLS_SSL_DEBUG_MSG( 2,
4276 ( "Ignore future HS message with sequence number %u, "
4277 "buffering window %u - %u",
4278 recv_msg_seq, ssl->handshake->in_msg_seq,
4279 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4280
4281 goto exit;
4282 }
4283
4284 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4285 recv_msg_seq, recv_msg_seq_offset ) );
4286
4287 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4288
4289 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004290 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004291 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004292 size_t reassembly_buf_sz;
4293
Hanno Becker37f95322018-08-16 13:55:32 +01004294 hs_buf->is_fragmented =
4295 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4296
4297 /* We copy the message back into the input buffer
4298 * after reassembly, so check that it's not too large.
4299 * This is an implementation-specific limitation
4300 * and not one from the standard, hence it is not
4301 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004302 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004303 {
4304 /* Ignore message */
4305 goto exit;
4306 }
4307
Hanno Beckere0b150f2018-08-21 15:51:03 +01004308 /* Check if we have enough space to buffer the message. */
4309 if( hs->buffering.total_bytes_buffered >
4310 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4311 {
4312 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4313 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4314 }
4315
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004316 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4317 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004318
4319 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4320 hs->buffering.total_bytes_buffered ) )
4321 {
4322 if( recv_msg_seq_offset > 0 )
4323 {
4324 /* If we can't buffer a future message because
4325 * of space limitations -- ignore. */
4326 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- ignore\n",
4327 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4328 (unsigned) hs->buffering.total_bytes_buffered ) );
4329 goto exit;
4330 }
Hanno Beckere1801392018-08-21 16:51:05 +01004331 else
4332 {
4333 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future message of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4334 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4335 (unsigned) hs->buffering.total_bytes_buffered ) );
4336 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004337
Hanno Beckera02b0b42018-08-21 17:20:27 +01004338 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004339 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004340 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Reassembly of next message of size %u (%u with bitmap) would exceed the compile-time limit %u (already %u bytes buffered) -- fail\n",
4341 (unsigned) msg_len,
4342 (unsigned) reassembly_buf_sz,
4343 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004344 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004345 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4346 goto exit;
4347 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004348 }
4349
4350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4351 msg_len ) );
4352
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004353 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4354 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004355 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004356 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004357 goto exit;
4358 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004359 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004360
4361 /* Prepare final header: copy msg_type, length and message_seq,
4362 * then add standardised fragment_offset and fragment_length */
4363 memcpy( hs_buf->data, ssl->in_msg, 6 );
4364 memset( hs_buf->data + 6, 0, 3 );
4365 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4366
4367 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004368
4369 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004370 }
4371 else
4372 {
4373 /* Make sure msg_type and length are consistent */
4374 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4375 {
4376 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4377 /* Ignore */
4378 goto exit;
4379 }
4380 }
4381
Hanno Becker4422bbb2018-08-20 09:40:19 +01004382 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004383 {
4384 size_t frag_len, frag_off;
4385 unsigned char * const msg = hs_buf->data + 12;
4386
4387 /*
4388 * Check and copy current fragment
4389 */
4390
4391 /* Validation of header fields already done in
4392 * mbedtls_ssl_prepare_handshake_record(). */
4393 frag_off = ssl_get_hs_frag_off( ssl );
4394 frag_len = ssl_get_hs_frag_len( ssl );
4395
4396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4397 frag_off, frag_len ) );
4398 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4399
4400 if( hs_buf->is_fragmented )
4401 {
4402 unsigned char * const bitmask = msg + msg_len;
4403 ssl_bitmask_set( bitmask, frag_off, frag_len );
4404 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4405 msg_len ) == 0 );
4406 }
4407 else
4408 {
4409 hs_buf->is_complete = 1;
4410 }
4411
4412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4413 hs_buf->is_complete ? "" : "not yet " ) );
4414 }
4415
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004416 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004417 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004418
4419 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004420 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004421 break;
4422 }
4423
4424exit:
4425
4426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4427 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004428}
4429#endif /* MBEDTLS_SSL_PROTO_DTLS */
4430
Hanno Becker1097b342018-08-15 14:09:41 +01004431static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004432{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004433 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004434 * Consume last content-layer message and potentially
4435 * update in_msglen which keeps track of the contents'
4436 * consumption state.
4437 *
4438 * (1) Handshake messages:
4439 * Remove last handshake message, move content
4440 * and adapt in_msglen.
4441 *
4442 * (2) Alert messages:
4443 * Consume whole record content, in_msglen = 0.
4444 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004445 * (3) Change cipher spec:
4446 * Consume whole record content, in_msglen = 0.
4447 *
4448 * (4) Application data:
4449 * Don't do anything - the record layer provides
4450 * the application data as a stream transport
4451 * and consumes through mbedtls_ssl_read only.
4452 *
4453 */
4454
4455 /* Case (1): Handshake messages */
4456 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004457 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004458 /* Hard assertion to be sure that no application data
4459 * is in flight, as corrupting ssl->in_msglen during
4460 * ssl->in_offt != NULL is fatal. */
4461 if( ssl->in_offt != NULL )
4462 {
4463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4464 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4465 }
4466
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004467 /*
4468 * Get next Handshake message in the current record
4469 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004470
Hanno Becker4a810fb2017-05-24 16:27:30 +01004471 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004472 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004473 * current handshake content: If DTLS handshake
4474 * fragmentation is used, that's the fragment
4475 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004476 * size here is faulty and should be changed at
4477 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004478 * (2) While it doesn't seem to cause problems, one
4479 * has to be very careful not to assume that in_hslen
4480 * is always <= in_msglen in a sensible communication.
4481 * Again, it's wrong for DTLS handshake fragmentation.
4482 * The following check is therefore mandatory, and
4483 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004484 * Additionally, ssl->in_hslen might be arbitrarily out of
4485 * bounds after handling a DTLS message with an unexpected
4486 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004487 */
4488 if( ssl->in_hslen < ssl->in_msglen )
4489 {
4490 ssl->in_msglen -= ssl->in_hslen;
4491 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4492 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004493
Hanno Becker4a810fb2017-05-24 16:27:30 +01004494 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4495 ssl->in_msg, ssl->in_msglen );
4496 }
4497 else
4498 {
4499 ssl->in_msglen = 0;
4500 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004501
Hanno Becker4a810fb2017-05-24 16:27:30 +01004502 ssl->in_hslen = 0;
4503 }
4504 /* Case (4): Application data */
4505 else if( ssl->in_offt != NULL )
4506 {
4507 return( 0 );
4508 }
4509 /* Everything else (CCS & Alerts) */
4510 else
4511 {
4512 ssl->in_msglen = 0;
4513 }
4514
Hanno Becker1097b342018-08-15 14:09:41 +01004515 return( 0 );
4516}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004517
Hanno Beckere74d5562018-08-15 14:26:08 +01004518static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4519{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004520 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004521 return( 1 );
4522
4523 return( 0 );
4524}
4525
Hanno Becker5f066e72018-08-16 14:56:31 +01004526#if defined(MBEDTLS_SSL_PROTO_DTLS)
4527
4528static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4529{
4530 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4531 if( hs == NULL )
4532 return;
4533
Hanno Becker01315ea2018-08-21 17:22:17 +01004534 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004535 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004536 hs->buffering.total_bytes_buffered -=
4537 hs->buffering.future_record.len;
4538
4539 mbedtls_free( hs->buffering.future_record.data );
4540 hs->buffering.future_record.data = NULL;
4541 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004542}
4543
4544static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4545{
4546 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4547 unsigned char * rec;
4548 size_t rec_len;
4549 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004550#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4551 size_t in_buf_len = ssl->in_buf_len;
4552#else
4553 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4554#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004555 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4556 return( 0 );
4557
4558 if( hs == NULL )
4559 return( 0 );
4560
Hanno Becker5f066e72018-08-16 14:56:31 +01004561 rec = hs->buffering.future_record.data;
4562 rec_len = hs->buffering.future_record.len;
4563 rec_epoch = hs->buffering.future_record.epoch;
4564
4565 if( rec == NULL )
4566 return( 0 );
4567
Hanno Becker4cb782d2018-08-20 11:19:05 +01004568 /* Only consider loading future records if the
4569 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004570 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004571 return( 0 );
4572
Hanno Becker5f066e72018-08-16 14:56:31 +01004573 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4574
4575 if( rec_epoch != ssl->in_epoch )
4576 {
4577 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4578 goto exit;
4579 }
4580
4581 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4582
4583 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004584 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004585 {
4586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4587 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4588 }
4589
4590 memcpy( ssl->in_hdr, rec, rec_len );
4591 ssl->in_left = rec_len;
4592 ssl->next_record_offset = 0;
4593
4594 ssl_free_buffered_record( ssl );
4595
4596exit:
4597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4598 return( 0 );
4599}
4600
Hanno Becker519f15d2019-07-11 12:43:20 +01004601static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4602 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004603{
4604 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004605
4606 /* Don't buffer future records outside handshakes. */
4607 if( hs == NULL )
4608 return( 0 );
4609
4610 /* Only buffer handshake records (we are only interested
4611 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004612 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004613 return( 0 );
4614
4615 /* Don't buffer more than one future epoch record. */
4616 if( hs->buffering.future_record.data != NULL )
4617 return( 0 );
4618
Hanno Becker01315ea2018-08-21 17:22:17 +01004619 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004620 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004621 hs->buffering.total_bytes_buffered ) )
4622 {
4623 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering of future epoch record of size %u would exceed the compile-time limit %u (already %u bytes buffered) -- ignore\n",
Hanno Becker519f15d2019-07-11 12:43:20 +01004624 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004625 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004626 return( 0 );
4627 }
4628
Hanno Becker5f066e72018-08-16 14:56:31 +01004629 /* Buffer record */
4630 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4631 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004632 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004633
4634 /* ssl_parse_record_header() only considers records
4635 * of the next epoch as candidates for buffering. */
4636 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004637 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004638
4639 hs->buffering.future_record.data =
4640 mbedtls_calloc( 1, hs->buffering.future_record.len );
4641 if( hs->buffering.future_record.data == NULL )
4642 {
4643 /* If we run out of RAM trying to buffer a
4644 * record from the next epoch, just ignore. */
4645 return( 0 );
4646 }
4647
Hanno Becker519f15d2019-07-11 12:43:20 +01004648 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004649
Hanno Becker519f15d2019-07-11 12:43:20 +01004650 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004651 return( 0 );
4652}
4653
4654#endif /* MBEDTLS_SSL_PROTO_DTLS */
4655
Hanno Beckere74d5562018-08-15 14:26:08 +01004656static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004657{
Janos Follath865b3eb2019-12-16 11:46:15 +00004658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004659 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004660
Hanno Becker5f066e72018-08-16 14:56:31 +01004661#if defined(MBEDTLS_SSL_PROTO_DTLS)
4662 /* We might have buffered a future record; if so,
4663 * and if the epoch matches now, load it.
4664 * On success, this call will set ssl->in_left to
4665 * the length of the buffered record, so that
4666 * the calls to ssl_fetch_input() below will
4667 * essentially be no-ops. */
4668 ret = ssl_load_buffered_record( ssl );
4669 if( ret != 0 )
4670 return( ret );
4671#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004672
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004673 /* Ensure that we have enough space available for the default form
4674 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4675 * with no space for CIDs counted in). */
4676 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4677 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004679 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004680 return( ret );
4681 }
4682
Hanno Beckere5e7e782019-07-11 12:29:35 +01004683 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4684 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004687 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004688 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004689 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4690 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004691 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004692 if( ret != 0 )
4693 return( ret );
4694
4695 /* Fall through to handling of unexpected records */
4696 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4697 }
4698
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004699 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4700 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004701#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004702 /* Reset in pointers to default state for TLS/DTLS records,
4703 * assuming no CID and no offset between record content and
4704 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004705 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004706
Hanno Becker7ae20e02019-07-12 08:33:49 +01004707 /* Setup internal message pointers from record structure. */
4708 ssl->in_msgtype = rec.type;
4709#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4710 ssl->in_len = ssl->in_cid + rec.cid_len;
4711#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4712 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4713 ssl->in_msglen = rec.data_len;
4714
Hanno Becker2fddd372019-07-10 14:37:41 +01004715 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004716 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004717 if( ret != 0 )
4718 return( ret );
4719#endif
4720
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004721 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004722 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004723
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004724 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4725 "(header)" ) );
4726 }
4727 else
4728 {
4729 /* Skip invalid record and the rest of the datagram */
4730 ssl->next_record_offset = 0;
4731 ssl->in_left = 0;
4732
4733 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4734 "(header)" ) );
4735 }
4736
4737 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004738 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004739 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004740 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004741#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004742 {
4743 return( ret );
4744 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004745 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004748 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004749 {
Hanno Beckera8814792019-07-10 15:01:45 +01004750 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004751 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004752 if( ssl->next_record_offset < ssl->in_left )
4753 {
4754 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4755 }
4756 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004757 else
4758#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004759 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004760 /*
4761 * Fetch record contents from underlying transport.
4762 */
Hanno Beckera3175662019-07-11 12:50:29 +01004763 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004764 if( ret != 0 )
4765 {
4766 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4767 return( ret );
4768 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004769
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004770 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004771 }
4772
4773 /*
4774 * Decrypt record contents.
4775 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004776
Hanno Beckerfdf66042019-07-11 13:07:45 +01004777 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004778 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004780 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004781 {
4782 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004783 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004784 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004785 /* Except when waiting for Finished as a bad mac here
4786 * probably means something went wrong in the handshake
4787 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4788 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4789 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4790 {
4791#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4792 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4793 {
4794 mbedtls_ssl_send_alert_message( ssl,
4795 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4796 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4797 }
4798#endif
4799 return( ret );
4800 }
4801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004803 if( ssl->conf->badmac_limit != 0 &&
4804 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4807 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004808 }
4809#endif
4810
Hanno Becker4a810fb2017-05-24 16:27:30 +01004811 /* As above, invalid records cause
4812 * dismissal of the whole datagram. */
4813
4814 ssl->next_record_offset = 0;
4815 ssl->in_left = 0;
4816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004818 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004819 }
4820
4821 return( ret );
4822 }
4823 else
4824#endif
4825 {
4826 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004827#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4828 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004829 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004830 mbedtls_ssl_send_alert_message( ssl,
4831 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4832 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004833 }
4834#endif
4835 return( ret );
4836 }
4837 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004838
Hanno Becker44d89b22019-07-12 09:40:44 +01004839
4840 /* Reset in pointers to default state for TLS/DTLS records,
4841 * assuming no CID and no offset between record content and
4842 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004843 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004844#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4845 ssl->in_len = ssl->in_cid + rec.cid_len;
4846#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004847 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004848
Hanno Becker8685c822019-07-12 09:37:30 +01004849 /* The record content type may change during decryption,
4850 * so re-read it. */
4851 ssl->in_msgtype = rec.type;
4852 /* Also update the input buffer, because unfortunately
4853 * the server-side ssl_parse_client_hello() reparses the
4854 * record header when receiving a ClientHello initiating
4855 * a renegotiation. */
4856 ssl->in_hdr[0] = rec.type;
4857 ssl->in_msg = rec.buf + rec.data_offset;
4858 ssl->in_msglen = rec.data_len;
4859 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4860 ssl->in_len[1] = (unsigned char)( rec.data_len );
4861
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004862#if defined(MBEDTLS_ZLIB_SUPPORT)
4863 if( ssl->transform_in != NULL &&
4864 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4865 {
4866 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4867 {
4868 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4869 return( ret );
4870 }
4871
4872 /* Check actual (decompress) record content length against
4873 * configured maximum. */
4874 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4875 {
4876 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4877 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4878 }
4879 }
4880#endif /* MBEDTLS_ZLIB_SUPPORT */
4881
Simon Butcher99000142016-10-13 17:21:01 +01004882 return( 0 );
4883}
4884
4885int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4886{
Janos Follath865b3eb2019-12-16 11:46:15 +00004887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004888
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004889 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004890 * Handle particular types of records
4891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004892 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004893 {
Simon Butcher99000142016-10-13 17:21:01 +01004894 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4895 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004896 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004897 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004898 }
4899
Hanno Beckere678eaa2018-08-21 14:57:46 +01004900 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004901 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004902 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004903 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004904 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4905 ssl->in_msglen ) );
4906 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004907 }
4908
Hanno Beckere678eaa2018-08-21 14:57:46 +01004909 if( ssl->in_msg[0] != 1 )
4910 {
4911 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4912 ssl->in_msg[0] ) );
4913 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4914 }
4915
4916#if defined(MBEDTLS_SSL_PROTO_DTLS)
4917 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4918 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4919 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4920 {
4921 if( ssl->handshake == NULL )
4922 {
4923 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4924 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4925 }
4926
4927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4928 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4929 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004930#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004931 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004934 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004935 if( ssl->in_msglen != 2 )
4936 {
4937 /* Note: Standard allows for more than one 2 byte alert
4938 to be packed in a single message, but Mbed TLS doesn't
4939 currently support this. */
4940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4941 ssl->in_msglen ) );
4942 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4943 }
4944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004946 ssl->in_msg[0], ssl->in_msg[1] ) );
4947
4948 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004949 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004952 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004954 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004956 }
4957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004958 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4959 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004960 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4962 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004963 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004964
4965#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4966 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4967 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4968 {
Hanno Becker90333da2017-10-10 11:27:13 +01004969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004970 /* Will be handled when trying to parse ServerHello */
4971 return( 0 );
4972 }
4973#endif
4974
4975#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4976 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4977 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4978 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4979 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4980 {
4981 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4982 /* Will be handled in mbedtls_ssl_parse_certificate() */
4983 return( 0 );
4984 }
4985#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4986
4987 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004988 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004989 }
4990
Hanno Beckerc76c6192017-06-06 10:03:17 +01004991#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004992 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004993 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004994 /* Drop unexpected ApplicationData records,
4995 * except at the beginning of renegotiations */
4996 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4997 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4998#if defined(MBEDTLS_SSL_RENEGOTIATION)
4999 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5000 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01005001#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01005002 )
5003 {
5004 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
5005 return( MBEDTLS_ERR_SSL_NON_FATAL );
5006 }
5007
5008 if( ssl->handshake != NULL &&
5009 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
5010 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005011 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01005012 }
5013 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005014#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005015
Paul Bakker5121ce52009-01-03 21:22:43 +00005016 return( 0 );
5017}
5018
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005019int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005020{
irwir6c0da642019-09-26 21:07:41 +03005021 return( mbedtls_ssl_send_alert_message( ssl,
5022 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5023 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005024}
5025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005026int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00005027 unsigned char level,
5028 unsigned char message )
5029{
Janos Follath865b3eb2019-12-16 11:46:15 +00005030 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005031
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005032 if( ssl == NULL || ssl->conf == NULL )
5033 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005036 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00005037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005038 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005039 ssl->out_msglen = 2;
5040 ssl->out_msg[0] = level;
5041 ssl->out_msg[1] = message;
5042
Hanno Becker67bc7c32018-08-06 11:33:50 +01005043 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00005044 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005045 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00005046 return( ret );
5047 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00005049
5050 return( 0 );
5051}
5052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005053int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005054{
Janos Follath865b3eb2019-12-16 11:46:15 +00005055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005056
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005057 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005059 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005060 ssl->out_msglen = 1;
5061 ssl->out_msg[0] = 1;
5062
Paul Bakker5121ce52009-01-03 21:22:43 +00005063 ssl->state++;
5064
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005065 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005066 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02005067 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005068 return( ret );
5069 }
5070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005072
5073 return( 0 );
5074}
5075
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005076int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005077{
Janos Follath865b3eb2019-12-16 11:46:15 +00005078 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005081
Hanno Becker327c93b2018-08-15 13:56:18 +01005082 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005083 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005084 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005085 return( ret );
5086 }
5087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005089 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005091 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5092 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005093 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005094 }
5095
Hanno Beckere678eaa2018-08-21 14:57:46 +01005096 /* CCS records are only accepted if they have length 1 and content '1',
5097 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005098
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005099 /*
5100 * Switch to our negotiated transform and session parameters for inbound
5101 * data.
5102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005104 ssl->transform_in = ssl->transform_negotiate;
5105 ssl->session_in = ssl->session_negotiate;
5106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005108 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005109 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005111 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005112#endif
5113
5114 /* Increment epoch */
5115 if( ++ssl->in_epoch == 0 )
5116 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005117 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005118 /* This is highly unlikely to happen for legitimate reasons, so
5119 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005120 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005121 }
5122 }
5123 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005124#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005125 memset( ssl->in_ctr, 0, 8 );
5126
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005127 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005129#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5130 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005131 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005133 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005134 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005135 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5136 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005138 }
5139 }
5140#endif
5141
Paul Bakker5121ce52009-01-03 21:22:43 +00005142 ssl->state++;
5143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005144 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005145
5146 return( 0 );
5147}
5148
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005149/* Once ssl->out_hdr as the address of the beginning of the
5150 * next outgoing record is set, deduce the other pointers.
5151 *
5152 * Note: For TLS, we save the implicit record sequence number
5153 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5154 * and the caller has to make sure there's space for this.
5155 */
5156
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005157static size_t ssl_transform_get_explicit_iv_len(
5158 mbedtls_ssl_transform const *transform )
5159{
5160 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5161 return( 0 );
5162
5163 return( transform->ivlen - transform->fixed_ivlen );
5164}
5165
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005166void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5167 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005168{
5169#if defined(MBEDTLS_SSL_PROTO_DTLS)
5170 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5171 {
5172 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005173#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005174 ssl->out_cid = ssl->out_ctr + 8;
5175 ssl->out_len = ssl->out_cid;
5176 if( transform != NULL )
5177 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005178#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005179 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005180#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005181 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005182 }
5183 else
5184#endif
5185 {
5186 ssl->out_ctr = ssl->out_hdr - 8;
5187 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005188#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005189 ssl->out_cid = ssl->out_len;
5190#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005191 ssl->out_iv = ssl->out_hdr + 5;
5192 }
5193
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005194 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005195 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005196 if( transform != NULL )
5197 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005198}
5199
5200/* Once ssl->in_hdr as the address of the beginning of the
5201 * next incoming record is set, deduce the other pointers.
5202 *
5203 * Note: For TLS, we save the implicit record sequence number
5204 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5205 * and the caller has to make sure there's space for this.
5206 */
5207
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005208void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005209{
Hanno Becker79594fd2019-05-08 09:38:41 +01005210 /* This function sets the pointers to match the case
5211 * of unprotected TLS/DTLS records, with both ssl->in_iv
5212 * and ssl->in_msg pointing to the beginning of the record
5213 * content.
5214 *
5215 * When decrypting a protected record, ssl->in_msg
5216 * will be shifted to point to the beginning of the
5217 * record plaintext.
5218 */
5219
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005220#if defined(MBEDTLS_SSL_PROTO_DTLS)
5221 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5222 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005223 /* This sets the header pointers to match records
5224 * without CID. When we receive a record containing
5225 * a CID, the fields are shifted accordingly in
5226 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005227 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005228#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005229 ssl->in_cid = ssl->in_ctr + 8;
5230 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005231#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005232 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005233#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005234 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005235 }
5236 else
5237#endif
5238 {
5239 ssl->in_ctr = ssl->in_hdr - 8;
5240 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005241#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005242 ssl->in_cid = ssl->in_len;
5243#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005244 ssl->in_iv = ssl->in_hdr + 5;
5245 }
5246
Hanno Becker79594fd2019-05-08 09:38:41 +01005247 /* This will be adjusted at record decryption time. */
5248 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005249}
5250
Paul Bakker5121ce52009-01-03 21:22:43 +00005251/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005252 * Setup an SSL context
5253 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005254
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005255void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005256{
5257 /* Set the incoming and outgoing record pointers. */
5258#if defined(MBEDTLS_SSL_PROTO_DTLS)
5259 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5260 {
5261 ssl->out_hdr = ssl->out_buf;
5262 ssl->in_hdr = ssl->in_buf;
5263 }
5264 else
5265#endif /* MBEDTLS_SSL_PROTO_DTLS */
5266 {
5267 ssl->out_hdr = ssl->out_buf + 8;
5268 ssl->in_hdr = ssl->in_buf + 8;
5269 }
5270
5271 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005272 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5273 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005274}
5275
Paul Bakker5121ce52009-01-03 21:22:43 +00005276/*
5277 * SSL get accessors
5278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005280{
5281 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5282}
5283
Hanno Becker8b170a02017-10-10 11:51:19 +01005284int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5285{
5286 /*
5287 * Case A: We're currently holding back
5288 * a message for further processing.
5289 */
5290
5291 if( ssl->keep_current_message == 1 )
5292 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005293 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005294 return( 1 );
5295 }
5296
5297 /*
5298 * Case B: Further records are pending in the current datagram.
5299 */
5300
5301#if defined(MBEDTLS_SSL_PROTO_DTLS)
5302 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5303 ssl->in_left > ssl->next_record_offset )
5304 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005305 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005306 return( 1 );
5307 }
5308#endif /* MBEDTLS_SSL_PROTO_DTLS */
5309
5310 /*
5311 * Case C: A handshake message is being processed.
5312 */
5313
Hanno Becker8b170a02017-10-10 11:51:19 +01005314 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5315 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005316 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005317 return( 1 );
5318 }
5319
5320 /*
5321 * Case D: An application data message is being processed
5322 */
5323 if( ssl->in_offt != NULL )
5324 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005325 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005326 return( 1 );
5327 }
5328
5329 /*
5330 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005331 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005332 * we implement support for multiple alerts in single records.
5333 */
5334
5335 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5336 return( 0 );
5337}
5338
Paul Bakker43ca69c2011-01-15 17:35:19 +00005339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005340int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005341{
Hanno Becker3136ede2018-08-17 15:28:19 +01005342 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005344 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005345
Hanno Becker5903de42019-05-03 14:46:38 +01005346 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5347
Hanno Becker78640902018-08-13 16:35:15 +01005348 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005349 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005351#if defined(MBEDTLS_ZLIB_SUPPORT)
5352 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5353 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005354#endif
5355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005357 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005358 case MBEDTLS_MODE_GCM:
5359 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005360 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005362 transform_expansion = transform->minlen;
5363 break;
5364
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005365 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005366
5367 block_size = mbedtls_cipher_get_block_size(
5368 &transform->cipher_ctx_enc );
5369
Hanno Becker3136ede2018-08-17 15:28:19 +01005370 /* Expansion due to the addition of the MAC. */
5371 transform_expansion += transform->maclen;
5372
5373 /* Expansion due to the addition of CBC padding;
5374 * Theoretically up to 256 bytes, but we never use
5375 * more than the block size of the underlying cipher. */
5376 transform_expansion += block_size;
5377
5378 /* For TLS 1.1 or higher, an explicit IV is added
5379 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005380#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5381 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005382 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005383#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005384
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005385 break;
5386
5387 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005389 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005390 }
5391
Hanno Beckera0e20d02019-05-15 14:03:01 +01005392#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005393 if( transform->out_cid_len != 0 )
5394 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005395#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005396
Hanno Becker5903de42019-05-03 14:46:38 +01005397 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005398}
5399
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005400#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005401/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005402 * Check record counters and renegotiate if they're above the limit.
5403 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005404static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005405{
Hanno Beckerdd772292020-02-05 10:38:31 +00005406 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005407 int in_ctr_cmp;
5408 int out_ctr_cmp;
5409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5411 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005412 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005413 {
5414 return( 0 );
5415 }
5416
Andres AG2196c7f2016-12-15 17:01:16 +00005417 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5418 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005419 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005420 ssl->conf->renego_period + ep_len, 8 - ep_len );
5421
5422 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005423 {
5424 return( 0 );
5425 }
5426
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005428 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005429}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005431
5432/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005433 * Receive application data decrypted from the SSL layer
5434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005436{
Janos Follath865b3eb2019-12-16 11:46:15 +00005437 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005438 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005439
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005440 if( ssl == NULL || ssl->conf == NULL )
5441 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005443 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005444
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005446 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005447 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005449 return( ret );
5450
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005451 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005452 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005453 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005454 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005455 return( ret );
5456 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005457 }
5458#endif
5459
Hanno Becker4a810fb2017-05-24 16:27:30 +01005460 /*
5461 * Check if renegotiation is necessary and/or handshake is
5462 * in process. If yes, perform/continue, and fall through
5463 * if an unexpected packet is received while the client
5464 * is waiting for the ServerHello.
5465 *
5466 * (There is no equivalent to the last condition on
5467 * the server-side as it is not treated as within
5468 * a handshake while waiting for the ClientHello
5469 * after a renegotiation request.)
5470 */
5471
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005473 ret = ssl_check_ctr_renegotiate( ssl );
5474 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5475 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005476 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005477 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005478 return( ret );
5479 }
5480#endif
5481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005482 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005484 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005485 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5486 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005487 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005489 return( ret );
5490 }
5491 }
5492
Hanno Beckere41158b2017-10-23 13:30:32 +01005493 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005494 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005495 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005496 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005497 if( ssl->f_get_timer != NULL &&
5498 ssl->f_get_timer( ssl->p_timer ) == -1 )
5499 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005500 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005501 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005502
Hanno Becker327c93b2018-08-15 13:56:18 +01005503 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005504 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005505 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5506 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005507
Hanno Becker4a810fb2017-05-24 16:27:30 +01005508 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5509 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005510 }
5511
5512 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005514 {
5515 /*
5516 * OpenSSL sends empty messages to randomize the IV
5517 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005518 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005520 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005521 return( 0 );
5522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005523 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005524 return( ret );
5525 }
5526 }
5527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005529 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005531
Hanno Becker4a810fb2017-05-24 16:27:30 +01005532 /*
5533 * - For client-side, expect SERVER_HELLO_REQUEST.
5534 * - For server-side, expect CLIENT_HELLO.
5535 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5536 */
5537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005539 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005541 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005544
5545 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005547 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005548 {
5549 continue;
5550 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005551#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005552 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005553 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005554#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005555
Hanno Becker4a810fb2017-05-24 16:27:30 +01005556#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005557 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005558 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005559 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005561
5562 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005564 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005565 {
5566 continue;
5567 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005568#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005569 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005570 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005571#endif /* MBEDTLS_SSL_SRV_C */
5572
Hanno Becker21df7f92017-10-17 11:03:26 +01005573#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005574 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005575 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5576 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5577 ssl->conf->allow_legacy_renegotiation ==
5578 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5579 {
5580 /*
5581 * Accept renegotiation request
5582 */
Paul Bakker48916f92012-09-16 19:57:18 +00005583
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005584 /* DTLS clients need to know renego is server-initiated */
5585#if defined(MBEDTLS_SSL_PROTO_DTLS)
5586 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5587 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5588 {
5589 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5590 }
5591#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005592 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005593 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5594 ret != 0 )
5595 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005596 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5597 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005598 return( ret );
5599 }
5600 }
5601 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005602#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005603 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005604 /*
5605 * Refuse renegotiation
5606 */
5607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005608 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005610#if defined(MBEDTLS_SSL_PROTO_SSL3)
5611 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005612 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005613 /* SSLv3 does not have a "no_renegotiation" warning, so
5614 we send a fatal alert and abort the connection. */
5615 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5616 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5617 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005618 }
5619 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5621#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5622 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5623 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005624 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5626 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5627 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005628 {
5629 return( ret );
5630 }
Paul Bakker48916f92012-09-16 19:57:18 +00005631 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005632 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005633#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5634 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005635 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5637 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005638 }
Paul Bakker48916f92012-09-16 19:57:18 +00005639 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005640
Hanno Becker90333da2017-10-10 11:27:13 +01005641 /* At this point, we don't know whether the renegotiation has been
5642 * completed or not. The cases to consider are the following:
5643 * 1) The renegotiation is complete. In this case, no new record
5644 * has been read yet.
5645 * 2) The renegotiation is incomplete because the client received
5646 * an application data record while awaiting the ServerHello.
5647 * 3) The renegotiation is incomplete because the client received
5648 * a non-handshake, non-application data message while awaiting
5649 * the ServerHello.
5650 * In each of these case, looping will be the proper action:
5651 * - For 1), the next iteration will read a new record and check
5652 * if it's application data.
5653 * - For 2), the loop condition isn't satisfied as application data
5654 * is present, hence continue is the same as break
5655 * - For 3), the loop condition is satisfied and read_record
5656 * will re-deliver the message that was held back by the client
5657 * when expecting the ServerHello.
5658 */
5659 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005660 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005661#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005662 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005663 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005664 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005665 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005666 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005667 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005669 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005670 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005671 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005672 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005673 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005674#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005676 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5677 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005680 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005681 }
5682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5686 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005687 }
5688
5689 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005690
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005691 /* We're going to return something now, cancel timer,
5692 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005693 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005694 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005695
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005696#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005697 /* If we requested renego but received AppData, resend HelloRequest.
5698 * Do it now, after setting in_offt, to avoid taking this branch
5699 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005700#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005701 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005703 {
Hanno Becker786300f2020-02-05 10:46:40 +00005704 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005705 {
Hanno Becker786300f2020-02-05 10:46:40 +00005706 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5707 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005708 return( ret );
5709 }
5710 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005711#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005712#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005713 }
5714
5715 n = ( len < ssl->in_msglen )
5716 ? len : ssl->in_msglen;
5717
5718 memcpy( buf, ssl->in_offt, n );
5719 ssl->in_msglen -= n;
5720
gabor-mezei-arma3214132020-07-15 10:55:00 +02005721 /* Zeroising the plaintext buffer to erase unused application data
5722 from the memory. */
5723 mbedtls_platform_zeroize( ssl->in_offt, n );
5724
Paul Bakker5121ce52009-01-03 21:22:43 +00005725 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005726 {
5727 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005728 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005729 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005730 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005731 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005732 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005733 /* more data available */
5734 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005735 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005738
Paul Bakker23986e52011-04-24 08:57:21 +00005739 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005740}
5741
5742/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005743 * Send application data to be encrypted by the SSL layer, taking care of max
5744 * fragment length and buffer size.
5745 *
5746 * According to RFC 5246 Section 6.2.1:
5747 *
5748 * Zero-length fragments of Application data MAY be sent as they are
5749 * potentially useful as a traffic analysis countermeasure.
5750 *
5751 * Therefore, it is possible that the input message length is 0 and the
5752 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005753 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005754static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005755 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005756{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005757 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5758 const size_t max_len = (size_t) ret;
5759
5760 if( ret < 0 )
5761 {
5762 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5763 return( ret );
5764 }
5765
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005766 if( len > max_len )
5767 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005769 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005770 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005772 "maximum fragment length: %d > %d",
5773 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005775 }
5776 else
5777#endif
5778 len = max_len;
5779 }
Paul Bakker887bd502011-06-08 13:10:54 +00005780
Paul Bakker5121ce52009-01-03 21:22:43 +00005781 if( ssl->out_left != 0 )
5782 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005783 /*
5784 * The user has previously tried to send the data and
5785 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5786 * written. In this case, we expect the high-level write function
5787 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5788 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005789 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005790 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005792 return( ret );
5793 }
5794 }
Paul Bakker887bd502011-06-08 13:10:54 +00005795 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005796 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005797 /*
5798 * The user is trying to send a message the first time, so we need to
5799 * copy the data into the internal buffers and setup the data structure
5800 * to keep track of partial writes
5801 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005802 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005803 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005804 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005805
Hanno Becker67bc7c32018-08-06 11:33:50 +01005806 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005808 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005809 return( ret );
5810 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005811 }
5812
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005813 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005814}
5815
5816/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005817 * Write application data, doing 1/n-1 splitting if necessary.
5818 *
5819 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005820 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005821 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005824static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005825 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005826{
Janos Follath865b3eb2019-12-16 11:46:15 +00005827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005828
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005829 if( ssl->conf->cbc_record_splitting ==
5830 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005831 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005832 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5833 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5834 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005835 {
5836 return( ssl_write_real( ssl, buf, len ) );
5837 }
5838
5839 if( ssl->split_done == 0 )
5840 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005841 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005842 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005843 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005844 }
5845
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005846 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5847 return( ret );
5848 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005849
5850 return( ret + 1 );
5851}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005852#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005853
5854/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005855 * Write application data (public-facing wrapper)
5856 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005857int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005858{
Janos Follath865b3eb2019-12-16 11:46:15 +00005859 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005860
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005862
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005863 if( ssl == NULL || ssl->conf == NULL )
5864 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5865
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005866#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005867 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5868 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005869 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005870 return( ret );
5871 }
5872#endif
5873
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005874 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005875 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005876 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005877 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005878 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879 return( ret );
5880 }
5881 }
5882
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005883#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005884 ret = ssl_write_split( ssl, buf, len );
5885#else
5886 ret = ssl_write_real( ssl, buf, len );
5887#endif
5888
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005890
5891 return( ret );
5892}
5893
5894/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005895 * Notify the peer that the connection is being closed
5896 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005897int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005898{
Janos Follath865b3eb2019-12-16 11:46:15 +00005899 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005900
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005901 if( ssl == NULL || ssl->conf == NULL )
5902 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005905
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005906 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005907 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005910 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005911 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5912 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5913 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005915 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005916 return( ret );
5917 }
5918 }
5919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005921
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005922 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005923}
5924
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005925void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005926{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005927 if( transform == NULL )
5928 return;
5929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005930#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005931 deflateEnd( &transform->ctx_deflate );
5932 inflateEnd( &transform->ctx_inflate );
5933#endif
5934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005935 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5936 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005937
Hanno Beckerd56ed242018-01-03 15:32:51 +00005938#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005939 mbedtls_md_free( &transform->md_ctx_enc );
5940 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005941#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005942
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005943 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005944}
5945
Hanno Becker0271f962018-08-16 13:23:47 +01005946#if defined(MBEDTLS_SSL_PROTO_DTLS)
5947
Hanno Becker533ab5f2020-02-05 10:49:13 +00005948void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005949{
5950 unsigned offset;
5951 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5952
5953 if( hs == NULL )
5954 return;
5955
Hanno Becker283f5ef2018-08-24 09:34:47 +01005956 ssl_free_buffered_record( ssl );
5957
Hanno Becker0271f962018-08-16 13:23:47 +01005958 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005959 ssl_buffering_free_slot( ssl, offset );
5960}
5961
5962static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5963 uint8_t slot )
5964{
5965 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5966 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005967
5968 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5969 return;
5970
Hanno Beckere605b192018-08-21 15:59:07 +01005971 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005972 {
Hanno Beckere605b192018-08-21 15:59:07 +01005973 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005974 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005975 mbedtls_free( hs_buf->data );
5976 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005977 }
5978}
5979
5980#endif /* MBEDTLS_SSL_PROTO_DTLS */
5981
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005982/*
5983 * Convert version numbers to/from wire format
5984 * and, for DTLS, to/from TLS equivalent.
5985 *
5986 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005987 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005988 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5989 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005991void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005992 unsigned char ver[2] )
5993{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005994#if defined(MBEDTLS_SSL_PROTO_DTLS)
5995 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005997 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005998 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5999
6000 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
6001 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
6002 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006003 else
6004#else
6005 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006006#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006007 {
6008 ver[0] = (unsigned char) major;
6009 ver[1] = (unsigned char) minor;
6010 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006011}
6012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006013void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006014 const unsigned char ver[2] )
6015{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006016#if defined(MBEDTLS_SSL_PROTO_DTLS)
6017 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006018 {
6019 *major = 255 - ver[0] + 2;
6020 *minor = 255 - ver[1] + 1;
6021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006022 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006023 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
6024 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006025 else
6026#else
6027 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006028#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006029 {
6030 *major = ver[0];
6031 *minor = ver[1];
6032 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006033}
6034
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006035#endif /* MBEDTLS_SSL_TLS_C */