blob: 9b4d1dbc7a498347be89812538fd546a8a228ad0 [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 *
Hanno Beckerf1a38282020-02-05 16:14:29 +00005 * Copyright (C) 2006-2020, ARM Limited, All Rights Reserved
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 Bakkerb96f1542010-07-18 20:36:00 +000019 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000020 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000021 */
22/*
23 * The SSL 3.0 specification was drafted by Netscape in 1996,
24 * and became an IETF standard in 1999.
25 *
26 * http://wp.netscape.com/eng/ssl3/
27 * http://www.ietf.org/rfc/rfc2246.txt
28 * http://www.ietf.org/rfc/rfc4346.txt
29 */
30
Gilles Peskinedb09ef62020-06-03 01:43:33 +020031#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000034
SimonBd5800b72016-04-26 07:43:27 +010035#if defined(MBEDTLS_PLATFORM_C)
36#include "mbedtls/platform.h"
37#else
38#include <stdlib.h>
39#define mbedtls_calloc calloc
40#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010041#endif
42
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000043#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020044#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000045#include "mbedtls/debug.h"
46#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050047#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010048#include "mbedtls/version.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020049
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020050#include "ssl_invasive.h"
51
Rich Evans00ab4702015-02-06 13:43:58 +000052#include <string.h>
53
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050054#if defined(MBEDTLS_USE_PSA_CRYPTO)
55#include "mbedtls/psa_util.h"
56#include "psa/crypto.h"
57#endif
58
Janos Follath23bdca02016-10-07 14:47:14 +010059#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000060#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020061#endif
62
Hanno Beckercd9dcda2018-08-28 17:18:56 +010063static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010064
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020065/*
66 * Start a timer.
67 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068 */
Hanno Becker0f57a652020-02-05 10:37:26 +000069void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020071 if( ssl->f_set_timer == NULL )
72 return;
73
74 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
75 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020076}
77
78/*
79 * Return -1 is timer is expired, 0 if it isn't.
80 */
Hanno Becker7876d122020-02-05 10:39:31 +000081int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020082{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020083 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020084 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020085
86 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020087 {
88 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020090 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020091
92 return( 0 );
93}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020094
Hanno Beckercfe45792019-07-03 16:13:00 +010095#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010096static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
97 unsigned char *buf,
98 size_t len,
99 mbedtls_record *rec );
100
Hanno Beckercfe45792019-07-03 16:13:00 +0100101int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
102 unsigned char *buf,
103 size_t buflen )
104{
Hanno Becker54229812019-07-12 14:40:00 +0100105 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
107 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
108
109 /* We don't support record checking in TLS because
110 * (a) there doesn't seem to be a usecase for it, and
111 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
112 * and we'd need to backup the transform here.
113 */
114 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
115 {
116 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
117 goto exit;
118 }
119#if defined(MBEDTLS_SSL_PROTO_DTLS)
120 else
121 {
irwir734f0cf2019-09-26 21:03:24 +0300122 mbedtls_record rec;
123
Hanno Becker54229812019-07-12 14:40:00 +0100124 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
125 if( ret != 0 )
126 {
127 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
128 goto exit;
129 }
130
131 if( ssl->transform_in != NULL )
132 {
133 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
134 if( ret != 0 )
135 {
136 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
137 goto exit;
138 }
139 }
140 }
141#endif /* MBEDTLS_SSL_PROTO_DTLS */
142
143exit:
144 /* On success, we have decrypted the buffer in-place, so make
145 * sure we don't leak any plaintext data. */
146 mbedtls_platform_zeroize( buf, buflen );
147
148 /* For the purpose of this API, treat messages with unexpected CID
149 * as well as such from future epochs as unexpected. */
150 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
151 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
152 {
153 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
154 }
155
156 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
157 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100158}
159#endif /* MBEDTLS_SSL_RECORD_CHECKING */
160
Hanno Becker67bc7c32018-08-06 11:33:50 +0100161#define SSL_DONT_FORCE_FLUSH 0
162#define SSL_FORCE_FLUSH 1
163
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200164#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100165
Hanno Beckerd5847772018-08-28 10:09:23 +0100166/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100167static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
168 uint8_t slot );
169static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
170static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
171static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
172static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100173static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
174 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100175static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100176
Hanno Becker11682cc2018-08-22 14:41:02 +0100177static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100178{
Hanno Becker89490712020-02-05 10:50:12 +0000179 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000180#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
181 size_t out_buf_len = ssl->out_buf_len;
182#else
183 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
184#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100185
Darryl Greenb33cc762019-11-28 14:29:44 +0000186 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100187 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188
Darryl Greenb33cc762019-11-28 14:29:44 +0000189 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100190}
191
Hanno Becker67bc7c32018-08-06 11:33:50 +0100192static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
193{
Hanno Becker11682cc2018-08-22 14:41:02 +0100194 size_t const bytes_written = ssl->out_left;
195 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100196
197 /* Double-check that the write-index hasn't gone
198 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100199 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100200 {
201 /* Should never happen... */
202 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
203 }
204
205 return( (int) ( mtu - bytes_written ) );
206}
207
208static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
209{
Janos Follath865b3eb2019-12-16 11:46:15 +0000210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400212 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100213
214#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400215 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100216
217 if( max_len > mfl )
218 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100219
220 /* By the standard (RFC 6066 Sect. 4), the MFL extension
221 * only limits the maximum record payload size, so in theory
222 * we would be allowed to pack multiple records of payload size
223 * MFL into a single datagram. However, this would mean that there's
224 * no way to explicitly communicate MTU restrictions to the peer.
225 *
226 * The following reduction of max_len makes sure that we never
227 * write datagrams larger than MFL + Record Expansion Overhead.
228 */
229 if( max_len <= ssl->out_left )
230 return( 0 );
231
232 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100233#endif
234
235 ret = ssl_get_remaining_space_in_datagram( ssl );
236 if( ret < 0 )
237 return( ret );
238 remaining = (size_t) ret;
239
240 ret = mbedtls_ssl_get_record_expansion( ssl );
241 if( ret < 0 )
242 return( ret );
243 expansion = (size_t) ret;
244
245 if( remaining <= expansion )
246 return( 0 );
247
248 remaining -= expansion;
249 if( remaining >= max_len )
250 remaining = max_len;
251
252 return( (int) remaining );
253}
254
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200255/*
256 * Double the retransmit timeout value, within the allowed range,
257 * returning -1 if the maximum value has already been reached.
258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200260{
261 uint32_t new_timeout;
262
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200263 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200264 return( -1 );
265
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200266 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
267 * in the following way: after the initial transmission and a first
268 * retransmission, back off to a temporary estimated MTU of 508 bytes.
269 * This value is guaranteed to be deliverable (if not guaranteed to be
270 * delivered) of any compliant IPv4 (and IPv6) network, and should work
271 * on most non-IP stacks too. */
272 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400273 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200274 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400275 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
276 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200277
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200278 new_timeout = 2 * ssl->handshake->retransmit_timeout;
279
280 /* Avoid arithmetic overflow and range overflow */
281 if( new_timeout < ssl->handshake->retransmit_timeout ||
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 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200284 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285 }
286
287 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289 ssl->handshake->retransmit_timeout ) );
290
291 return( 0 );
292}
293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200295{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200296 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200298 ssl->handshake->retransmit_timeout ) );
299}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
303int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200304 const unsigned char *key_enc, const unsigned char *key_dec,
305 size_t keylen,
306 const unsigned char *iv_enc, const unsigned char *iv_dec,
307 size_t ivlen,
308 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200309 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
311int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
313int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
314int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
315#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000316
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200317/* The function below is only used in the Lucky 13 counter-measure in
Hanno Beckerb2ca87d2018-10-18 15:43:13 +0100318 * mbedtls_ssl_decrypt_buf(). These are the defines that guard the call site. */
Hanno Becker52344c22018-01-03 15:24:20 +0000319#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) && \
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200320 ( defined(MBEDTLS_SSL_PROTO_TLS1) || \
321 defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
322 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
323/* This function makes sure every byte in the memory region is accessed
324 * (in ascending addresses order) */
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +0200325static void ssl_read_memory( const unsigned char *p, size_t len )
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200326{
327 unsigned char acc = 0;
328 volatile unsigned char force;
329
330 for( ; len != 0; p++, len-- )
331 acc ^= *p;
332
333 force = acc;
334 (void) force;
335}
336#endif /* SSL_SOME_MODES_USE_MAC && ( TLS1 || TLS1_1 || TLS1_2 ) */
337
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100338/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000339 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200340 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000341
Hanno Beckerccc13d02020-05-04 12:30:04 +0100342#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
343 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100344
345static size_t ssl_compute_padding_length( size_t len,
346 size_t granularity )
347{
348 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
349}
350
Hanno Becker581bc1b2020-05-04 12:20:03 +0100351/* This functions transforms a (D)TLS plaintext fragment and a record content
352 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
353 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
354 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100355 *
356 * struct {
357 * opaque content[DTLSPlaintext.length];
358 * ContentType real_type;
359 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100360 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361 *
362 * Input:
363 * - `content`: The beginning of the buffer holding the
364 * plaintext to be wrapped.
365 * - `*content_size`: The length of the plaintext in Bytes.
366 * - `max_len`: The number of Bytes available starting from
367 * `content`. This must be `>= *content_size`.
368 * - `rec_type`: The desired record content type.
369 *
370 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100371 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
372 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100373 *
374 * Returns:
375 * - `0` on success.
376 * - A negative error code if `max_len` didn't offer enough space
377 * for the expansion.
378 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100379static int ssl_build_inner_plaintext( unsigned char *content,
380 size_t *content_size,
381 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100382 uint8_t rec_type,
383 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384{
385 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100386
387 /* Write real content type */
388 if( remaining == 0 )
389 return( -1 );
390 content[ len ] = rec_type;
391 len++;
392 remaining--;
393
394 if( remaining < pad )
395 return( -1 );
396 memset( content + len, 0, pad );
397 len += pad;
398 remaining -= pad;
399
400 *content_size = len;
401 return( 0 );
402}
403
Hanno Becker581bc1b2020-05-04 12:20:03 +0100404/* This function parses a (D)TLSInnerPlaintext structure.
405 * See ssl_build_inner_plaintext() for details. */
406static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100407 size_t *content_size,
408 uint8_t *rec_type )
409{
410 size_t remaining = *content_size;
411
412 /* Determine length of padding by skipping zeroes from the back. */
413 do
414 {
415 if( remaining == 0 )
416 return( -1 );
417 remaining--;
418 } while( content[ remaining ] == 0 );
419
420 *content_size = remaining;
421 *rec_type = content[ remaining ];
422
423 return( 0 );
424}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100425#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
426 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100427
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100428/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100429 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000430static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100431 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100432 mbedtls_record *rec,
433 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000434{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100435 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100436 *
437 * additional_data = seq_num + TLSCompressed.type +
438 * TLSCompressed.version + TLSCompressed.length;
439 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100440 * For the CID extension, this is extended as follows
441 * (quoting draft-ietf-tls-dtls-connection-id-05,
442 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100443 *
444 * additional_data = seq_num + DTLSPlaintext.type +
445 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100446 * cid +
447 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100448 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100449 *
450 * For TLS 1.3, the record sequence number is dropped from the AAD
451 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100452 */
453
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100454 unsigned char *cur = add_data;
455
456#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
457 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
458#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
459 {
460 ((void) minor_ver);
461 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
462 cur += sizeof( rec->ctr );
463 }
464
465 *cur = rec->type;
466 cur++;
467
468 memcpy( cur, rec->ver, sizeof( rec->ver ) );
469 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100470
Hanno Beckera0e20d02019-05-15 14:03:01 +0100471#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100472 if( rec->cid_len != 0 )
473 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100474 memcpy( cur, rec->cid, rec->cid_len );
475 cur += rec->cid_len;
476
477 *cur = rec->cid_len;
478 cur++;
479
480 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
481 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
482 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100483 }
484 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100485#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100486 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100487 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
488 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
489 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100490 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100491
492 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000493}
494
Hanno Becker9d062f92020-02-07 10:26:36 +0000495#if defined(MBEDTLS_SSL_PROTO_SSL3)
496
497#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
498
499/*
500 * SSLv3.0 MAC functions
501 */
502static void ssl_mac( mbedtls_md_context_t *md_ctx,
503 const unsigned char *secret,
504 const unsigned char *buf, size_t len,
505 const unsigned char *ctr, int type,
506 unsigned char out[SSL3_MAC_MAX_BYTES] )
507{
508 unsigned char header[11];
509 unsigned char padding[48];
510 int padlen;
511 int md_size = mbedtls_md_get_size( md_ctx->md_info );
512 int md_type = mbedtls_md_get_type( md_ctx->md_info );
513
514 /* Only MD5 and SHA-1 supported */
515 if( md_type == MBEDTLS_MD_MD5 )
516 padlen = 48;
517 else
518 padlen = 40;
519
520 memcpy( header, ctr, 8 );
521 header[ 8] = (unsigned char) type;
522 header[ 9] = (unsigned char)( len >> 8 );
523 header[10] = (unsigned char)( len );
524
525 memset( padding, 0x36, padlen );
526 mbedtls_md_starts( md_ctx );
527 mbedtls_md_update( md_ctx, secret, md_size );
528 mbedtls_md_update( md_ctx, padding, padlen );
529 mbedtls_md_update( md_ctx, header, 11 );
530 mbedtls_md_update( md_ctx, buf, len );
531 mbedtls_md_finish( md_ctx, out );
532
533 memset( padding, 0x5C, padlen );
534 mbedtls_md_starts( md_ctx );
535 mbedtls_md_update( md_ctx, secret, md_size );
536 mbedtls_md_update( md_ctx, padding, padlen );
537 mbedtls_md_update( md_ctx, out, md_size );
538 mbedtls_md_finish( md_ctx, out );
539}
540#endif /* MBEDTLS_SSL_PROTO_SSL3 */
541
Hanno Becker67a37db2020-05-28 16:27:07 +0100542#if defined(MBEDTLS_GCM_C) || \
543 defined(MBEDTLS_CCM_C) || \
544 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100545static int ssl_transform_aead_dynamic_iv_is_explicit(
546 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100547{
Hanno Becker17263802020-05-28 07:05:48 +0100548 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100549}
550
Hanno Becker17263802020-05-28 07:05:48 +0100551/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
552 *
553 * Concretely, this occurs in two variants:
554 *
555 * a) Fixed and dynamic IV lengths add up to total IV length, giving
556 * IV = fixed_iv || dynamic_iv
557 *
Hanno Becker15952812020-06-04 13:31:46 +0100558 * This variant is used in TLS 1.2 when used with GCM or CCM.
559 *
Hanno Becker17263802020-05-28 07:05:48 +0100560 * b) Fixed IV lengths matches total IV length, giving
561 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100562 *
563 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
564 *
565 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100566 *
567 * This function has the precondition that
568 *
569 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
570 *
571 * which has to be ensured by the caller. If this precondition
572 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100573 */
574static void ssl_build_record_nonce( unsigned char *dst_iv,
575 size_t dst_iv_len,
576 unsigned char const *fixed_iv,
577 size_t fixed_iv_len,
578 unsigned char const *dynamic_iv,
579 size_t dynamic_iv_len )
580{
581 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100582
583 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100584 memset( dst_iv, 0, dst_iv_len );
585 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100586
Hanno Becker17263802020-05-28 07:05:48 +0100587 dst_iv += dst_iv_len - dynamic_iv_len;
588 for( i = 0; i < dynamic_iv_len; i++ )
589 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100590}
Hanno Becker67a37db2020-05-28 16:27:07 +0100591#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100592
Hanno Beckera18d1322018-01-03 14:27:32 +0000593int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
594 mbedtls_ssl_transform *transform,
595 mbedtls_record *rec,
596 int (*f_rng)(void *, unsigned char *, size_t),
597 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000598{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100600 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000601 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100602 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100603 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000604 size_t post_avail;
605
606 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000607#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200608 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000609 ((void) ssl);
610#endif
611
612 /* The PRNG is used for dynamic IV generation that's used
613 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200614#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000615 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
616 ((void) f_rng);
617 ((void) p_rng);
618#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000621
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000622 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100623 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
625 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
626 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100627 if( rec == NULL
628 || rec->buf == NULL
629 || rec->buf_len < rec->data_offset
630 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100631#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100632 || rec->cid_len != 0
633#endif
634 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000635 {
636 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100638 }
639
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000640 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100641 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000643 data, rec->data_len );
644
645 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
646
647 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
648 {
649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
650 (unsigned) rec->data_len,
651 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
652 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
653 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100654
Hanno Becker92313402020-05-20 13:58:58 +0100655 /* The following two code paths implement the (D)TLSInnerPlaintext
656 * structure present in TLS 1.3 and DTLS 1.2 + CID.
657 *
658 * See ssl_build_inner_plaintext() for more information.
659 *
660 * Note that this changes `rec->data_len`, and hence
661 * `post_avail` needs to be recalculated afterwards.
662 *
663 * Note also that the two code paths cannot occur simultaneously
664 * since they apply to different versions of the protocol. There
665 * is hence no risk of double-addition of the inner plaintext.
666 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100667#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
668 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
669 {
Hanno Becker13996922020-05-28 16:15:19 +0100670 size_t padding =
671 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100672 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100673 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100674 &rec->data_len,
675 post_avail,
676 rec->type,
677 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100678 {
679 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
680 }
681
682 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
683 }
684#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
685
Hanno Beckera0e20d02019-05-15 14:03:01 +0100686#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100687 /*
688 * Add CID information
689 */
690 rec->cid_len = transform->out_cid_len;
691 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
692 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100693
694 if( rec->cid_len != 0 )
695 {
Hanno Becker13996922020-05-28 16:15:19 +0100696 size_t padding =
697 ssl_compute_padding_length( rec->data_len,
698 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100699 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100700 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100701 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100702 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100703 * Note that this changes `rec->data_len`, and hence
704 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100705 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100706 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100707 &rec->data_len,
708 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100709 rec->type,
710 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100711 {
712 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
713 }
714
715 rec->type = MBEDTLS_SSL_MSG_CID;
716 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100717#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100718
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100719 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
720
Paul Bakker5121ce52009-01-03 21:22:43 +0000721 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100722 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000723 */
Hanno Becker52344c22018-01-03 15:24:20 +0000724#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725 if( mode == MBEDTLS_MODE_STREAM ||
726 ( mode == MBEDTLS_MODE_CBC
727#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000728 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100729#endif
730 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000731 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000732 if( post_avail < transform->maclen )
733 {
734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
735 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
736 }
737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000739 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200740 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000741 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000742 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
743 data, rec->data_len, rec->ctr, rec->type, mac );
744 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200745 }
746 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200747#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
749 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000750 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200751 {
Hanno Becker992b6872017-11-09 18:57:39 +0000752 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
753
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100754 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
755 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000756
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100758 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000759 mbedtls_md_hmac_update( &transform->md_ctx_enc,
760 data, rec->data_len );
761 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
762 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
763
764 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200765 }
766 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200767#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200768 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
770 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200771 }
772
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000773 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
774 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200775
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000776 rec->data_len += transform->maclen;
777 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100778 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200779 }
Hanno Becker52344c22018-01-03 15:24:20 +0000780#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000781
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200782 /*
783 * Encrypt
784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
786 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000787 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000791 "including %d bytes of padding",
792 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000793
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000794 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
795 transform->iv_enc, transform->ivlen,
796 data, rec->data_len,
797 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200800 return( ret );
801 }
802
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000803 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200804 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
806 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200807 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000808 }
Paul Bakker68884e32013-01-07 18:20:04 +0100809 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000811
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200812#if defined(MBEDTLS_GCM_C) || \
813 defined(MBEDTLS_CCM_C) || \
814 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200816 mode == MBEDTLS_MODE_CCM ||
817 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000818 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200820 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100821 unsigned char *dynamic_iv;
822 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100823 int dynamic_iv_is_explicit =
824 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000825
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100826 /* Check that there's space for the authentication tag. */
827 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 {
829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
830 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
831 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000832
Paul Bakker68884e32013-01-07 18:20:04 +0100833 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100834 * Build nonce for AEAD encryption.
835 *
836 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
837 * part of the IV is prepended to the ciphertext and
838 * can be chosen freely - in particular, it need not
839 * agree with the record sequence number.
840 * However, since ChaChaPoly as well as all AEAD modes
841 * in TLS 1.3 use the record sequence number as the
842 * dynamic part of the nonce, we uniformly use the
843 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100844 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100845 dynamic_iv = rec->ctr;
846 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200847
Hanno Becker17263802020-05-28 07:05:48 +0100848 ssl_build_record_nonce( iv, sizeof( iv ),
849 transform->iv_enc,
850 transform->fixed_ivlen,
851 dynamic_iv,
852 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100853
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100854 /*
855 * Build additional data for AEAD encryption.
856 * This depends on the TLS version.
857 */
858 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
859 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100860
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200861 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100862 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200863 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100864 dynamic_iv,
865 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000866 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100867 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200869 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000871
Paul Bakker68884e32013-01-07 18:20:04 +0100872 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200873 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200874 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200876 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000877 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100878 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000879 data, rec->data_len, /* source */
880 data, &rec->data_len, /* destination */
881 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200882 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200884 return( ret );
885 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000886 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
887 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100888 /* Account for authentication tag. */
889 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000890 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100891
892 /*
893 * Prefix record content with dynamic IV in case it is explicit.
894 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100895 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100896 {
897 if( rec->data_offset < dynamic_iv_len )
898 {
899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
900 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
901 }
902
903 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
904 rec->data_offset -= dynamic_iv_len;
905 rec->data_len += dynamic_iv_len;
906 }
907
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100908 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000909 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000910 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100911#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200912#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000914 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 size_t padlen, i;
917 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000918
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000919 /* Currently we're always using minimal padding
920 * (up to 255 bytes would be allowed). */
921 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
922 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000923 padlen = 0;
924
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000925 /* Check there's enough space in the buffer for the padding. */
926 if( post_avail < padlen + 1 )
927 {
928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
929 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
930 }
931
Paul Bakker5121ce52009-01-03 21:22:43 +0000932 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000935 rec->data_len += padlen + 1;
936 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000939 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000940 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
941 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000942 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000943 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 if( f_rng == NULL )
946 {
947 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
948 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
949 }
950
951 if( rec->data_offset < transform->ivlen )
952 {
953 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
954 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
955 }
956
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000957 /*
958 * Generate IV
959 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000960 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000961 if( ret != 0 )
962 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000963
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000964 memcpy( data - transform->ivlen, transform->iv_enc,
965 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000966
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000967 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000971 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000972 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200973 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000974
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000975 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
976 transform->iv_enc,
977 transform->ivlen,
978 data, rec->data_len,
979 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200980 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200982 return( ret );
983 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200984
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000985 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
988 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200989 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000992 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200993 {
994 /*
995 * Save IV in SSL3 and TLS1
996 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000997 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
998 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000999 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001000 else
Paul Bakkercca5b812013-08-31 17:40:26 +02001001#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001002 {
1003 data -= transform->ivlen;
1004 rec->data_offset -= transform->ivlen;
1005 rec->data_len += transform->ivlen;
1006 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001009 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001010 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001011 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1012
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001013 /*
1014 * MAC(MAC_write_key, seq_num +
1015 * TLSCipherText.type +
1016 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001017 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001018 * IV + // except for TLS 1.0
1019 * ENC(content + padding + padding_length));
1020 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001021
1022 if( post_avail < transform->maclen)
1023 {
1024 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1025 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1026 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001027
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001028 ssl_extract_add_data_from_record( add_data, &add_data_len,
1029 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001032 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001033 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001034
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001035 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001036 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001037 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1038 data, rec->data_len );
1039 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1040 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001041
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001042 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001043
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001044 rec->data_len += transform->maclen;
1045 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001046 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001047 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001049 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001050 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001051#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001052 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1054 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001055 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001056
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001057 /* Make extra sure authentication was performed, exactly once */
1058 if( auth_done != 1 )
1059 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1061 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001062 }
1063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001065
1066 return( 0 );
1067}
1068
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001069#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
1070 ( defined(MBEDTLS_SSL_PROTO_TLS1) || \
1071 defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1072 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
1073/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001074 * Constant-flow conditional memcpy:
1075 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1076 * - otherwise, a no-op,
1077 * but with execution flow independent of the values of c1 and c2.
1078 *
1079 * Use only bit operations to avoid branches that could be used by some
1080 * compilers on some platforms to translate comparison operators.
1081 */
1082static void mbedtls_ssl_cf_memcpy_if_eq(unsigned char *dst,
1083 const unsigned char *src,
1084 size_t len,
1085 size_t c1, size_t c2 )
1086{
1087 /* diff = 0 if c1 == c2, non-zero otherwise */
1088 const size_t diff = c1 ^ c2;
1089
1090 /* MSVC has a warning about unary minus on unsigned integer types,
1091 * but this is well-defined and precisely what we want to do here. */
1092#if defined(_MSC_VER)
1093#pragma warning( push )
1094#pragma warning( disable : 4146 )
1095#endif
1096
1097 /* diff_msb's most significant bit is bit equal to c1 != c2 */
1098 const size_t diff_msb = ( diff | -diff );
1099
1100 /* diff1 = c1 != c2 */
1101 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1102
1103 /* mask = c1 != c2 ? 0xff : 0x00 */
1104 unsigned char mask = (unsigned char) -diff1;
1105
1106#if defined(_MSC_VER)
1107#pragma warning( pop )
1108#endif
1109
1110 /* dst[i] = c1 != c2 ? dst[i] : src[i] */
1111 for( size_t i = 0; i < len; i++ )
1112 dst[i] = ( dst[i] & mask ) | ( src[i] & ~mask );
1113}
1114
1115/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001116 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001117 *
1118 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1119 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001120 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001121MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001122 mbedtls_md_context_t *ctx,
1123 const unsigned char *add_data, size_t add_data_len,
1124 const unsigned char *data, size_t data_len_secret,
1125 size_t min_data_len, size_t max_data_len,
1126 unsigned char *output )
1127{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001128 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001129 * This function breaks the HMAC abstraction and uses the md_clone()
1130 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001131 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001132 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
1133 * concatenation, and okey/ikey is the XOR of the key with some fix bit
1134 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001135 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001136 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1137 * minlen, then cloning the context, and for each byte up to maxlen
1138 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001139 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001140 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001141 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001142 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
1143 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
1144 const unsigned char * const ikey = (unsigned char *) ctx->hmac_ctx;
1145 const unsigned char * const okey = ikey + block_size;
1146 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001147
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001148 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1149 mbedtls_md_context_t aux;
1150 size_t offset;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001151
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001152 mbedtls_md_init( &aux );
1153 mbedtls_md_setup( &aux, ctx->md_info, 0 );
1154
1155 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1156 * so we can start directly with the message */
1157 mbedtls_md_update( ctx, add_data, add_data_len );
1158 mbedtls_md_update( ctx, data, min_data_len );
1159
1160 /* For each possible length, compute the hash up to that point */
1161 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001162 {
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001163 mbedtls_md_clone( &aux, ctx );
1164 mbedtls_md_finish( &aux, aux_out );
1165 /* Keep only the correct inner_hash in the output buffer */
1166 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1167 offset, data_len_secret );
1168
1169 if( offset < max_data_len )
1170 mbedtls_md_update( ctx, data + offset, 1 );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001171 }
1172
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001173 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001174 mbedtls_md_starts( ctx );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001175 mbedtls_md_update( ctx, okey, block_size );
1176 mbedtls_md_update( ctx, output, hash_size );
1177 mbedtls_md_finish( ctx, output );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001178
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001179 /* Done, get ready for next time */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001180 mbedtls_md_hmac_reset( ctx );
1181
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001182 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001183 return( 0 );
1184}
1185#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC && TLS 1.0-1.2 */
1186
Hanno Becker605949f2019-07-12 08:23:59 +01001187int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001188 mbedtls_ssl_transform *transform,
1189 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001190{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001191 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001193 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001194#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001195 size_t padlen = 0, correct = 1;
1196#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001197 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001198 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001199 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001200
Hanno Beckera18d1322018-01-03 14:27:32 +00001201#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001202 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001203 ((void) ssl);
1204#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001207 if( rec == NULL ||
1208 rec->buf == NULL ||
1209 rec->buf_len < rec->data_offset ||
1210 rec->buf_len - rec->data_offset < rec->data_len )
1211 {
1212 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001214 }
1215
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 data = rec->buf + rec->data_offset;
1217 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001218
Hanno Beckera0e20d02019-05-15 14:03:01 +01001219#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001220 /*
1221 * Match record's CID with incoming CID.
1222 */
Hanno Becker938489a2019-05-08 13:02:22 +01001223 if( rec->cid_len != transform->in_cid_len ||
1224 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1225 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001226 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001227 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001228#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001229
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001230#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1231 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001232 {
1233 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001234 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1235 transform->iv_dec,
1236 transform->ivlen,
1237 data, rec->data_len,
1238 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001239 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001241 return( ret );
1242 }
1243
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001244 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001245 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1247 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001248 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001249 }
Paul Bakker68884e32013-01-07 18:20:04 +01001250 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001251#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001252#if defined(MBEDTLS_GCM_C) || \
1253 defined(MBEDTLS_CCM_C) || \
1254 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001256 mode == MBEDTLS_MODE_CCM ||
1257 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001258 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001259 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001260 unsigned char *dynamic_iv;
1261 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001262
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001263 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001264 * Extract dynamic part of nonce for AEAD decryption.
1265 *
1266 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1267 * part of the IV is prepended to the ciphertext and
1268 * can be chosen freely - in particular, it need not
1269 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001270 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001271 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001272 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 {
1274 if( rec->data_len < dynamic_iv_len )
1275 {
1276 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1277 rec->data_len,
1278 dynamic_iv_len ) );
1279 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1280 }
1281 dynamic_iv = data;
1282
1283 data += dynamic_iv_len;
1284 rec->data_offset += dynamic_iv_len;
1285 rec->data_len -= dynamic_iv_len;
1286 }
Hanno Becker17263802020-05-28 07:05:48 +01001287 else
1288 {
1289 dynamic_iv = rec->ctr;
1290 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001291
1292 /* Check that there's space for the authentication tag. */
1293 if( rec->data_len < transform->taglen )
1294 {
1295 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001297 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001298 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001299
Hanno Beckerdf8be222020-05-21 15:30:57 +01001300 /*
1301 * Prepare nonce from dynamic and static parts.
1302 */
Hanno Becker17263802020-05-28 07:05:48 +01001303 ssl_build_record_nonce( iv, sizeof( iv ),
1304 transform->iv_dec,
1305 transform->fixed_ivlen,
1306 dynamic_iv,
1307 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001308
Hanno Beckerdf8be222020-05-21 15:30:57 +01001309 /*
1310 * Build additional data for AEAD encryption.
1311 * This depends on the TLS version.
1312 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001313 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1314 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001316 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001317
Hanno Beckerd96a6522019-07-10 13:55:25 +01001318 /* Because of the check above, we know that there are
1319 * explicit_iv_len Bytes preceeding data, and taglen
1320 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001321 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001322 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001323
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001324 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001325 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001326 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001327
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001328 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001329 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001330 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001331 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1332 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001333 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 data, rec->data_len,
1335 data, &olen,
1336 data + rec->data_len,
1337 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1342 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001343
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001344 return( ret );
1345 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001346 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001347
Hanno Beckerd96a6522019-07-10 13:55:25 +01001348 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001349 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001350 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1352 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001353 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001354 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001355 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001357#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001359 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001360 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001361
Paul Bakker5121ce52009-01-03 21:22:43 +00001362 /*
Paul Bakker45829992013-01-03 14:52:21 +01001363 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001366 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1367 {
1368 /* The ciphertext is prefixed with the CBC IV. */
1369 minlen += transform->ivlen;
1370 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001371#endif
Paul Bakker45829992013-01-03 14:52:21 +01001372
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001373 /* Size considerations:
1374 *
1375 * - The CBC cipher text must not be empty and hence
1376 * at least of size transform->ivlen.
1377 *
1378 * Together with the potential IV-prefix, this explains
1379 * the first of the two checks below.
1380 *
1381 * - The record must contain a MAC, either in plain or
1382 * encrypted, depending on whether Encrypt-then-MAC
1383 * is used or not.
1384 * - If it is, the message contains the IV-prefix,
1385 * the CBC ciphertext, and the MAC.
1386 * - If it is not, the padded plaintext, and hence
1387 * the CBC ciphertext, has at least length maclen + 1
1388 * because there is at least the padding length byte.
1389 *
1390 * As the CBC ciphertext is not empty, both cases give the
1391 * lower bound minlen + maclen + 1 on the record size, which
1392 * we test for in the second check below.
1393 */
1394 if( rec->data_len < minlen + transform->ivlen ||
1395 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001396 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001398 "+ 1 ) ( + expl IV )", rec->data_len,
1399 transform->ivlen,
1400 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001402 }
1403
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404 /*
1405 * Authenticate before decrypt if enabled
1406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001408 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001409 {
Hanno Becker992b6872017-11-09 18:57:39 +00001410 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001413
Hanno Beckerd96a6522019-07-10 13:55:25 +01001414 /* Update data_len in tandem with add_data.
1415 *
1416 * The subtraction is safe because of the previous check
1417 * data_len >= minlen + maclen + 1.
1418 *
1419 * Afterwards, we know that data + data_len is followed by at
1420 * least maclen Bytes, which justifies the call to
1421 * mbedtls_ssl_safer_memcmp() below.
1422 *
1423 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001425 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1426 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001427
Hanno Beckerd96a6522019-07-10 13:55:25 +01001428 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001429 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1430 add_data_len );
1431 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1432 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1434 data, rec->data_len );
1435 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1436 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001437
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001438 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1439 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001440 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001441 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001442
Hanno Beckerd96a6522019-07-10 13:55:25 +01001443 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001444 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1445 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001449 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001450 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001451 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001453
1454 /*
1455 * Check length sanity
1456 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001457
1458 /* We know from above that data_len > minlen >= 0,
1459 * so the following check in particular implies that
1460 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001464 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001465 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001466 }
1467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001469 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001470 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001471 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001472 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001473 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001474 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001476
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001477 data += transform->ivlen;
1478 rec->data_offset += transform->ivlen;
1479 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001480 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001482
Hanno Beckerd96a6522019-07-10 13:55:25 +01001483 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1484
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001485 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1486 transform->iv_dec, transform->ivlen,
1487 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001490 return( ret );
1491 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001492
Hanno Beckerd96a6522019-07-10 13:55:25 +01001493 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001495 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1497 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001498 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001499
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001501 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001502 {
1503 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001504 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1505 * records is equivalent to CBC decryption of the concatenation
1506 * of the records; in other words, IVs are maintained across
1507 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001508 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001509 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1510 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001511 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001512#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001513
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514 /* Safe since data_len >= minlen + maclen + 1, so after having
1515 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001516 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1517 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001519
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520 if( auth_done == 1 )
1521 {
1522 correct *= ( rec->data_len >= padlen + 1 );
1523 padlen *= ( rec->data_len >= padlen + 1 );
1524 }
1525 else
Paul Bakker45829992013-01-03 14:52:21 +01001526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 if( rec->data_len < transform->maclen + padlen + 1 )
1529 {
1530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1531 rec->data_len,
1532 transform->maclen,
1533 padlen + 1 ) );
1534 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001535#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001536
1537 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1538 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001539 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001540
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001541 padlen++;
1542
1543 /* Regardless of the validity of the padding,
1544 * we have data_len >= padlen here. */
1545
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001546#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001547 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001548 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001549 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001550 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551#if defined(MBEDTLS_SSL_DEBUG_ALL)
1552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001553 "should be no more than %d",
1554 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001555#endif
Paul Bakker45829992013-01-03 14:52:21 +01001556 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001557 }
1558 }
1559 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1561#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1562 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001563 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001564 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001565 /* The padding check involves a series of up to 256
1566 * consecutive memory reads at the end of the record
1567 * plaintext buffer. In order to hide the length and
1568 * validity of the padding, always perform exactly
1569 * `min(256,plaintext_len)` reads (but take into account
1570 * only the last `padlen` bytes for the padding check). */
1571 size_t pad_count = 0;
1572 size_t real_count = 0;
1573 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001574
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001575 /* Index of first padding byte; it has been ensured above
1576 * that the subtraction is safe. */
1577 size_t const padding_idx = rec->data_len - padlen;
1578 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1579 size_t const start_idx = rec->data_len - num_checks;
1580 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001581
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001582 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001583 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001584 real_count |= ( idx >= padding_idx );
1585 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001586 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001587 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001588
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001590 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001592#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001593 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001594 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1597 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001598 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1600 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001601 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001602
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001603 /* If the padding was found to be invalid, padlen == 0
1604 * and the subtraction is safe. If the padding was found valid,
1605 * padlen hasn't been changed and the previous assertion
1606 * data_len >= padlen still holds. */
1607 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001608 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001609 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001610#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1613 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001614 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001615
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001616#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001619#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001620
1621 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001622 * Authenticate if not done yet.
1623 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001624 */
Hanno Becker52344c22018-01-03 15:24:20 +00001625#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001626 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001627 {
Hanno Becker992b6872017-11-09 18:57:39 +00001628 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001629
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001630 /* If the initial value of padlen was such that
1631 * data_len < maclen + padlen + 1, then padlen
1632 * got reset to 1, and the initial check
1633 * data_len >= minlen + maclen + 1
1634 * guarantees that at this point we still
1635 * have at least data_len >= maclen.
1636 *
1637 * If the initial value of padlen was such that
1638 * data_len >= maclen + padlen + 1, then we have
1639 * subtracted either padlen + 1 (if the padding was correct)
1640 * or 0 (if the padding was incorrect) since then,
1641 * hence data_len >= maclen in any case.
1642 */
1643 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001644 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1645 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001648 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001649 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001650 ssl_mac( &transform->md_ctx_dec,
1651 transform->mac_dec,
1652 data, rec->data_len,
1653 rec->ctr, rec->type,
1654 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001655 }
1656 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1658#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1659 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001660 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001661 {
1662 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001663 * The next two sizes are the minimum and maximum values of
1664 * in_msglen over all padlen values.
1665 *
1666 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001667 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001668 *
1669 * Note that max_len + maclen is never more than the buffer
1670 * length, as we previously did in_msglen -= maclen too.
1671 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001672 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001673 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1674
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001675 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1676 add_data, add_data_len,
1677 data, rec->data_len, min_len, max_len,
1678 mac_expect );
1679 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001680 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001681 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1682 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001683 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001684
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001685 /* Make sure we access all the memory that could contain the MAC,
1686 * before we check it in the next code block. This makes the
1687 * synchronisation requirements for just-in-time Prime+Probe
1688 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001689 ssl_read_memory( data + min_len,
1690 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001691 }
1692 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1694 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001695 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1697 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001698 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001700#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001701 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1702 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001703#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001704
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001705 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1706 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#if defined(MBEDTLS_SSL_DEBUG_ALL)
1709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001710#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001711 correct = 0;
1712 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001713 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001714 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001715
1716 /*
1717 * Finally check the correct flag
1718 */
1719 if( correct == 0 )
1720 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001721#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001722
1723 /* Make extra sure authentication was performed, exactly once */
1724 if( auth_done != 1 )
1725 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1727 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001728 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
Hanno Beckerccc13d02020-05-04 12:30:04 +01001730#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1731 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1732 {
1733 /* Remove inner padding and infer true content type. */
1734 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1735 &rec->type );
1736
1737 if( ret != 0 )
1738 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1739 }
1740#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1741
Hanno Beckera0e20d02019-05-15 14:03:01 +01001742#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001743 if( rec->cid_len != 0 )
1744 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001745 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1746 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001747 if( ret != 0 )
1748 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1749 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001750#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001753
1754 return( 0 );
1755}
1756
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001757#undef MAC_NONE
1758#undef MAC_PLAINTEXT
1759#undef MAC_CIPHERTEXT
1760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001762/*
1763 * Compression/decompression functions
1764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001766{
Janos Follath865b3eb2019-12-16 11:46:15 +00001767 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001768 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001769 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001770 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001771 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001772#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1773 size_t out_buf_len = ssl->out_buf_len;
1774#else
1775 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1776#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001778 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001779
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001780 if( len_pre == 0 )
1781 return( 0 );
1782
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783 memcpy( msg_pre, ssl->out_msg, len_pre );
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786 ssl->out_msglen ) );
1787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001789 ssl->out_msg, ssl->out_msglen );
1790
Paul Bakker48916f92012-09-16 19:57:18 +00001791 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1792 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1793 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001794 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001795
Paul Bakker48916f92012-09-16 19:57:18 +00001796 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001797 if( ret != Z_OK )
1798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1800 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001801 }
1802
Darryl Greenb33cc762019-11-28 14:29:44 +00001803 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001804 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001807 ssl->out_msglen ) );
1808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001810 ssl->out_msg, ssl->out_msglen );
1811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001813
1814 return( 0 );
1815}
1816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001818{
Janos Follath865b3eb2019-12-16 11:46:15 +00001819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001820 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001821 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001822 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001823 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001824#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1825 size_t in_buf_len = ssl->in_buf_len;
1826#else
1827 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1828#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001831
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001832 if( len_pre == 0 )
1833 return( 0 );
1834
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835 memcpy( msg_pre, ssl->in_msg, len_pre );
1836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838 ssl->in_msglen ) );
1839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001841 ssl->in_msg, ssl->in_msglen );
1842
Paul Bakker48916f92012-09-16 19:57:18 +00001843 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1844 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1845 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001846 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001847
Paul Bakker48916f92012-09-16 19:57:18 +00001848 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001849 if( ret != Z_OK )
1850 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1852 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001853 }
1854
Darryl Greenb33cc762019-11-28 14:29:44 +00001855 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001856 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001859 ssl->in_msglen ) );
1860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001862 ssl->in_msg, ssl->in_msglen );
1863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001865
1866 return( 0 );
1867}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001869
Paul Bakker5121ce52009-01-03 21:22:43 +00001870/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001871 * Fill the input message buffer by appending data to it.
1872 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001873 *
1874 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1875 * available (from this read and/or a previous one). Otherwise, an error code
1876 * is returned (possibly EOF or WANT_READ).
1877 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001878 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1879 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1880 * since we always read a whole datagram at once.
1881 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001882 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001883 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001886{
Janos Follath865b3eb2019-12-16 11:46:15 +00001887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001888 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001889#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1890 size_t in_buf_len = ssl->in_buf_len;
1891#else
1892 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1893#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001896
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001897 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1898 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001900 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001902 }
1903
Darryl Greenb33cc762019-11-28 14:29:44 +00001904 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001905 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1907 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001908 }
1909
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001911 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001912 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001913 uint32_t timeout;
1914
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001915 /* Just to be sure */
1916 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1917 {
1918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1919 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1920 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1921 }
1922
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001923 /*
1924 * The point is, we need to always read a full datagram at once, so we
1925 * sometimes read more then requested, and handle the additional data.
1926 * It could be the rest of the current record (while fetching the
1927 * header) and/or some other records in the same datagram.
1928 */
1929
1930 /*
1931 * Move to the next record in the already read datagram if applicable
1932 */
1933 if( ssl->next_record_offset != 0 )
1934 {
1935 if( ssl->in_left < ssl->next_record_offset )
1936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1938 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001939 }
1940
1941 ssl->in_left -= ssl->next_record_offset;
1942
1943 if( ssl->in_left != 0 )
1944 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001946 ssl->next_record_offset ) );
1947 memmove( ssl->in_hdr,
1948 ssl->in_hdr + ssl->next_record_offset,
1949 ssl->in_left );
1950 }
1951
1952 ssl->next_record_offset = 0;
1953 }
1954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001956 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001957
1958 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001959 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001960 */
1961 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001962 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001964 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001965 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001966
1967 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001968 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001969 * are not at the beginning of a new record, the caller did something
1970 * wrong.
1971 */
1972 if( ssl->in_left != 0 )
1973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1975 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001976 }
1977
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001978 /*
1979 * Don't even try to read if time's out already.
1980 * This avoids by-passing the timer when repeatedly receiving messages
1981 * that will end up being dropped.
1982 */
Hanno Becker7876d122020-02-05 10:39:31 +00001983 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001984 {
1985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001986 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001987 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001988 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001989 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001990 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001993 timeout = ssl->handshake->retransmit_timeout;
1994 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001995 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001998
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001999 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002000 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2001 timeout );
2002 else
2003 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002006
2007 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002009 }
2010
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002011 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002012 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002014 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002017 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002018 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2019 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002021 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002022 }
2023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002025 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002027 return( ret );
2028 }
2029
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002030 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002031 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002033 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002035 {
Hanno Becker786300f2020-02-05 10:46:40 +00002036 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002037 {
Hanno Becker786300f2020-02-05 10:46:40 +00002038 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2039 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002040 return( ret );
2041 }
2042
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002043 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002044 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002046 }
2047
Paul Bakker5121ce52009-01-03 21:22:43 +00002048 if( ret < 0 )
2049 return( ret );
2050
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002051 ssl->in_left = ret;
2052 }
2053 else
2054#endif
2055 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002057 ssl->in_left, nb_want ) );
2058
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002059 while( ssl->in_left < nb_want )
2060 {
2061 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002062
Hanno Becker7876d122020-02-05 10:39:31 +00002063 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002064 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2065 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002066 {
2067 if( ssl->f_recv_timeout != NULL )
2068 {
2069 ret = ssl->f_recv_timeout( ssl->p_bio,
2070 ssl->in_hdr + ssl->in_left, len,
2071 ssl->conf->read_timeout );
2072 }
2073 else
2074 {
2075 ret = ssl->f_recv( ssl->p_bio,
2076 ssl->in_hdr + ssl->in_left, len );
2077 }
2078 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002079
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002081 ssl->in_left, nb_want ) );
2082 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002083
2084 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002086
2087 if( ret < 0 )
2088 return( ret );
2089
mohammad160352aecb92018-03-28 23:41:40 -07002090 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002091 {
Darryl Green11999bb2018-03-13 15:22:58 +00002092 MBEDTLS_SSL_DEBUG_MSG( 1,
2093 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002094 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002095 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2096 }
2097
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002098 ssl->in_left += ret;
2099 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002100 }
2101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
2104 return( 0 );
2105}
2106
2107/*
2108 * Flush any data not yet written
2109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002111{
Janos Follath865b3eb2019-12-16 11:46:15 +00002112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002113 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002116
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002117 if( ssl->f_send == NULL )
2118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002120 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002122 }
2123
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002124 /* Avoid incrementing counter if data is flushed */
2125 if( ssl->out_left == 0 )
2126 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002128 return( 0 );
2129 }
2130
Paul Bakker5121ce52009-01-03 21:22:43 +00002131 while( ssl->out_left > 0 )
2132 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002134 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002135
Hanno Becker2b1e3542018-08-06 11:19:13 +01002136 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002137 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002140
2141 if( ret <= 0 )
2142 return( ret );
2143
mohammad160352aecb92018-03-28 23:41:40 -07002144 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002145 {
Darryl Green11999bb2018-03-13 15:22:58 +00002146 MBEDTLS_SSL_DEBUG_MSG( 1,
2147 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002148 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002149 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2150 }
2151
Paul Bakker5121ce52009-01-03 21:22:43 +00002152 ssl->out_left -= ret;
2153 }
2154
Hanno Becker2b1e3542018-08-06 11:19:13 +01002155#if defined(MBEDTLS_SSL_PROTO_DTLS)
2156 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002157 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002158 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002159 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002160 else
2161#endif
2162 {
2163 ssl->out_hdr = ssl->out_buf + 8;
2164 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002165 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002168
2169 return( 0 );
2170}
2171
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002172/*
2173 * Functions to handle the DTLS retransmission state machine
2174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002176/*
2177 * Append current handshake message to current outgoing flight
2178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002180{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002182 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2183 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2184 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002185
2186 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002187 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002188 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002189 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002191 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002192 }
2193
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002194 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002195 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002196 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002198 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002199 }
2200
2201 /* Copy current handshake message with headers */
2202 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2203 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002204 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002205 msg->next = NULL;
2206
2207 /* Append to the current flight */
2208 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002210 else
2211 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002213 while( cur->next != NULL )
2214 cur = cur->next;
2215 cur->next = msg;
2216 }
2217
Hanno Becker3b235902018-08-06 09:54:53 +01002218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002219 return( 0 );
2220}
2221
2222/*
2223 * Free the current flight of handshake messages
2224 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002225void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002226{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 mbedtls_ssl_flight_item *cur = flight;
2228 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002229
2230 while( cur != NULL )
2231 {
2232 next = cur->next;
2233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002234 mbedtls_free( cur->p );
2235 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002236
2237 cur = next;
2238 }
2239}
2240
2241/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002242 * Swap transform_out and out_ctr with the alternative ones
2243 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002244static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002245{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002247 unsigned char tmp_out_ctr[8];
2248
2249 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2250 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002252 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002253 }
2254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002256
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002257 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002258 tmp_transform = ssl->transform_out;
2259 ssl->transform_out = ssl->handshake->alt_transform_out;
2260 ssl->handshake->alt_transform_out = tmp_transform;
2261
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002262 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002263 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2264 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002266
2267 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002268 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2271 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002272 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002273 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2274 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002275 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2277 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002278 }
2279 }
2280#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002281
2282 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002283}
2284
2285/*
2286 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002287 */
2288int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2289{
2290 int ret = 0;
2291
2292 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2293
2294 ret = mbedtls_ssl_flight_transmit( ssl );
2295
2296 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2297
2298 return( ret );
2299}
2300
2301/*
2302 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002303 *
2304 * Need to remember the current message in case flush_output returns
2305 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002306 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002307 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002308int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002309{
Janos Follath865b3eb2019-12-16 11:46:15 +00002310 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002313 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002314 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002315 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002316
2317 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002318 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002319 ret = ssl_swap_epochs( ssl );
2320 if( ret != 0 )
2321 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002324 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002325
2326 while( ssl->handshake->cur_msg != NULL )
2327 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002328 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002329 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002330
Hanno Beckere1dcb032018-08-17 16:47:58 +01002331 int const is_finished =
2332 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2333 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2334
Hanno Becker04da1892018-08-14 13:22:10 +01002335 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2336 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2337
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002338 /* Swap epochs before sending Finished: we can't do it after
2339 * sending ChangeCipherSpec, in case write returns WANT_READ.
2340 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002341 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002342 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002344 ret = ssl_swap_epochs( ssl );
2345 if( ret != 0 )
2346 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002347 }
2348
Hanno Becker67bc7c32018-08-06 11:33:50 +01002349 ret = ssl_get_remaining_payload_in_datagram( ssl );
2350 if( ret < 0 )
2351 return( ret );
2352 max_frag_len = (size_t) ret;
2353
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002354 /* CCS is copied as is, while HS messages may need fragmentation */
2355 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2356 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002357 if( max_frag_len == 0 )
2358 {
2359 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2360 return( ret );
2361
2362 continue;
2363 }
2364
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002365 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002366 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002367 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002368
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002369 /* Update position inside current message */
2370 ssl->handshake->cur_msg_p += cur->len;
2371 }
2372 else
2373 {
2374 const unsigned char * const p = ssl->handshake->cur_msg_p;
2375 const size_t hs_len = cur->len - 12;
2376 const size_t frag_off = p - ( cur->p + 12 );
2377 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002378 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002379
Hanno Beckere1dcb032018-08-17 16:47:58 +01002380 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002381 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002382 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002383 {
2384 ret = ssl_swap_epochs( ssl );
2385 if( ret != 0 )
2386 return( ret );
2387 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002388
Hanno Becker67bc7c32018-08-06 11:33:50 +01002389 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2390 return( ret );
2391
2392 continue;
2393 }
2394 max_hs_frag_len = max_frag_len - 12;
2395
2396 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2397 max_hs_frag_len : rem_len;
2398
2399 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002400 {
2401 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002402 (unsigned) cur_hs_frag_len,
2403 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002404 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002405
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002406 /* Messages are stored with handshake headers as if not fragmented,
2407 * copy beginning of headers then fill fragmentation fields.
2408 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2409 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002411 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2412 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2413 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2414
Hanno Becker67bc7c32018-08-06 11:33:50 +01002415 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2416 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2417 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002418
2419 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2420
Hanno Becker3f7b9732018-08-28 09:53:25 +01002421 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002422 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2423 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002424 ssl->out_msgtype = cur->type;
2425
2426 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002427 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002428 }
2429
2430 /* If done with the current message move to the next one if any */
2431 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2432 {
2433 if( cur->next != NULL )
2434 {
2435 ssl->handshake->cur_msg = cur->next;
2436 ssl->handshake->cur_msg_p = cur->next->p + 12;
2437 }
2438 else
2439 {
2440 ssl->handshake->cur_msg = NULL;
2441 ssl->handshake->cur_msg_p = NULL;
2442 }
2443 }
2444
2445 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002446 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002449 return( ret );
2450 }
2451 }
2452
Hanno Becker67bc7c32018-08-06 11:33:50 +01002453 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2454 return( ret );
2455
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002456 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2458 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002459 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002460 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002462 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002463 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002464
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002465 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466
2467 return( 0 );
2468}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002469
2470/*
2471 * To be called when the last message of an incoming flight is received.
2472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002474{
2475 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002476 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002477 ssl->handshake->flight = NULL;
2478 ssl->handshake->cur_msg = NULL;
2479
2480 /* The next incoming flight will start with this msg_seq */
2481 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2482
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002483 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002484 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002485
Hanno Becker0271f962018-08-16 13:23:47 +01002486 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002487 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002488
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002489 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002490 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2493 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002494 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002495 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002496 }
2497 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002499}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002500
2501/*
2502 * To be called when the last message of an outgoing flight is send.
2503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002505{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002506 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002507 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2510 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002511 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002513 }
2514 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002516}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518
Paul Bakker5121ce52009-01-03 21:22:43 +00002519/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002521 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002522
2523/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002524 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002525 *
2526 * - fill in handshake headers
2527 * - update handshake checksum
2528 * - DTLS: save message for resending
2529 * - then pass to the record layer
2530 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002531 * DTLS: except for HelloRequest, messages are only queued, and will only be
2532 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002533 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002534 * Inputs:
2535 * - ssl->out_msglen: 4 + actual handshake message len
2536 * (4 is the size of handshake headers for TLS)
2537 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2538 * - ssl->out_msg + 4: the handshake message body
2539 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002540 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002541 * - ssl->out_msglen: the length of the record contents
2542 * (including handshake headers but excluding record headers)
2543 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002544 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002545int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002546{
Janos Follath865b3eb2019-12-16 11:46:15 +00002547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002548 const size_t hs_len = ssl->out_msglen - 4;
2549 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002550
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2552
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002553 /*
2554 * Sanity checks
2555 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002556 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002557 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2558 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002559 /* In SSLv3, the client might send a NoCertificate alert. */
2560#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2561 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2562 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2563 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2564#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2565 {
2566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2568 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002569 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002570
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002571 /* Whenever we send anything different from a
2572 * HelloRequest we should be in a handshake - double check. */
2573 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2574 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002575 ssl->handshake == NULL )
2576 {
2577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2578 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2579 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002582 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002583 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002585 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2587 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002588 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002589#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002590
Hanno Beckerb50a2532018-08-06 11:52:54 +01002591 /* Double-check that we did not exceed the bounds
2592 * of the outgoing record buffer.
2593 * This should never fail as the various message
2594 * writing functions must obey the bounds of the
2595 * outgoing record buffer, but better be safe.
2596 *
2597 * Note: We deliberately do not check for the MTU or MFL here.
2598 */
2599 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2600 {
2601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2602 "size %u, maximum %u",
2603 (unsigned) ssl->out_msglen,
2604 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2605 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2606 }
2607
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002608 /*
2609 * Fill handshake headers
2610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002612 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002613 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2614 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2615 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002616
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002617 /*
2618 * DTLS has additional fields in the Handshake layer,
2619 * between the length field and the actual payload:
2620 * uint16 message_seq;
2621 * uint24 fragment_offset;
2622 * uint24 fragment_length;
2623 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002625 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002626 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002627 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002628 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002629 {
2630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2631 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002632 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002633 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002634 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2635 }
2636
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002637 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002638 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002639
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002640 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002641 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002642 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002643 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2644 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2645 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002646 }
2647 else
2648 {
2649 ssl->out_msg[4] = 0;
2650 ssl->out_msg[5] = 0;
2651 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002652
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002653 /* Handshake hashes are computed without fragmentation,
2654 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002655 memset( ssl->out_msg + 6, 0x00, 3 );
2656 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002657 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002659
Hanno Becker0207e532018-08-28 10:28:28 +01002660 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002661 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2662 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002663 }
2664
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002665 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002667 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002668 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2669 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002670 {
2671 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2672 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002674 return( ret );
2675 }
2676 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002677 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002678#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002679 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002680 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002681 {
2682 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2683 return( ret );
2684 }
2685 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002686
2687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2688
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002689 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002690}
2691
2692/*
2693 * Record layer functions
2694 */
2695
2696/*
2697 * Write current record.
2698 *
2699 * Uses:
2700 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2701 * - ssl->out_msglen: length of the record content (excl headers)
2702 * - ssl->out_msg: record content
2703 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002704int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002705{
2706 int ret, done = 0;
2707 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002708 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002709
2710 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002713 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002715 {
2716 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2717 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002719 return( ret );
2720 }
2721
2722 len = ssl->out_msglen;
2723 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2727 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002728 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 ret = mbedtls_ssl_hw_record_write( ssl );
2732 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002733 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2735 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002736 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002737
2738 if( ret == 0 )
2739 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002740 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002742 if( !done )
2743 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002744 unsigned i;
2745 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002746#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2747 size_t out_buf_len = ssl->out_buf_len;
2748#else
2749 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2750#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002751 /* Skip writing the record content type to after the encryption,
2752 * as it may change when using the CID extension. */
2753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002755 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002756
Hanno Becker19859472018-08-06 09:40:20 +01002757 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002758 ssl->out_len[0] = (unsigned char)( len >> 8 );
2759 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002760
Paul Bakker48916f92012-09-16 19:57:18 +00002761 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002762 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002763 mbedtls_record rec;
2764
2765 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002766 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002767 rec.data_len = ssl->out_msglen;
2768 rec.data_offset = ssl->out_msg - rec.buf;
2769
2770 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2771 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2772 ssl->conf->transport, rec.ver );
2773 rec.type = ssl->out_msgtype;
2774
Hanno Beckera0e20d02019-05-15 14:03:01 +01002775#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002776 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002777 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002778#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002779
Hanno Beckera18d1322018-01-03 14:27:32 +00002780 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002781 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002782 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002784 return( ret );
2785 }
2786
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002787 if( rec.data_offset != 0 )
2788 {
2789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2790 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2791 }
2792
Hanno Becker6430faf2019-05-08 11:57:13 +01002793 /* Update the record content type and CID. */
2794 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002795#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002796 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002798 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002799 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2800 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002801 }
2802
Hanno Becker5903de42019-05-03 14:46:38 +01002803 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002804
2805#if defined(MBEDTLS_SSL_PROTO_DTLS)
2806 /* In case of DTLS, double-check that we don't exceed
2807 * the remaining space in the datagram. */
2808 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2809 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002810 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002811 if( ret < 0 )
2812 return( ret );
2813
2814 if( protected_record_size > (size_t) ret )
2815 {
2816 /* Should never happen */
2817 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2818 }
2819 }
2820#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002821
Hanno Becker6430faf2019-05-08 11:57:13 +01002822 /* Now write the potentially updated record content type. */
2823 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002826 "version = [%d:%d], msglen = %d",
2827 ssl->out_hdr[0], ssl->out_hdr[1],
2828 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002829
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002831 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002832
2833 ssl->out_left += protected_record_size;
2834 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002835 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002836
Hanno Beckerdd772292020-02-05 10:38:31 +00002837 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002838 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2839 break;
2840
2841 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002842 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002843 {
2844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2845 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2846 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002847 }
2848
Hanno Becker67bc7c32018-08-06 11:33:50 +01002849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002850 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2851 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002852 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002853 size_t remaining;
2854 ret = ssl_get_remaining_payload_in_datagram( ssl );
2855 if( ret < 0 )
2856 {
2857 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2858 ret );
2859 return( ret );
2860 }
2861
2862 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002863 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002864 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002865 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002866 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002867 else
2868 {
Hanno Becker513815a2018-08-20 11:56:09 +01002869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002870 }
2871 }
2872#endif /* MBEDTLS_SSL_PROTO_DTLS */
2873
2874 if( ( flush == SSL_FORCE_FLUSH ) &&
2875 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002876 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002878 return( ret );
2879 }
2880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002882
2883 return( 0 );
2884}
2885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002887
2888static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2889{
2890 if( ssl->in_msglen < ssl->in_hslen ||
2891 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2892 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2893 {
2894 return( 1 );
2895 }
2896 return( 0 );
2897}
Hanno Becker44650b72018-08-16 12:51:11 +01002898
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002899static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002900{
2901 return( ( ssl->in_msg[9] << 16 ) |
2902 ( ssl->in_msg[10] << 8 ) |
2903 ssl->in_msg[11] );
2904}
2905
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002906static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002907{
2908 return( ( ssl->in_msg[6] << 16 ) |
2909 ( ssl->in_msg[7] << 8 ) |
2910 ssl->in_msg[8] );
2911}
2912
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002913static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002914{
2915 uint32_t msg_len, frag_off, frag_len;
2916
2917 msg_len = ssl_get_hs_total_len( ssl );
2918 frag_off = ssl_get_hs_frag_off( ssl );
2919 frag_len = ssl_get_hs_frag_len( ssl );
2920
2921 if( frag_off > msg_len )
2922 return( -1 );
2923
2924 if( frag_len > msg_len - frag_off )
2925 return( -1 );
2926
2927 if( frag_len + 12 > ssl->in_msglen )
2928 return( -1 );
2929
2930 return( 0 );
2931}
2932
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002933/*
2934 * Mark bits in bitmask (used for DTLS HS reassembly)
2935 */
2936static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2937{
2938 unsigned int start_bits, end_bits;
2939
2940 start_bits = 8 - ( offset % 8 );
2941 if( start_bits != 8 )
2942 {
2943 size_t first_byte_idx = offset / 8;
2944
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002945 /* Special case */
2946 if( len <= start_bits )
2947 {
2948 for( ; len != 0; len-- )
2949 mask[first_byte_idx] |= 1 << ( start_bits - len );
2950
2951 /* Avoid potential issues with offset or len becoming invalid */
2952 return;
2953 }
2954
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002955 offset += start_bits; /* Now offset % 8 == 0 */
2956 len -= start_bits;
2957
2958 for( ; start_bits != 0; start_bits-- )
2959 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2960 }
2961
2962 end_bits = len % 8;
2963 if( end_bits != 0 )
2964 {
2965 size_t last_byte_idx = ( offset + len ) / 8;
2966
2967 len -= end_bits; /* Now len % 8 == 0 */
2968
2969 for( ; end_bits != 0; end_bits-- )
2970 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2971 }
2972
2973 memset( mask + offset / 8, 0xFF, len / 8 );
2974}
2975
2976/*
2977 * Check that bitmask is full
2978 */
2979static int ssl_bitmask_check( unsigned char *mask, size_t len )
2980{
2981 size_t i;
2982
2983 for( i = 0; i < len / 8; i++ )
2984 if( mask[i] != 0xFF )
2985 return( -1 );
2986
2987 for( i = 0; i < len % 8; i++ )
2988 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2989 return( -1 );
2990
2991 return( 0 );
2992}
2993
Hanno Becker56e205e2018-08-16 09:06:12 +01002994/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002995static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002996 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002997{
Hanno Becker56e205e2018-08-16 09:06:12 +01002998 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002999
Hanno Becker56e205e2018-08-16 09:06:12 +01003000 alloc_len = 12; /* Handshake header */
3001 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003002
Hanno Beckerd07df862018-08-16 09:14:58 +01003003 if( add_bitmap )
3004 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003005
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003006 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003007}
Hanno Becker56e205e2018-08-16 09:06:12 +01003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003010
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003011static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003012{
3013 return( ( ssl->in_msg[1] << 16 ) |
3014 ( ssl->in_msg[2] << 8 ) |
3015 ssl->in_msg[3] );
3016}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003017
Simon Butcher99000142016-10-13 17:21:01 +01003018int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003019{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003021 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003022 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003023 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003025 }
3026
Hanno Becker12555c62018-08-16 12:47:53 +01003027 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003030 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003031 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003034 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003035 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003037 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003038
Hanno Becker44650b72018-08-16 12:51:11 +01003039 if( ssl_check_hs_header( ssl ) != 0 )
3040 {
3041 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3042 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3043 }
3044
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003045 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003046 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3047 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3048 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3049 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003050 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003051 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3052 {
3053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3054 recv_msg_seq,
3055 ssl->handshake->in_msg_seq ) );
3056 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3057 }
3058
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003059 /* Retransmit only on last message from previous flight, to avoid
3060 * too many retransmissions.
3061 * Besides, No sane server ever retransmits HelloVerifyRequest */
3062 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003064 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003066 "message_seq = %d, start_of_flight = %d",
3067 recv_msg_seq,
3068 ssl->handshake->in_flight_start_seq ) );
3069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003073 return( ret );
3074 }
3075 }
3076 else
3077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003079 "message_seq = %d, expected = %d",
3080 recv_msg_seq,
3081 ssl->handshake->in_msg_seq ) );
3082 }
3083
Hanno Becker90333da2017-10-10 11:27:13 +01003084 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003085 }
3086 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003087
Hanno Becker6d97ef52018-08-16 13:09:04 +01003088 /* Message reassembly is handled alongside buffering of future
3089 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003090 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003091 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003092 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003093 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003095 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003096 }
3097 }
3098 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003100 /* With TLS we don't handle fragmentation (for now) */
3101 if( ssl->in_msglen < ssl->in_hslen )
3102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3104 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003105 }
3106
Simon Butcher99000142016-10-13 17:21:01 +01003107 return( 0 );
3108}
3109
3110void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3111{
Hanno Becker0271f962018-08-16 13:23:47 +01003112 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003113
Hanno Becker0271f962018-08-16 13:23:47 +01003114 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003115 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003116 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003117 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003118
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003119 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003121 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003122 ssl->handshake != NULL )
3123 {
Hanno Becker0271f962018-08-16 13:23:47 +01003124 unsigned offset;
3125 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003126
Hanno Becker0271f962018-08-16 13:23:47 +01003127 /* Increment handshake sequence number */
3128 hs->in_msg_seq++;
3129
3130 /*
3131 * Clear up handshake buffering and reassembly structure.
3132 */
3133
3134 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003135 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003136
3137 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003138 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3139 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003140 offset++, hs_buf++ )
3141 {
3142 *hs_buf = *(hs_buf + 1);
3143 }
3144
3145 /* Create a fresh last entry */
3146 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003147 }
3148#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003149}
3150
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003151/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003152 * DTLS anti-replay: RFC 6347 4.1.2.6
3153 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003154 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3155 * Bit n is set iff record number in_window_top - n has been seen.
3156 *
3157 * Usually, in_window_top is the last record number seen and the lsb of
3158 * in_window is set. The only exception is the initial state (record number 0
3159 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003162void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003163{
3164 ssl->in_window_top = 0;
3165 ssl->in_window = 0;
3166}
3167
3168static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3169{
3170 return( ( (uint64_t) buf[0] << 40 ) |
3171 ( (uint64_t) buf[1] << 32 ) |
3172 ( (uint64_t) buf[2] << 24 ) |
3173 ( (uint64_t) buf[3] << 16 ) |
3174 ( (uint64_t) buf[4] << 8 ) |
3175 ( (uint64_t) buf[5] ) );
3176}
3177
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003178static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3179{
Janos Follath865b3eb2019-12-16 11:46:15 +00003180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003181 unsigned char *original_in_ctr;
3182
3183 // save original in_ctr
3184 original_in_ctr = ssl->in_ctr;
3185
3186 // use counter from record
3187 ssl->in_ctr = record_in_ctr;
3188
3189 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3190
3191 // restore the counter
3192 ssl->in_ctr = original_in_ctr;
3193
3194 return ret;
3195}
3196
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003197/*
3198 * Return 0 if sequence number is acceptable, -1 otherwise
3199 */
Hanno Becker0183d692019-07-12 08:50:37 +01003200int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003201{
3202 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3203 uint64_t bit;
3204
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003205 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003206 return( 0 );
3207
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003208 if( rec_seqnum > ssl->in_window_top )
3209 return( 0 );
3210
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003211 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003212
3213 if( bit >= 64 )
3214 return( -1 );
3215
3216 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3217 return( -1 );
3218
3219 return( 0 );
3220}
3221
3222/*
3223 * Update replay window on new validated record
3224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003226{
3227 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3228
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003229 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003230 return;
3231
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003232 if( rec_seqnum > ssl->in_window_top )
3233 {
3234 /* Update window_top and the contents of the window */
3235 uint64_t shift = rec_seqnum - ssl->in_window_top;
3236
3237 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003238 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003239 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003240 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003241 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003242 ssl->in_window |= 1;
3243 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003244
3245 ssl->in_window_top = rec_seqnum;
3246 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003247 else
3248 {
3249 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003250 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003251
3252 if( bit < 64 ) /* Always true, but be extra sure */
3253 ssl->in_window |= (uint64_t) 1 << bit;
3254 }
3255}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003257
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003258#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003259/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003260 * Without any SSL context, check if a datagram looks like a ClientHello with
3261 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003262 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003263 *
3264 * - if cookie is valid, return 0
3265 * - if ClientHello looks superficially valid but cookie is not,
3266 * fill obuf and set olen, then
3267 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3268 * - otherwise return a specific error code
3269 */
3270static int ssl_check_dtls_clihlo_cookie(
3271 mbedtls_ssl_cookie_write_t *f_cookie_write,
3272 mbedtls_ssl_cookie_check_t *f_cookie_check,
3273 void *p_cookie,
3274 const unsigned char *cli_id, size_t cli_id_len,
3275 const unsigned char *in, size_t in_len,
3276 unsigned char *obuf, size_t buf_len, size_t *olen )
3277{
3278 size_t sid_len, cookie_len;
3279 unsigned char *p;
3280
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003281 /*
3282 * Structure of ClientHello with record and handshake headers,
3283 * and expected values. We don't need to check a lot, more checks will be
3284 * done when actually parsing the ClientHello - skipping those checks
3285 * avoids code duplication and does not make cookie forging any easier.
3286 *
3287 * 0-0 ContentType type; copied, must be handshake
3288 * 1-2 ProtocolVersion version; copied
3289 * 3-4 uint16 epoch; copied, must be 0
3290 * 5-10 uint48 sequence_number; copied
3291 * 11-12 uint16 length; (ignored)
3292 *
3293 * 13-13 HandshakeType msg_type; (ignored)
3294 * 14-16 uint24 length; (ignored)
3295 * 17-18 uint16 message_seq; copied
3296 * 19-21 uint24 fragment_offset; copied, must be 0
3297 * 22-24 uint24 fragment_length; (ignored)
3298 *
3299 * 25-26 ProtocolVersion client_version; (ignored)
3300 * 27-58 Random random; (ignored)
3301 * 59-xx SessionID session_id; 1 byte len + sid_len content
3302 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3303 * ...
3304 *
3305 * Minimum length is 61 bytes.
3306 */
3307 if( in_len < 61 ||
3308 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3309 in[3] != 0 || in[4] != 0 ||
3310 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3311 {
3312 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3313 }
3314
3315 sid_len = in[59];
3316 if( sid_len > in_len - 61 )
3317 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3318
3319 cookie_len = in[60 + sid_len];
3320 if( cookie_len > in_len - 60 )
3321 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3322
3323 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3324 cli_id, cli_id_len ) == 0 )
3325 {
3326 /* Valid cookie */
3327 return( 0 );
3328 }
3329
3330 /*
3331 * If we get here, we've got an invalid cookie, let's prepare HVR.
3332 *
3333 * 0-0 ContentType type; copied
3334 * 1-2 ProtocolVersion version; copied
3335 * 3-4 uint16 epoch; copied
3336 * 5-10 uint48 sequence_number; copied
3337 * 11-12 uint16 length; olen - 13
3338 *
3339 * 13-13 HandshakeType msg_type; hello_verify_request
3340 * 14-16 uint24 length; olen - 25
3341 * 17-18 uint16 message_seq; copied
3342 * 19-21 uint24 fragment_offset; copied
3343 * 22-24 uint24 fragment_length; olen - 25
3344 *
3345 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3346 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3347 *
3348 * Minimum length is 28.
3349 */
3350 if( buf_len < 28 )
3351 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3352
3353 /* Copy most fields and adapt others */
3354 memcpy( obuf, in, 25 );
3355 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3356 obuf[25] = 0xfe;
3357 obuf[26] = 0xff;
3358
3359 /* Generate and write actual cookie */
3360 p = obuf + 28;
3361 if( f_cookie_write( p_cookie,
3362 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3363 {
3364 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3365 }
3366
3367 *olen = p - obuf;
3368
3369 /* Go back and fill length fields */
3370 obuf[27] = (unsigned char)( *olen - 28 );
3371
3372 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3373 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3374 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3375
3376 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3377 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3378
3379 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3380}
3381
3382/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003383 * Handle possible client reconnect with the same UDP quadruplet
3384 * (RFC 6347 Section 4.2.8).
3385 *
3386 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3387 * that looks like a ClientHello.
3388 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003389 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003390 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003391 * - if the input looks like a ClientHello with a valid cookie,
3392 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003393 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003394 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003395 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003396 * This function is called (through ssl_check_client_reconnect()) when an
3397 * unexpected record is found in ssl_get_next_record(), which will discard the
3398 * record if we return 0, and bubble up the return value otherwise (this
3399 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3400 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003401 */
3402static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3403{
Janos Follath865b3eb2019-12-16 11:46:15 +00003404 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003405 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003406
Hanno Becker2fddd372019-07-10 14:37:41 +01003407 if( ssl->conf->f_cookie_write == NULL ||
3408 ssl->conf->f_cookie_check == NULL )
3409 {
3410 /* If we can't use cookies to verify reachability of the peer,
3411 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003412 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3413 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003414 return( 0 );
3415 }
3416
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003417 ret = ssl_check_dtls_clihlo_cookie(
3418 ssl->conf->f_cookie_write,
3419 ssl->conf->f_cookie_check,
3420 ssl->conf->p_cookie,
3421 ssl->cli_id, ssl->cli_id_len,
3422 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003423 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003424
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003425 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3426
3427 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003428 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003429 int send_ret;
3430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3431 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3432 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003433 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003434 * If the error is permanent we'll catch it later,
3435 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003436 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3437 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3438 (void) send_ret;
3439
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003440 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003441 }
3442
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003443 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003444 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003445 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003446 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003447 {
3448 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3449 return( ret );
3450 }
3451
3452 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003453 }
3454
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003455 return( ret );
3456}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003457#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003459static int ssl_check_record_type( uint8_t record_type )
3460{
3461 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3462 record_type != MBEDTLS_SSL_MSG_ALERT &&
3463 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3464 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3465 {
3466 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3467 }
3468
3469 return( 0 );
3470}
3471
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003472/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003473 * ContentType type;
3474 * ProtocolVersion version;
3475 * uint16 epoch; // DTLS only
3476 * uint48 sequence_number; // DTLS only
3477 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003478 *
3479 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003480 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003481 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3482 *
3483 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003484 * 1. proceed with the record if this function returns 0
3485 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3486 * 3. return CLIENT_RECONNECT if this function return that value
3487 * 4. drop the whole datagram if this function returns anything else.
3488 * Point 2 is needed when the peer is resending, and we have already received
3489 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003490 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003491static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003492 unsigned char *buf,
3493 size_t len,
3494 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003495{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003496 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003497
Hanno Beckere5e7e782019-07-11 12:29:35 +01003498 size_t const rec_hdr_type_offset = 0;
3499 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003500
Hanno Beckere5e7e782019-07-11 12:29:35 +01003501 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3502 rec_hdr_type_len;
3503 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003504
Hanno Beckere5e7e782019-07-11 12:29:35 +01003505 size_t const rec_hdr_ctr_len = 8;
3506#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003507 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003508 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3509 rec_hdr_version_len;
3510
Hanno Beckera0e20d02019-05-15 14:03:01 +01003511#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003512 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3513 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003514 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003515#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3516#endif /* MBEDTLS_SSL_PROTO_DTLS */
3517
3518 size_t rec_hdr_len_offset; /* To be determined */
3519 size_t const rec_hdr_len_len = 2;
3520
3521 /*
3522 * Check minimum lengths for record header.
3523 */
3524
3525#if defined(MBEDTLS_SSL_PROTO_DTLS)
3526 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3527 {
3528 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3529 }
3530 else
3531#endif /* MBEDTLS_SSL_PROTO_DTLS */
3532 {
3533 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3534 }
3535
3536 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3537 {
3538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3539 (unsigned) len,
3540 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3541 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3542 }
3543
3544 /*
3545 * Parse and validate record content type
3546 */
3547
3548 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003549
3550 /* Check record content type */
3551#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3552 rec->cid_len = 0;
3553
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003554 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 ssl->conf->cid_len != 0 &&
3556 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003557 {
3558 /* Shift pointers to account for record header including CID
3559 * struct {
3560 * ContentType special_type = tls12_cid;
3561 * ProtocolVersion version;
3562 * uint16 epoch;
3563 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003564 * opaque cid[cid_length]; // Additional field compared to
3565 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003566 * uint16 length;
3567 * opaque enc_content[DTLSCiphertext.length];
3568 * } DTLSCiphertext;
3569 */
3570
3571 /* So far, we only support static CID lengths
3572 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 rec_hdr_cid_len = ssl->conf->cid_len;
3574 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003575
Hanno Beckere5e7e782019-07-11 12:29:35 +01003576 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003577 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3579 (unsigned) len,
3580 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003581 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003582 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003583
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003584 /* configured CID len is guaranteed at most 255, see
3585 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3586 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003587 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003588 }
3589 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003590#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003591 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 if( ssl_check_record_type( rec->type ) )
3593 {
Hanno Becker54229812019-07-12 14:40:00 +01003594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3595 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3597 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003598 }
3599
Hanno Beckere5e7e782019-07-11 12:29:35 +01003600 /*
3601 * Parse and validate record version
3602 */
3603
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003604 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3605 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003606 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3607 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003608 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003609
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003610 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003611 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3613 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003614 }
3615
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003616 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003617 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3619 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003620 }
3621
Hanno Beckere5e7e782019-07-11 12:29:35 +01003622 /*
3623 * Parse/Copy record sequence number.
3624 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003625
Hanno Beckere5e7e782019-07-11 12:29:35 +01003626#if defined(MBEDTLS_SSL_PROTO_DTLS)
3627 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003628 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003629 /* Copy explicit record sequence number from input buffer. */
3630 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3631 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003632 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003633 else
3634#endif /* MBEDTLS_SSL_PROTO_DTLS */
3635 {
3636 /* Copy implicit record sequence number from SSL context structure. */
3637 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3638 }
Paul Bakker40e46942009-01-03 21:51:57 +00003639
Hanno Beckere5e7e782019-07-11 12:29:35 +01003640 /*
3641 * Parse record length.
3642 */
3643
Hanno Beckere5e7e782019-07-11 12:29:35 +01003644 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003645 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3646 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003648
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003649 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003650 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 rec->type,
3652 major_ver, minor_ver, rec->data_len ) );
3653
3654 rec->buf = buf;
3655 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003656
Hanno Beckerd417cc92019-07-26 08:20:27 +01003657 if( rec->data_len == 0 )
3658 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003659
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003660 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003661 * DTLS-related tests.
3662 * Check epoch before checking length constraint because
3663 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3664 * message gets duplicated before the corresponding Finished message,
3665 * the second ChangeCipherSpec should be discarded because it belongs
3666 * to an old epoch, but not because its length is shorter than
3667 * the minimum record length for packets using the new record transform.
3668 * Note that these two kinds of failures are handled differently,
3669 * as an unexpected record is silently skipped but an invalid
3670 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003671 */
3672#if defined(MBEDTLS_SSL_PROTO_DTLS)
3673 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3674 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003675 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003676
Hanno Becker955a5c92019-07-10 17:12:07 +01003677 /* Check that the datagram is large enough to contain a record
3678 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003679 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003680 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003681 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3682 (unsigned) len,
3683 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003684 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3685 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003686
Hanno Becker37cfe732019-07-10 17:20:01 +01003687 /* Records from other, non-matching epochs are silently discarded.
3688 * (The case of same-port Client reconnects must be considered in
3689 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003690 if( rec_epoch != ssl->in_epoch )
3691 {
3692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3693 "expected %d, received %d",
3694 ssl->in_epoch, rec_epoch ) );
3695
Hanno Becker552f7472019-07-19 10:59:12 +01003696 /* Records from the next epoch are considered for buffering
3697 * (concretely: early Finished messages). */
3698 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003699 {
Hanno Becker552f7472019-07-19 10:59:12 +01003700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3701 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003703
Hanno Becker2fddd372019-07-10 14:37:41 +01003704 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003705 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003706#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003707 /* For records from the correct epoch, check whether their
3708 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003709 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3710 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 {
3712 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3713 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3714 }
3715#endif
3716 }
3717#endif /* MBEDTLS_SSL_PROTO_DTLS */
3718
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003719 return( 0 );
3720}
Paul Bakker5121ce52009-01-03 21:22:43 +00003721
Paul Bakker5121ce52009-01-03 21:22:43 +00003722
Hanno Becker2fddd372019-07-10 14:37:41 +01003723#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3724static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3725{
3726 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3727
3728 /*
3729 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3730 * access the first byte of record content (handshake type), as we
3731 * have an active transform (possibly iv_len != 0), so use the
3732 * fact that the record header len is 13 instead.
3733 */
3734 if( rec_epoch == 0 &&
3735 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3736 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3737 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3738 ssl->in_left > 13 &&
3739 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3740 {
3741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3742 "from the same port" ) );
3743 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003744 }
3745
3746 return( 0 );
3747}
Hanno Becker2fddd372019-07-10 14:37:41 +01003748#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003749
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003750/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003751 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003752 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003753static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3754 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003755{
3756 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003758 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003759 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003761#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3762 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003766 ret = mbedtls_ssl_hw_record_read( ssl );
3767 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003768 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003769 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3770 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003771 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003772
3773 if( ret == 0 )
3774 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003775 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003776#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003777 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003778 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003779 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003780
Hanno Beckera18d1322018-01-03 14:27:32 +00003781 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003782 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003784 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003785
Hanno Beckera0e20d02019-05-15 14:03:01 +01003786#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003787 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3788 ssl->conf->ignore_unexpected_cid
3789 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3790 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003791 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003792 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003793 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003794#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003795
Paul Bakker5121ce52009-01-03 21:22:43 +00003796 return( ret );
3797 }
3798
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003799 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003800 {
3801 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003802 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003803 }
3804
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003805 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003806 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003807
Hanno Beckera0e20d02019-05-15 14:03:01 +01003808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003809 /* We have already checked the record content type
3810 * in ssl_parse_record_header(), failing or silently
3811 * dropping the record in the case of an unknown type.
3812 *
3813 * Since with the use of CIDs, the record content type
3814 * might change during decryption, re-check the record
3815 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003816 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003817 {
3818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3819 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3820 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003821#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003822
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003823 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003824 {
3825#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3826 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003827 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003828 {
3829 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3830 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3831 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3832 }
3833#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3834
3835 ssl->nb_zero++;
3836
3837 /*
3838 * Three or more empty messages may be a DoS attack
3839 * (excessive CPU consumption).
3840 */
3841 if( ssl->nb_zero > 3 )
3842 {
3843 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003844 "messages, possible DoS attack" ) );
3845 /* Treat the records as if they were not properly authenticated,
3846 * thereby failing the connection if we see more than allowed
3847 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003848 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3849 }
3850 }
3851 else
3852 ssl->nb_zero = 0;
3853
3854#if defined(MBEDTLS_SSL_PROTO_DTLS)
3855 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3856 {
3857 ; /* in_ctr read from peer, not maintained internally */
3858 }
3859 else
3860#endif
3861 {
3862 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003863 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003864 if( ++ssl->in_ctr[i - 1] != 0 )
3865 break;
3866
3867 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003868 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003869 {
3870 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3871 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3872 }
3873 }
3874
Paul Bakker5121ce52009-01-03 21:22:43 +00003875 }
3876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003877#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003878 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003880 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003881 }
3882#endif
3883
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003884 /* Check actual (decrypted) record content length against
3885 * configured maximum. */
3886 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3887 {
3888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3889 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3890 }
3891
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003892 return( 0 );
3893}
3894
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003895/*
3896 * Read a record.
3897 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003898 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3899 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3900 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003901 */
Hanno Becker1097b342018-08-15 14:09:41 +01003902
3903/* Helper functions for mbedtls_ssl_read_record(). */
3904static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003905static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3906static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003907
Hanno Becker327c93b2018-08-15 13:56:18 +01003908int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003909 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003910{
Janos Follath865b3eb2019-12-16 11:46:15 +00003911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003914
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003915 if( ssl->keep_current_message == 0 )
3916 {
3917 do {
Simon Butcher99000142016-10-13 17:21:01 +01003918
Hanno Becker26994592018-08-15 14:14:59 +01003919 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003920 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003921 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003922
Hanno Beckere74d5562018-08-15 14:26:08 +01003923 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003924 {
Hanno Becker40f50842018-08-15 14:48:01 +01003925#if defined(MBEDTLS_SSL_PROTO_DTLS)
3926 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003927
Hanno Becker40f50842018-08-15 14:48:01 +01003928 /* We only check for buffered messages if the
3929 * current datagram is fully consumed. */
3930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003931 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003932 {
Hanno Becker40f50842018-08-15 14:48:01 +01003933 if( ssl_load_buffered_message( ssl ) == 0 )
3934 have_buffered = 1;
3935 }
3936
3937 if( have_buffered == 0 )
3938#endif /* MBEDTLS_SSL_PROTO_DTLS */
3939 {
3940 ret = ssl_get_next_record( ssl );
3941 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3942 continue;
3943
3944 if( ret != 0 )
3945 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003946 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003947 return( ret );
3948 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003949 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003950 }
3951
3952 ret = mbedtls_ssl_handle_message_type( ssl );
3953
Hanno Becker40f50842018-08-15 14:48:01 +01003954#if defined(MBEDTLS_SSL_PROTO_DTLS)
3955 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3956 {
3957 /* Buffer future message */
3958 ret = ssl_buffer_message( ssl );
3959 if( ret != 0 )
3960 return( ret );
3961
3962 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3963 }
3964#endif /* MBEDTLS_SSL_PROTO_DTLS */
3965
Hanno Becker90333da2017-10-10 11:27:13 +01003966 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3967 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003968
3969 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003970 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003971 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003972 return( ret );
3973 }
3974
Hanno Becker327c93b2018-08-15 13:56:18 +01003975 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003976 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003977 {
3978 mbedtls_ssl_update_handshake_status( ssl );
3979 }
Simon Butcher99000142016-10-13 17:21:01 +01003980 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003981 else
Simon Butcher99000142016-10-13 17:21:01 +01003982 {
Hanno Becker02f59072018-08-15 14:00:24 +01003983 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003984 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003985 }
3986
3987 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3988
3989 return( 0 );
3990}
3991
Hanno Becker40f50842018-08-15 14:48:01 +01003992#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003993static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003994{
Hanno Becker40f50842018-08-15 14:48:01 +01003995 if( ssl->in_left > ssl->next_record_offset )
3996 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003997
Hanno Becker40f50842018-08-15 14:48:01 +01003998 return( 0 );
3999}
4000
4001static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4002{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004003 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004004 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004005 int ret = 0;
4006
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004007 if( hs == NULL )
4008 return( -1 );
4009
Hanno Beckere00ae372018-08-20 09:39:42 +01004010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4011
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004012 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4013 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4014 {
4015 /* Check if we have seen a ChangeCipherSpec before.
4016 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004017 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004018 {
4019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4020 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004021 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004022 }
4023
Hanno Becker39b8bc92018-08-28 17:17:13 +01004024 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004025 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4026 ssl->in_msglen = 1;
4027 ssl->in_msg[0] = 1;
4028
4029 /* As long as they are equal, the exact value doesn't matter. */
4030 ssl->in_left = 0;
4031 ssl->next_record_offset = 0;
4032
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004033 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004034 goto exit;
4035 }
Hanno Becker37f95322018-08-16 13:55:32 +01004036
Hanno Beckerb8f50142018-08-28 10:01:34 +01004037#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004038 /* Debug only */
4039 {
4040 unsigned offset;
4041 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4042 {
4043 hs_buf = &hs->buffering.hs[offset];
4044 if( hs_buf->is_valid == 1 )
4045 {
4046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4047 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004048 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004049 }
4050 }
4051 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004052#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004053
4054 /* Check if we have buffered and/or fully reassembled the
4055 * next handshake message. */
4056 hs_buf = &hs->buffering.hs[0];
4057 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4058 {
4059 /* Synthesize a record containing the buffered HS message. */
4060 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4061 ( hs_buf->data[2] << 8 ) |
4062 hs_buf->data[3];
4063
4064 /* Double-check that we haven't accidentally buffered
4065 * a message that doesn't fit into the input buffer. */
4066 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4067 {
4068 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4069 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4070 }
4071
4072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4073 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4074 hs_buf->data, msg_len + 12 );
4075
4076 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4077 ssl->in_hslen = msg_len + 12;
4078 ssl->in_msglen = msg_len + 12;
4079 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4080
4081 ret = 0;
4082 goto exit;
4083 }
4084 else
4085 {
4086 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4087 hs->in_msg_seq ) );
4088 }
4089
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004090 ret = -1;
4091
4092exit:
4093
4094 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4095 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004096}
4097
Hanno Beckera02b0b42018-08-21 17:20:27 +01004098static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4099 size_t desired )
4100{
4101 int offset;
4102 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4104 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004105
Hanno Becker01315ea2018-08-21 17:22:17 +01004106 /* Get rid of future records epoch first, if such exist. */
4107 ssl_free_buffered_record( ssl );
4108
4109 /* Check if we have enough space available now. */
4110 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4111 hs->buffering.total_bytes_buffered ) )
4112 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004113 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004114 return( 0 );
4115 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004116
Hanno Becker4f432ad2018-08-28 10:02:32 +01004117 /* We don't have enough space to buffer the next expected handshake
4118 * message. Remove buffers used for future messages to gain space,
4119 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004120 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4121 offset >= 0; offset-- )
4122 {
4123 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4124 offset ) );
4125
Hanno Beckerb309b922018-08-23 13:18:05 +01004126 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004127
4128 /* Check if we have enough space available now. */
4129 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4130 hs->buffering.total_bytes_buffered ) )
4131 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004133 return( 0 );
4134 }
4135 }
4136
4137 return( -1 );
4138}
4139
Hanno Becker40f50842018-08-15 14:48:01 +01004140static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4141{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004142 int ret = 0;
4143 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4144
4145 if( hs == NULL )
4146 return( 0 );
4147
4148 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4149
4150 switch( ssl->in_msgtype )
4151 {
4152 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4153 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004154
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004155 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004156 break;
4157
4158 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004159 {
4160 unsigned recv_msg_seq_offset;
4161 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4162 mbedtls_ssl_hs_buffer *hs_buf;
4163 size_t msg_len = ssl->in_hslen - 12;
4164
4165 /* We should never receive an old handshake
4166 * message - double-check nonetheless. */
4167 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4168 {
4169 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4170 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4171 }
4172
4173 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4174 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4175 {
4176 /* Silently ignore -- message too far in the future */
4177 MBEDTLS_SSL_DEBUG_MSG( 2,
4178 ( "Ignore future HS message with sequence number %u, "
4179 "buffering window %u - %u",
4180 recv_msg_seq, ssl->handshake->in_msg_seq,
4181 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4182
4183 goto exit;
4184 }
4185
4186 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4187 recv_msg_seq, recv_msg_seq_offset ) );
4188
4189 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4190
4191 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004192 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004193 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004194 size_t reassembly_buf_sz;
4195
Hanno Becker37f95322018-08-16 13:55:32 +01004196 hs_buf->is_fragmented =
4197 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4198
4199 /* We copy the message back into the input buffer
4200 * after reassembly, so check that it's not too large.
4201 * This is an implementation-specific limitation
4202 * and not one from the standard, hence it is not
4203 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004204 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004205 {
4206 /* Ignore message */
4207 goto exit;
4208 }
4209
Hanno Beckere0b150f2018-08-21 15:51:03 +01004210 /* Check if we have enough space to buffer the message. */
4211 if( hs->buffering.total_bytes_buffered >
4212 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4213 {
4214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4215 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4216 }
4217
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004218 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4219 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004220
4221 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4222 hs->buffering.total_bytes_buffered ) )
4223 {
4224 if( recv_msg_seq_offset > 0 )
4225 {
4226 /* If we can't buffer a future message because
4227 * of space limitations -- ignore. */
4228 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",
4229 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4230 (unsigned) hs->buffering.total_bytes_buffered ) );
4231 goto exit;
4232 }
Hanno Beckere1801392018-08-21 16:51:05 +01004233 else
4234 {
4235 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",
4236 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4237 (unsigned) hs->buffering.total_bytes_buffered ) );
4238 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004239
Hanno Beckera02b0b42018-08-21 17:20:27 +01004240 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004241 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004242 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",
4243 (unsigned) msg_len,
4244 (unsigned) reassembly_buf_sz,
4245 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004246 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004247 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4248 goto exit;
4249 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004250 }
4251
4252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4253 msg_len ) );
4254
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004255 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4256 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004257 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004258 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004259 goto exit;
4260 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004261 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004262
4263 /* Prepare final header: copy msg_type, length and message_seq,
4264 * then add standardised fragment_offset and fragment_length */
4265 memcpy( hs_buf->data, ssl->in_msg, 6 );
4266 memset( hs_buf->data + 6, 0, 3 );
4267 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4268
4269 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004270
4271 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004272 }
4273 else
4274 {
4275 /* Make sure msg_type and length are consistent */
4276 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4277 {
4278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4279 /* Ignore */
4280 goto exit;
4281 }
4282 }
4283
Hanno Becker4422bbb2018-08-20 09:40:19 +01004284 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004285 {
4286 size_t frag_len, frag_off;
4287 unsigned char * const msg = hs_buf->data + 12;
4288
4289 /*
4290 * Check and copy current fragment
4291 */
4292
4293 /* Validation of header fields already done in
4294 * mbedtls_ssl_prepare_handshake_record(). */
4295 frag_off = ssl_get_hs_frag_off( ssl );
4296 frag_len = ssl_get_hs_frag_len( ssl );
4297
4298 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4299 frag_off, frag_len ) );
4300 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4301
4302 if( hs_buf->is_fragmented )
4303 {
4304 unsigned char * const bitmask = msg + msg_len;
4305 ssl_bitmask_set( bitmask, frag_off, frag_len );
4306 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4307 msg_len ) == 0 );
4308 }
4309 else
4310 {
4311 hs_buf->is_complete = 1;
4312 }
4313
4314 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4315 hs_buf->is_complete ? "" : "not yet " ) );
4316 }
4317
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004318 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004319 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004320
4321 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004322 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004323 break;
4324 }
4325
4326exit:
4327
4328 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4329 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004330}
4331#endif /* MBEDTLS_SSL_PROTO_DTLS */
4332
Hanno Becker1097b342018-08-15 14:09:41 +01004333static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004334{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004335 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004336 * Consume last content-layer message and potentially
4337 * update in_msglen which keeps track of the contents'
4338 * consumption state.
4339 *
4340 * (1) Handshake messages:
4341 * Remove last handshake message, move content
4342 * and adapt in_msglen.
4343 *
4344 * (2) Alert messages:
4345 * Consume whole record content, in_msglen = 0.
4346 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004347 * (3) Change cipher spec:
4348 * Consume whole record content, in_msglen = 0.
4349 *
4350 * (4) Application data:
4351 * Don't do anything - the record layer provides
4352 * the application data as a stream transport
4353 * and consumes through mbedtls_ssl_read only.
4354 *
4355 */
4356
4357 /* Case (1): Handshake messages */
4358 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004359 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004360 /* Hard assertion to be sure that no application data
4361 * is in flight, as corrupting ssl->in_msglen during
4362 * ssl->in_offt != NULL is fatal. */
4363 if( ssl->in_offt != NULL )
4364 {
4365 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4366 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4367 }
4368
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004369 /*
4370 * Get next Handshake message in the current record
4371 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004372
Hanno Becker4a810fb2017-05-24 16:27:30 +01004373 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004374 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004375 * current handshake content: If DTLS handshake
4376 * fragmentation is used, that's the fragment
4377 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004378 * size here is faulty and should be changed at
4379 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004380 * (2) While it doesn't seem to cause problems, one
4381 * has to be very careful not to assume that in_hslen
4382 * is always <= in_msglen in a sensible communication.
4383 * Again, it's wrong for DTLS handshake fragmentation.
4384 * The following check is therefore mandatory, and
4385 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004386 * Additionally, ssl->in_hslen might be arbitrarily out of
4387 * bounds after handling a DTLS message with an unexpected
4388 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004389 */
4390 if( ssl->in_hslen < ssl->in_msglen )
4391 {
4392 ssl->in_msglen -= ssl->in_hslen;
4393 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4394 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004395
Hanno Becker4a810fb2017-05-24 16:27:30 +01004396 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4397 ssl->in_msg, ssl->in_msglen );
4398 }
4399 else
4400 {
4401 ssl->in_msglen = 0;
4402 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004403
Hanno Becker4a810fb2017-05-24 16:27:30 +01004404 ssl->in_hslen = 0;
4405 }
4406 /* Case (4): Application data */
4407 else if( ssl->in_offt != NULL )
4408 {
4409 return( 0 );
4410 }
4411 /* Everything else (CCS & Alerts) */
4412 else
4413 {
4414 ssl->in_msglen = 0;
4415 }
4416
Hanno Becker1097b342018-08-15 14:09:41 +01004417 return( 0 );
4418}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004419
Hanno Beckere74d5562018-08-15 14:26:08 +01004420static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4421{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004422 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004423 return( 1 );
4424
4425 return( 0 );
4426}
4427
Hanno Becker5f066e72018-08-16 14:56:31 +01004428#if defined(MBEDTLS_SSL_PROTO_DTLS)
4429
4430static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4431{
4432 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4433 if( hs == NULL )
4434 return;
4435
Hanno Becker01315ea2018-08-21 17:22:17 +01004436 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004437 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004438 hs->buffering.total_bytes_buffered -=
4439 hs->buffering.future_record.len;
4440
4441 mbedtls_free( hs->buffering.future_record.data );
4442 hs->buffering.future_record.data = NULL;
4443 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004444}
4445
4446static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4447{
4448 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4449 unsigned char * rec;
4450 size_t rec_len;
4451 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004452#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4453 size_t in_buf_len = ssl->in_buf_len;
4454#else
4455 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4456#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004457 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4458 return( 0 );
4459
4460 if( hs == NULL )
4461 return( 0 );
4462
Hanno Becker5f066e72018-08-16 14:56:31 +01004463 rec = hs->buffering.future_record.data;
4464 rec_len = hs->buffering.future_record.len;
4465 rec_epoch = hs->buffering.future_record.epoch;
4466
4467 if( rec == NULL )
4468 return( 0 );
4469
Hanno Becker4cb782d2018-08-20 11:19:05 +01004470 /* Only consider loading future records if the
4471 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004472 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004473 return( 0 );
4474
Hanno Becker5f066e72018-08-16 14:56:31 +01004475 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4476
4477 if( rec_epoch != ssl->in_epoch )
4478 {
4479 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4480 goto exit;
4481 }
4482
4483 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4484
4485 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004486 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004487 {
4488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4489 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4490 }
4491
4492 memcpy( ssl->in_hdr, rec, rec_len );
4493 ssl->in_left = rec_len;
4494 ssl->next_record_offset = 0;
4495
4496 ssl_free_buffered_record( ssl );
4497
4498exit:
4499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4500 return( 0 );
4501}
4502
Hanno Becker519f15d2019-07-11 12:43:20 +01004503static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4504 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004505{
4506 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004507
4508 /* Don't buffer future records outside handshakes. */
4509 if( hs == NULL )
4510 return( 0 );
4511
4512 /* Only buffer handshake records (we are only interested
4513 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004514 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004515 return( 0 );
4516
4517 /* Don't buffer more than one future epoch record. */
4518 if( hs->buffering.future_record.data != NULL )
4519 return( 0 );
4520
Hanno Becker01315ea2018-08-21 17:22:17 +01004521 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004522 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004523 hs->buffering.total_bytes_buffered ) )
4524 {
4525 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 +01004526 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004527 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004528 return( 0 );
4529 }
4530
Hanno Becker5f066e72018-08-16 14:56:31 +01004531 /* Buffer record */
4532 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4533 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004534 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004535
4536 /* ssl_parse_record_header() only considers records
4537 * of the next epoch as candidates for buffering. */
4538 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004539 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004540
4541 hs->buffering.future_record.data =
4542 mbedtls_calloc( 1, hs->buffering.future_record.len );
4543 if( hs->buffering.future_record.data == NULL )
4544 {
4545 /* If we run out of RAM trying to buffer a
4546 * record from the next epoch, just ignore. */
4547 return( 0 );
4548 }
4549
Hanno Becker519f15d2019-07-11 12:43:20 +01004550 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004551
Hanno Becker519f15d2019-07-11 12:43:20 +01004552 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004553 return( 0 );
4554}
4555
4556#endif /* MBEDTLS_SSL_PROTO_DTLS */
4557
Hanno Beckere74d5562018-08-15 14:26:08 +01004558static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004559{
Janos Follath865b3eb2019-12-16 11:46:15 +00004560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004561 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004562
Hanno Becker5f066e72018-08-16 14:56:31 +01004563#if defined(MBEDTLS_SSL_PROTO_DTLS)
4564 /* We might have buffered a future record; if so,
4565 * and if the epoch matches now, load it.
4566 * On success, this call will set ssl->in_left to
4567 * the length of the buffered record, so that
4568 * the calls to ssl_fetch_input() below will
4569 * essentially be no-ops. */
4570 ret = ssl_load_buffered_record( ssl );
4571 if( ret != 0 )
4572 return( ret );
4573#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004574
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004575 /* Ensure that we have enough space available for the default form
4576 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4577 * with no space for CIDs counted in). */
4578 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4579 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004582 return( ret );
4583 }
4584
Hanno Beckere5e7e782019-07-11 12:29:35 +01004585 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4586 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004588#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004589 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004590 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004591 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4592 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004593 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004594 if( ret != 0 )
4595 return( ret );
4596
4597 /* Fall through to handling of unexpected records */
4598 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4599 }
4600
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004601 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4602 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004603#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004604 /* Reset in pointers to default state for TLS/DTLS records,
4605 * assuming no CID and no offset between record content and
4606 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004607 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004608
Hanno Becker7ae20e02019-07-12 08:33:49 +01004609 /* Setup internal message pointers from record structure. */
4610 ssl->in_msgtype = rec.type;
4611#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4612 ssl->in_len = ssl->in_cid + rec.cid_len;
4613#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4614 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4615 ssl->in_msglen = rec.data_len;
4616
Hanno Becker2fddd372019-07-10 14:37:41 +01004617 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004618 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004619 if( ret != 0 )
4620 return( ret );
4621#endif
4622
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004623 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004624 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004625
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4627 "(header)" ) );
4628 }
4629 else
4630 {
4631 /* Skip invalid record and the rest of the datagram */
4632 ssl->next_record_offset = 0;
4633 ssl->in_left = 0;
4634
4635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4636 "(header)" ) );
4637 }
4638
4639 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004640 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004641 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004642 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004643#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004644 {
4645 return( ret );
4646 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004647 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004650 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004651 {
Hanno Beckera8814792019-07-10 15:01:45 +01004652 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004653 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004654 if( ssl->next_record_offset < ssl->in_left )
4655 {
4656 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4657 }
4658 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004659 else
4660#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004661 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004662 /*
4663 * Fetch record contents from underlying transport.
4664 */
Hanno Beckera3175662019-07-11 12:50:29 +01004665 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004666 if( ret != 0 )
4667 {
4668 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4669 return( ret );
4670 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004671
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004672 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004673 }
4674
4675 /*
4676 * Decrypt record contents.
4677 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004678
Hanno Beckerfdf66042019-07-11 13:07:45 +01004679 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004680 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004681#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004682 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004683 {
4684 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004685 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004686 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004687 /* Except when waiting for Finished as a bad mac here
4688 * probably means something went wrong in the handshake
4689 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4690 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4691 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4692 {
4693#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4694 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4695 {
4696 mbedtls_ssl_send_alert_message( ssl,
4697 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4698 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4699 }
4700#endif
4701 return( ret );
4702 }
4703
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004704#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004705 if( ssl->conf->badmac_limit != 0 &&
4706 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4709 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004710 }
4711#endif
4712
Hanno Becker4a810fb2017-05-24 16:27:30 +01004713 /* As above, invalid records cause
4714 * dismissal of the whole datagram. */
4715
4716 ssl->next_record_offset = 0;
4717 ssl->in_left = 0;
4718
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004720 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004721 }
4722
4723 return( ret );
4724 }
4725 else
4726#endif
4727 {
4728 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4730 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004731 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732 mbedtls_ssl_send_alert_message( ssl,
4733 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4734 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004735 }
4736#endif
4737 return( ret );
4738 }
4739 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004740
Hanno Becker44d89b22019-07-12 09:40:44 +01004741
4742 /* Reset in pointers to default state for TLS/DTLS records,
4743 * assuming no CID and no offset between record content and
4744 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004745 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004746#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4747 ssl->in_len = ssl->in_cid + rec.cid_len;
4748#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004749 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004750
Hanno Becker8685c822019-07-12 09:37:30 +01004751 /* The record content type may change during decryption,
4752 * so re-read it. */
4753 ssl->in_msgtype = rec.type;
4754 /* Also update the input buffer, because unfortunately
4755 * the server-side ssl_parse_client_hello() reparses the
4756 * record header when receiving a ClientHello initiating
4757 * a renegotiation. */
4758 ssl->in_hdr[0] = rec.type;
4759 ssl->in_msg = rec.buf + rec.data_offset;
4760 ssl->in_msglen = rec.data_len;
4761 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4762 ssl->in_len[1] = (unsigned char)( rec.data_len );
4763
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004764#if defined(MBEDTLS_ZLIB_SUPPORT)
4765 if( ssl->transform_in != NULL &&
4766 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4767 {
4768 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4769 {
4770 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4771 return( ret );
4772 }
4773
4774 /* Check actual (decompress) record content length against
4775 * configured maximum. */
4776 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4777 {
4778 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4779 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4780 }
4781 }
4782#endif /* MBEDTLS_ZLIB_SUPPORT */
4783
Simon Butcher99000142016-10-13 17:21:01 +01004784 return( 0 );
4785}
4786
4787int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4788{
Janos Follath865b3eb2019-12-16 11:46:15 +00004789 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004790
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004791 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004792 * Handle particular types of records
4793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004795 {
Simon Butcher99000142016-10-13 17:21:01 +01004796 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4797 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004798 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004799 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004800 }
4801
Hanno Beckere678eaa2018-08-21 14:57:46 +01004802 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004803 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004804 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004805 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4807 ssl->in_msglen ) );
4808 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004809 }
4810
Hanno Beckere678eaa2018-08-21 14:57:46 +01004811 if( ssl->in_msg[0] != 1 )
4812 {
4813 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4814 ssl->in_msg[0] ) );
4815 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4816 }
4817
4818#if defined(MBEDTLS_SSL_PROTO_DTLS)
4819 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4820 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4821 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4822 {
4823 if( ssl->handshake == NULL )
4824 {
4825 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4826 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4827 }
4828
4829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4830 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4831 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004832#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004833 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004835 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004836 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004837 if( ssl->in_msglen != 2 )
4838 {
4839 /* Note: Standard allows for more than one 2 byte alert
4840 to be packed in a single message, but Mbed TLS doesn't
4841 currently support this. */
4842 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4843 ssl->in_msglen ) );
4844 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4845 }
4846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004848 ssl->in_msg[0], ssl->in_msg[1] ) );
4849
4850 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004851 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004852 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004853 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004854 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004856 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004858 }
4859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4861 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004862 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4864 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004865 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004866
4867#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4868 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4869 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4870 {
Hanno Becker90333da2017-10-10 11:27:13 +01004871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004872 /* Will be handled when trying to parse ServerHello */
4873 return( 0 );
4874 }
4875#endif
4876
4877#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4878 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4879 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4880 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4881 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4882 {
4883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4884 /* Will be handled in mbedtls_ssl_parse_certificate() */
4885 return( 0 );
4886 }
4887#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4888
4889 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004890 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004891 }
4892
Hanno Beckerc76c6192017-06-06 10:03:17 +01004893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004894 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004895 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004896 /* Drop unexpected ApplicationData records,
4897 * except at the beginning of renegotiations */
4898 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4899 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4900#if defined(MBEDTLS_SSL_RENEGOTIATION)
4901 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4902 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004903#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004904 )
4905 {
4906 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4907 return( MBEDTLS_ERR_SSL_NON_FATAL );
4908 }
4909
4910 if( ssl->handshake != NULL &&
4911 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4912 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004913 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004914 }
4915 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004916#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004917
Paul Bakker5121ce52009-01-03 21:22:43 +00004918 return( 0 );
4919}
4920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004922{
irwir6c0da642019-09-26 21:07:41 +03004923 return( mbedtls_ssl_send_alert_message( ssl,
4924 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4925 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004926}
4927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004928int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004929 unsigned char level,
4930 unsigned char message )
4931{
Janos Follath865b3eb2019-12-16 11:46:15 +00004932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004933
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004934 if( ssl == NULL || ssl->conf == NULL )
4935 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004938 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004939
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004941 ssl->out_msglen = 2;
4942 ssl->out_msg[0] = level;
4943 ssl->out_msg[1] = message;
4944
Hanno Becker67bc7c32018-08-06 11:33:50 +01004945 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004946 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004947 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004948 return( ret );
4949 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004951
4952 return( 0 );
4953}
4954
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004956{
Janos Follath865b3eb2019-12-16 11:46:15 +00004957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004961 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004962 ssl->out_msglen = 1;
4963 ssl->out_msg[0] = 1;
4964
Paul Bakker5121ce52009-01-03 21:22:43 +00004965 ssl->state++;
4966
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004967 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004968 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004969 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004970 return( ret );
4971 }
4972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004974
4975 return( 0 );
4976}
4977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004978int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004979{
Janos Follath865b3eb2019-12-16 11:46:15 +00004980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004983
Hanno Becker327c93b2018-08-15 13:56:18 +01004984 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004985 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004987 return( ret );
4988 }
4989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004991 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004993 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4994 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004995 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004996 }
4997
Hanno Beckere678eaa2018-08-21 14:57:46 +01004998 /* CCS records are only accepted if they have length 1 and content '1',
4999 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005000
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005001 /*
5002 * Switch to our negotiated transform and session parameters for inbound
5003 * data.
5004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005006 ssl->transform_in = ssl->transform_negotiate;
5007 ssl->session_in = ssl->session_negotiate;
5008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005009#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005010 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005011 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005012#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005013 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005014#endif
5015
5016 /* Increment epoch */
5017 if( ++ssl->in_epoch == 0 )
5018 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005019 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005020 /* This is highly unlikely to happen for legitimate reasons, so
5021 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005023 }
5024 }
5025 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005026#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005027 memset( ssl->in_ctr, 0, 8 );
5028
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005029 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5032 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005033 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005034 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005035 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005036 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005037 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5038 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005039 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005040 }
5041 }
5042#endif
5043
Paul Bakker5121ce52009-01-03 21:22:43 +00005044 ssl->state++;
5045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005047
5048 return( 0 );
5049}
5050
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005051/* Once ssl->out_hdr as the address of the beginning of the
5052 * next outgoing record is set, deduce the other pointers.
5053 *
5054 * Note: For TLS, we save the implicit record sequence number
5055 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5056 * and the caller has to make sure there's space for this.
5057 */
5058
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005059static size_t ssl_transform_get_explicit_iv_len(
5060 mbedtls_ssl_transform const *transform )
5061{
5062 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5063 return( 0 );
5064
5065 return( transform->ivlen - transform->fixed_ivlen );
5066}
5067
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005068void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5069 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005070{
5071#if defined(MBEDTLS_SSL_PROTO_DTLS)
5072 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5073 {
5074 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005076 ssl->out_cid = ssl->out_ctr + 8;
5077 ssl->out_len = ssl->out_cid;
5078 if( transform != NULL )
5079 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005080#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005081 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005082#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005083 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005084 }
5085 else
5086#endif
5087 {
5088 ssl->out_ctr = ssl->out_hdr - 8;
5089 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005090#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005091 ssl->out_cid = ssl->out_len;
5092#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005093 ssl->out_iv = ssl->out_hdr + 5;
5094 }
5095
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005096 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005097 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005098 if( transform != NULL )
5099 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005100}
5101
5102/* Once ssl->in_hdr as the address of the beginning of the
5103 * next incoming record is set, deduce the other pointers.
5104 *
5105 * Note: For TLS, we save the implicit record sequence number
5106 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5107 * and the caller has to make sure there's space for this.
5108 */
5109
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005110void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005111{
Hanno Becker79594fd2019-05-08 09:38:41 +01005112 /* This function sets the pointers to match the case
5113 * of unprotected TLS/DTLS records, with both ssl->in_iv
5114 * and ssl->in_msg pointing to the beginning of the record
5115 * content.
5116 *
5117 * When decrypting a protected record, ssl->in_msg
5118 * will be shifted to point to the beginning of the
5119 * record plaintext.
5120 */
5121
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005122#if defined(MBEDTLS_SSL_PROTO_DTLS)
5123 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5124 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005125 /* This sets the header pointers to match records
5126 * without CID. When we receive a record containing
5127 * a CID, the fields are shifted accordingly in
5128 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005129 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005130#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005131 ssl->in_cid = ssl->in_ctr + 8;
5132 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005133#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005134 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005135#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005136 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005137 }
5138 else
5139#endif
5140 {
5141 ssl->in_ctr = ssl->in_hdr - 8;
5142 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005143#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005144 ssl->in_cid = ssl->in_len;
5145#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005146 ssl->in_iv = ssl->in_hdr + 5;
5147 }
5148
Hanno Becker79594fd2019-05-08 09:38:41 +01005149 /* This will be adjusted at record decryption time. */
5150 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005151}
5152
Paul Bakker5121ce52009-01-03 21:22:43 +00005153/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005154 * Setup an SSL context
5155 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005156
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005157void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005158{
5159 /* Set the incoming and outgoing record pointers. */
5160#if defined(MBEDTLS_SSL_PROTO_DTLS)
5161 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5162 {
5163 ssl->out_hdr = ssl->out_buf;
5164 ssl->in_hdr = ssl->in_buf;
5165 }
5166 else
5167#endif /* MBEDTLS_SSL_PROTO_DTLS */
5168 {
5169 ssl->out_hdr = ssl->out_buf + 8;
5170 ssl->in_hdr = ssl->in_buf + 8;
5171 }
5172
5173 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005174 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5175 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005176}
5177
Paul Bakker5121ce52009-01-03 21:22:43 +00005178/*
5179 * SSL get accessors
5180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005182{
5183 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5184}
5185
Hanno Becker8b170a02017-10-10 11:51:19 +01005186int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5187{
5188 /*
5189 * Case A: We're currently holding back
5190 * a message for further processing.
5191 */
5192
5193 if( ssl->keep_current_message == 1 )
5194 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005195 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005196 return( 1 );
5197 }
5198
5199 /*
5200 * Case B: Further records are pending in the current datagram.
5201 */
5202
5203#if defined(MBEDTLS_SSL_PROTO_DTLS)
5204 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5205 ssl->in_left > ssl->next_record_offset )
5206 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005207 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005208 return( 1 );
5209 }
5210#endif /* MBEDTLS_SSL_PROTO_DTLS */
5211
5212 /*
5213 * Case C: A handshake message is being processed.
5214 */
5215
Hanno Becker8b170a02017-10-10 11:51:19 +01005216 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5217 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005218 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005219 return( 1 );
5220 }
5221
5222 /*
5223 * Case D: An application data message is being processed
5224 */
5225 if( ssl->in_offt != NULL )
5226 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005227 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005228 return( 1 );
5229 }
5230
5231 /*
5232 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005233 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005234 * we implement support for multiple alerts in single records.
5235 */
5236
5237 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5238 return( 0 );
5239}
5240
Paul Bakker43ca69c2011-01-15 17:35:19 +00005241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005243{
Hanno Becker3136ede2018-08-17 15:28:19 +01005244 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005245 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005246 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005247
Hanno Becker5903de42019-05-03 14:46:38 +01005248 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5249
Hanno Becker78640902018-08-13 16:35:15 +01005250 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005251 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005253#if defined(MBEDTLS_ZLIB_SUPPORT)
5254 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5255 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005256#endif
5257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005258 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005260 case MBEDTLS_MODE_GCM:
5261 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005262 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005264 transform_expansion = transform->minlen;
5265 break;
5266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005268
5269 block_size = mbedtls_cipher_get_block_size(
5270 &transform->cipher_ctx_enc );
5271
Hanno Becker3136ede2018-08-17 15:28:19 +01005272 /* Expansion due to the addition of the MAC. */
5273 transform_expansion += transform->maclen;
5274
5275 /* Expansion due to the addition of CBC padding;
5276 * Theoretically up to 256 bytes, but we never use
5277 * more than the block size of the underlying cipher. */
5278 transform_expansion += block_size;
5279
5280 /* For TLS 1.1 or higher, an explicit IV is added
5281 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005282#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5283 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005284 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005285#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005286
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005287 break;
5288
5289 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005290 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005291 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005292 }
5293
Hanno Beckera0e20d02019-05-15 14:03:01 +01005294#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005295 if( transform->out_cid_len != 0 )
5296 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005297#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005298
Hanno Becker5903de42019-05-03 14:46:38 +01005299 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005300}
5301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005302#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005303/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005304 * Check record counters and renegotiate if they're above the limit.
5305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005306static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005307{
Hanno Beckerdd772292020-02-05 10:38:31 +00005308 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005309 int in_ctr_cmp;
5310 int out_ctr_cmp;
5311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005312 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5313 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005314 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005315 {
5316 return( 0 );
5317 }
5318
Andres AG2196c7f2016-12-15 17:01:16 +00005319 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5320 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005321 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005322 ssl->conf->renego_period + ep_len, 8 - ep_len );
5323
5324 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005325 {
5326 return( 0 );
5327 }
5328
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005331}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005332#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005333
5334/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005335 * Receive application data decrypted from the SSL layer
5336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005338{
Janos Follath865b3eb2019-12-16 11:46:15 +00005339 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005340 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005341
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005342 if( ssl == NULL || ssl->conf == NULL )
5343 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005347#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005348 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005351 return( ret );
5352
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005353 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005355 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005356 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005357 return( ret );
5358 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005359 }
5360#endif
5361
Hanno Becker4a810fb2017-05-24 16:27:30 +01005362 /*
5363 * Check if renegotiation is necessary and/or handshake is
5364 * in process. If yes, perform/continue, and fall through
5365 * if an unexpected packet is received while the client
5366 * is waiting for the ServerHello.
5367 *
5368 * (There is no equivalent to the last condition on
5369 * the server-side as it is not treated as within
5370 * a handshake while waiting for the ClientHello
5371 * after a renegotiation request.)
5372 */
5373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005374#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005375 ret = ssl_check_ctr_renegotiate( ssl );
5376 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5377 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005379 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005380 return( ret );
5381 }
5382#endif
5383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005384 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005387 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5388 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005390 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005391 return( ret );
5392 }
5393 }
5394
Hanno Beckere41158b2017-10-23 13:30:32 +01005395 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005396 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005397 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005398 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005399 if( ssl->f_get_timer != NULL &&
5400 ssl->f_get_timer( ssl->p_timer ) == -1 )
5401 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005402 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005403 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005404
Hanno Becker327c93b2018-08-15 13:56:18 +01005405 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005406 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005407 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5408 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005409
Hanno Becker4a810fb2017-05-24 16:27:30 +01005410 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5411 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005412 }
5413
5414 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005415 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005416 {
5417 /*
5418 * OpenSSL sends empty messages to randomize the IV
5419 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005420 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005421 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005423 return( 0 );
5424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005426 return( ret );
5427 }
5428 }
5429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005431 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005432 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005433
Hanno Becker4a810fb2017-05-24 16:27:30 +01005434 /*
5435 * - For client-side, expect SERVER_HELLO_REQUEST.
5436 * - For server-side, expect CLIENT_HELLO.
5437 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5438 */
5439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005440#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005441 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005443 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005444 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005446
5447 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005448#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005449 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005450 {
5451 continue;
5452 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005453#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005455 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005456#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005457
Hanno Becker4a810fb2017-05-24 16:27:30 +01005458#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005459 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005460 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005463
5464 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005465#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005466 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005467 {
5468 continue;
5469 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005470#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005472 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005473#endif /* MBEDTLS_SSL_SRV_C */
5474
Hanno Becker21df7f92017-10-17 11:03:26 +01005475#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005476 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005477 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5478 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5479 ssl->conf->allow_legacy_renegotiation ==
5480 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5481 {
5482 /*
5483 * Accept renegotiation request
5484 */
Paul Bakker48916f92012-09-16 19:57:18 +00005485
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005486 /* DTLS clients need to know renego is server-initiated */
5487#if defined(MBEDTLS_SSL_PROTO_DTLS)
5488 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5489 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5490 {
5491 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5492 }
5493#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005494 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005495 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5496 ret != 0 )
5497 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005498 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5499 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005500 return( ret );
5501 }
5502 }
5503 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005504#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005505 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005506 /*
5507 * Refuse renegotiation
5508 */
5509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005512#if defined(MBEDTLS_SSL_PROTO_SSL3)
5513 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005514 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005515 /* SSLv3 does not have a "no_renegotiation" warning, so
5516 we send a fatal alert and abort the connection. */
5517 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5518 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5519 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005520 }
5521 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005522#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5523#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5524 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5525 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005526 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005527 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5528 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5529 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005530 {
5531 return( ret );
5532 }
Paul Bakker48916f92012-09-16 19:57:18 +00005533 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005534 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5536 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5539 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005540 }
Paul Bakker48916f92012-09-16 19:57:18 +00005541 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005542
Hanno Becker90333da2017-10-10 11:27:13 +01005543 /* At this point, we don't know whether the renegotiation has been
5544 * completed or not. The cases to consider are the following:
5545 * 1) The renegotiation is complete. In this case, no new record
5546 * has been read yet.
5547 * 2) The renegotiation is incomplete because the client received
5548 * an application data record while awaiting the ServerHello.
5549 * 3) The renegotiation is incomplete because the client received
5550 * a non-handshake, non-application data message while awaiting
5551 * the ServerHello.
5552 * In each of these case, looping will be the proper action:
5553 * - For 1), the next iteration will read a new record and check
5554 * if it's application data.
5555 * - For 2), the loop condition isn't satisfied as application data
5556 * is present, hence continue is the same as break
5557 * - For 3), the loop condition is satisfied and read_record
5558 * will re-deliver the message that was held back by the client
5559 * when expecting the ServerHello.
5560 */
5561 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005562 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005563#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005564 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005565 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005566 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005567 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005568 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005569 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005570 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005571 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005572 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005573 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005574 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005575 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005578 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5579 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005581 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005582 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005583 }
5584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005585 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005586 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5588 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005589 }
5590
5591 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005592
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005593 /* We're going to return something now, cancel timer,
5594 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005596 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005597
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005598#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005599 /* If we requested renego but received AppData, resend HelloRequest.
5600 * Do it now, after setting in_offt, to avoid taking this branch
5601 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005602#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005603 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005604 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005605 {
Hanno Becker786300f2020-02-05 10:46:40 +00005606 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005607 {
Hanno Becker786300f2020-02-05 10:46:40 +00005608 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5609 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005610 return( ret );
5611 }
5612 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005614#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005615 }
5616
5617 n = ( len < ssl->in_msglen )
5618 ? len : ssl->in_msglen;
5619
5620 memcpy( buf, ssl->in_offt, n );
5621 ssl->in_msglen -= n;
5622
5623 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005624 {
5625 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005626 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005627 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005628 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005629 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005630 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005631 /* more data available */
5632 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005633 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005636
Paul Bakker23986e52011-04-24 08:57:21 +00005637 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005638}
5639
5640/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005641 * Send application data to be encrypted by the SSL layer, taking care of max
5642 * fragment length and buffer size.
5643 *
5644 * According to RFC 5246 Section 6.2.1:
5645 *
5646 * Zero-length fragments of Application data MAY be sent as they are
5647 * potentially useful as a traffic analysis countermeasure.
5648 *
5649 * Therefore, it is possible that the input message length is 0 and the
5650 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005651 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005652static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005653 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005654{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005655 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5656 const size_t max_len = (size_t) ret;
5657
5658 if( ret < 0 )
5659 {
5660 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5661 return( ret );
5662 }
5663
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005664 if( len > max_len )
5665 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005667 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005670 "maximum fragment length: %d > %d",
5671 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005673 }
5674 else
5675#endif
5676 len = max_len;
5677 }
Paul Bakker887bd502011-06-08 13:10:54 +00005678
Paul Bakker5121ce52009-01-03 21:22:43 +00005679 if( ssl->out_left != 0 )
5680 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005681 /*
5682 * The user has previously tried to send the data and
5683 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5684 * written. In this case, we expect the high-level write function
5685 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005687 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005690 return( ret );
5691 }
5692 }
Paul Bakker887bd502011-06-08 13:10:54 +00005693 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005694 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005695 /*
5696 * The user is trying to send a message the first time, so we need to
5697 * copy the data into the internal buffers and setup the data structure
5698 * to keep track of partial writes
5699 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005700 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005702 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005703
Hanno Becker67bc7c32018-08-06 11:33:50 +01005704 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005705 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005706 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005707 return( ret );
5708 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005709 }
5710
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005711 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005712}
5713
5714/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005715 * Write application data, doing 1/n-1 splitting if necessary.
5716 *
5717 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005718 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005719 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005721#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005722static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005723 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005724{
Janos Follath865b3eb2019-12-16 11:46:15 +00005725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005726
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005727 if( ssl->conf->cbc_record_splitting ==
5728 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005729 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005730 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5731 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5732 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005733 {
5734 return( ssl_write_real( ssl, buf, len ) );
5735 }
5736
5737 if( ssl->split_done == 0 )
5738 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005739 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005740 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005741 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005742 }
5743
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005744 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5745 return( ret );
5746 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005747
5748 return( ret + 1 );
5749}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005750#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005751
5752/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005753 * Write application data (public-facing wrapper)
5754 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005755int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005756{
Janos Follath865b3eb2019-12-16 11:46:15 +00005757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005758
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005760
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005761 if( ssl == NULL || ssl->conf == NULL )
5762 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5763
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005764#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005765 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5766 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005767 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005768 return( ret );
5769 }
5770#endif
5771
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005772 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005773 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005774 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005775 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005777 return( ret );
5778 }
5779 }
5780
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005781#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005782 ret = ssl_write_split( ssl, buf, len );
5783#else
5784 ret = ssl_write_real( ssl, buf, len );
5785#endif
5786
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005787 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005788
5789 return( ret );
5790}
5791
5792/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005793 * Notify the peer that the connection is being closed
5794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005795int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005796{
Janos Follath865b3eb2019-12-16 11:46:15 +00005797 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005798
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005799 if( ssl == NULL || ssl->conf == NULL )
5800 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005803
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005804 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005805 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005806
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005807 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005808 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005809 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5810 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5811 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005812 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005813 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005814 return( ret );
5815 }
5816 }
5817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005819
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005820 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005821}
5822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005824{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005825 if( transform == NULL )
5826 return;
5827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005828#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005829 deflateEnd( &transform->ctx_deflate );
5830 inflateEnd( &transform->ctx_inflate );
5831#endif
5832
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005833 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5834 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005835
Hanno Beckerd56ed242018-01-03 15:32:51 +00005836#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005837 mbedtls_md_free( &transform->md_ctx_enc );
5838 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005839#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005840
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005841 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005842}
5843
Hanno Becker0271f962018-08-16 13:23:47 +01005844#if defined(MBEDTLS_SSL_PROTO_DTLS)
5845
Hanno Becker533ab5f2020-02-05 10:49:13 +00005846void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005847{
5848 unsigned offset;
5849 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5850
5851 if( hs == NULL )
5852 return;
5853
Hanno Becker283f5ef2018-08-24 09:34:47 +01005854 ssl_free_buffered_record( ssl );
5855
Hanno Becker0271f962018-08-16 13:23:47 +01005856 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005857 ssl_buffering_free_slot( ssl, offset );
5858}
5859
5860static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5861 uint8_t slot )
5862{
5863 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5864 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005865
5866 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5867 return;
5868
Hanno Beckere605b192018-08-21 15:59:07 +01005869 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005870 {
Hanno Beckere605b192018-08-21 15:59:07 +01005871 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005872 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005873 mbedtls_free( hs_buf->data );
5874 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005875 }
5876}
5877
5878#endif /* MBEDTLS_SSL_PROTO_DTLS */
5879
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005880/*
5881 * Convert version numbers to/from wire format
5882 * and, for DTLS, to/from TLS equivalent.
5883 *
5884 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005885 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005886 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5887 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005889void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005890 unsigned char ver[2] )
5891{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005892#if defined(MBEDTLS_SSL_PROTO_DTLS)
5893 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005894 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005895 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005896 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5897
5898 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5899 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5900 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005901 else
5902#else
5903 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005904#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005905 {
5906 ver[0] = (unsigned char) major;
5907 ver[1] = (unsigned char) minor;
5908 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005909}
5910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005911void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005912 const unsigned char ver[2] )
5913{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005914#if defined(MBEDTLS_SSL_PROTO_DTLS)
5915 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005916 {
5917 *major = 255 - ver[0] + 2;
5918 *minor = 255 - ver[1] + 1;
5919
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005920 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005921 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5922 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005923 else
5924#else
5925 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005926#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005927 {
5928 *major = ver[0];
5929 *minor = ver[1];
5930 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005931}
5932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005933#endif /* MBEDTLS_SSL_TLS_C */