blob: 7aa4ba93c5cdf637b01563992f8d9cd7439f2ea3 [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000032#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020033#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020034#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020035#endif
Paul Bakker5121ce52009-01-03 21:22:43 +000036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000038
SimonBd5800b72016-04-26 07:43:27 +010039#if defined(MBEDTLS_PLATFORM_C)
40#include "mbedtls/platform.h"
41#else
42#include <stdlib.h>
43#define mbedtls_calloc calloc
44#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010045#endif
46
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000047#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020048#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000049#include "mbedtls/debug.h"
50#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050051#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010052#include "mbedtls/version.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020053
Rich Evans00ab4702015-02-06 13:43:58 +000054#include <string.h>
55
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050056#if defined(MBEDTLS_USE_PSA_CRYPTO)
57#include "mbedtls/psa_util.h"
58#include "psa/crypto.h"
59#endif
60
Janos Follath23bdca02016-10-07 14:47:14 +010061#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000062#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020063#endif
64
Hanno Beckercd9dcda2018-08-28 17:18:56 +010065static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010066
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020067/*
68 * Start a timer.
69 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020070 */
Hanno Becker0f57a652020-02-05 10:37:26 +000071void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020072{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020073 if( ssl->f_set_timer == NULL )
74 return;
75
76 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
77 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020078}
79
80/*
81 * Return -1 is timer is expired, 0 if it isn't.
82 */
Hanno Becker7876d122020-02-05 10:39:31 +000083int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020084{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020085 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020086 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020087
88 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020089 {
90 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020091 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020092 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020093
94 return( 0 );
95}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020096
Hanno Beckercfe45792019-07-03 16:13:00 +010097#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010098static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
99 unsigned char *buf,
100 size_t len,
101 mbedtls_record *rec );
102
Hanno Beckercfe45792019-07-03 16:13:00 +0100103int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
104 unsigned char *buf,
105 size_t buflen )
106{
Hanno Becker54229812019-07-12 14:40:00 +0100107 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100108 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
109 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
110
111 /* We don't support record checking in TLS because
112 * (a) there doesn't seem to be a usecase for it, and
113 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
114 * and we'd need to backup the transform here.
115 */
116 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
117 {
118 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
119 goto exit;
120 }
121#if defined(MBEDTLS_SSL_PROTO_DTLS)
122 else
123 {
irwir734f0cf2019-09-26 21:03:24 +0300124 mbedtls_record rec;
125
Hanno Becker54229812019-07-12 14:40:00 +0100126 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
127 if( ret != 0 )
128 {
129 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
130 goto exit;
131 }
132
133 if( ssl->transform_in != NULL )
134 {
135 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
136 if( ret != 0 )
137 {
138 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
139 goto exit;
140 }
141 }
142 }
143#endif /* MBEDTLS_SSL_PROTO_DTLS */
144
145exit:
146 /* On success, we have decrypted the buffer in-place, so make
147 * sure we don't leak any plaintext data. */
148 mbedtls_platform_zeroize( buf, buflen );
149
150 /* For the purpose of this API, treat messages with unexpected CID
151 * as well as such from future epochs as unexpected. */
152 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
153 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
154 {
155 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
156 }
157
158 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
159 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100160}
161#endif /* MBEDTLS_SSL_RECORD_CHECKING */
162
Hanno Becker67bc7c32018-08-06 11:33:50 +0100163#define SSL_DONT_FORCE_FLUSH 0
164#define SSL_FORCE_FLUSH 1
165
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100167
Hanno Beckerd5847772018-08-28 10:09:23 +0100168/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100169static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
170 uint8_t slot );
171static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
172static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
173static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
174static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100175static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
176 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100177static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100178
Hanno Becker11682cc2018-08-22 14:41:02 +0100179static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100180{
Hanno Becker89490712020-02-05 10:50:12 +0000181 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100182
183 if( mtu != 0 && mtu < MBEDTLS_SSL_OUT_BUFFER_LEN )
Hanno Becker11682cc2018-08-22 14:41:02 +0100184 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100185
186 return( MBEDTLS_SSL_OUT_BUFFER_LEN );
187}
188
Hanno Becker67bc7c32018-08-06 11:33:50 +0100189static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
190{
Hanno Becker11682cc2018-08-22 14:41:02 +0100191 size_t const bytes_written = ssl->out_left;
192 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100193
194 /* Double-check that the write-index hasn't gone
195 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100196 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100197 {
198 /* Should never happen... */
199 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
200 }
201
202 return( (int) ( mtu - bytes_written ) );
203}
204
205static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
206{
Janos Follath865b3eb2019-12-16 11:46:15 +0000207 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100208 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400209 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100210
211#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
212 const size_t mfl = mbedtls_ssl_get_max_frag_len( ssl );
213
214 if( max_len > mfl )
215 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100216
217 /* By the standard (RFC 6066 Sect. 4), the MFL extension
218 * only limits the maximum record payload size, so in theory
219 * we would be allowed to pack multiple records of payload size
220 * MFL into a single datagram. However, this would mean that there's
221 * no way to explicitly communicate MTU restrictions to the peer.
222 *
223 * The following reduction of max_len makes sure that we never
224 * write datagrams larger than MFL + Record Expansion Overhead.
225 */
226 if( max_len <= ssl->out_left )
227 return( 0 );
228
229 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100230#endif
231
232 ret = ssl_get_remaining_space_in_datagram( ssl );
233 if( ret < 0 )
234 return( ret );
235 remaining = (size_t) ret;
236
237 ret = mbedtls_ssl_get_record_expansion( ssl );
238 if( ret < 0 )
239 return( ret );
240 expansion = (size_t) ret;
241
242 if( remaining <= expansion )
243 return( 0 );
244
245 remaining -= expansion;
246 if( remaining >= max_len )
247 remaining = max_len;
248
249 return( (int) remaining );
250}
251
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200252/*
253 * Double the retransmit timeout value, within the allowed range,
254 * returning -1 if the maximum value has already been reached.
255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200257{
258 uint32_t new_timeout;
259
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200260 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200261 return( -1 );
262
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200263 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
264 * in the following way: after the initial transmission and a first
265 * retransmission, back off to a temporary estimated MTU of 508 bytes.
266 * This value is guaranteed to be deliverable (if not guaranteed to be
267 * delivered) of any compliant IPv4 (and IPv6) network, and should work
268 * on most non-IP stacks too. */
269 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400270 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200271 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
273 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200274
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200275 new_timeout = 2 * ssl->handshake->retransmit_timeout;
276
277 /* Avoid arithmetic overflow and range overflow */
278 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200279 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200281 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200282 }
283
284 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200286 ssl->handshake->retransmit_timeout ) );
287
288 return( 0 );
289}
290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200293 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200295 ssl->handshake->retransmit_timeout ) );
296}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
300int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200301 const unsigned char *key_enc, const unsigned char *key_dec,
302 size_t keylen,
303 const unsigned char *iv_enc, const unsigned char *iv_dec,
304 size_t ivlen,
305 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200306 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
308int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
309int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
310int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
312#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000313
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200314/* The function below is only used in the Lucky 13 counter-measure in
Hanno Beckerb2ca87d2018-10-18 15:43:13 +0100315 * mbedtls_ssl_decrypt_buf(). These are the defines that guard the call site. */
Hanno Becker52344c22018-01-03 15:24:20 +0000316#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) && \
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200317 ( defined(MBEDTLS_SSL_PROTO_TLS1) || \
318 defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
319 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
320/* This function makes sure every byte in the memory region is accessed
321 * (in ascending addresses order) */
322static void ssl_read_memory( unsigned char *p, size_t len )
323{
324 unsigned char acc = 0;
325 volatile unsigned char force;
326
327 for( ; len != 0; p++, len-- )
328 acc ^= *p;
329
330 force = acc;
331 (void) force;
332}
333#endif /* SSL_SOME_MODES_USE_MAC && ( TLS1 || TLS1_1 || TLS1_2 ) */
334
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100335/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000336 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200337 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000338
Hanno Beckera0e20d02019-05-15 14:03:01 +0100339#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd3f8c792019-05-20 15:06:12 +0100340/* This functions transforms a DTLS plaintext fragment and a record content
341 * type into an instance of the DTLSInnerPlaintext structure:
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100342 *
343 * struct {
344 * opaque content[DTLSPlaintext.length];
345 * ContentType real_type;
346 * uint8 zeros[length_of_padding];
347 * } DTLSInnerPlaintext;
348 *
349 * Input:
350 * - `content`: The beginning of the buffer holding the
351 * plaintext to be wrapped.
352 * - `*content_size`: The length of the plaintext in Bytes.
353 * - `max_len`: The number of Bytes available starting from
354 * `content`. This must be `>= *content_size`.
355 * - `rec_type`: The desired record content type.
356 *
357 * Output:
358 * - `content`: The beginning of the resulting DTLSInnerPlaintext structure.
359 * - `*content_size`: The length of the resulting DTLSInnerPlaintext structure.
360 *
361 * Returns:
362 * - `0` on success.
363 * - A negative error code if `max_len` didn't offer enough space
364 * for the expansion.
365 */
366static int ssl_cid_build_inner_plaintext( unsigned char *content,
367 size_t *content_size,
368 size_t remaining,
369 uint8_t rec_type )
370{
371 size_t len = *content_size;
Hanno Beckerb9ec44f2019-05-13 15:31:17 +0100372 size_t pad = ( MBEDTLS_SSL_CID_PADDING_GRANULARITY -
373 ( len + 1 ) % MBEDTLS_SSL_CID_PADDING_GRANULARITY ) %
374 MBEDTLS_SSL_CID_PADDING_GRANULARITY;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100375
376 /* Write real content type */
377 if( remaining == 0 )
378 return( -1 );
379 content[ len ] = rec_type;
380 len++;
381 remaining--;
382
383 if( remaining < pad )
384 return( -1 );
385 memset( content + len, 0, pad );
386 len += pad;
387 remaining -= pad;
388
389 *content_size = len;
390 return( 0 );
391}
392
Hanno Becker07dc97d2019-05-20 15:08:01 +0100393/* This function parses a DTLSInnerPlaintext structure.
394 * See ssl_cid_build_inner_plaintext() for details. */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100395static int ssl_cid_parse_inner_plaintext( unsigned char const *content,
396 size_t *content_size,
397 uint8_t *rec_type )
398{
399 size_t remaining = *content_size;
400
401 /* Determine length of padding by skipping zeroes from the back. */
402 do
403 {
404 if( remaining == 0 )
405 return( -1 );
406 remaining--;
407 } while( content[ remaining ] == 0 );
408
409 *content_size = remaining;
410 *rec_type = content[ remaining ];
411
412 return( 0 );
413}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100414#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100415
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100416/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100417 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000418static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100419 size_t *add_data_len,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000420 mbedtls_record *rec )
421{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100422 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100423 *
424 * additional_data = seq_num + TLSCompressed.type +
425 * TLSCompressed.version + TLSCompressed.length;
426 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100427 * For the CID extension, this is extended as follows
428 * (quoting draft-ietf-tls-dtls-connection-id-05,
429 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 *
431 * additional_data = seq_num + DTLSPlaintext.type +
432 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100433 * cid +
434 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100435 * length_of_DTLSInnerPlaintext;
436 */
437
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000438 memcpy( add_data, rec->ctr, sizeof( rec->ctr ) );
439 add_data[8] = rec->type;
Hanno Beckeredb24f82019-05-20 15:01:46 +0100440 memcpy( add_data + 9, rec->ver, sizeof( rec->ver ) );
Hanno Beckercab87e62019-04-29 13:52:53 +0100441
Hanno Beckera0e20d02019-05-15 14:03:01 +0100442#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100443 if( rec->cid_len != 0 )
444 {
445 memcpy( add_data + 11, rec->cid, rec->cid_len );
446 add_data[11 + rec->cid_len + 0] = rec->cid_len;
447 add_data[11 + rec->cid_len + 1] = ( rec->data_len >> 8 ) & 0xFF;
448 add_data[11 + rec->cid_len + 2] = ( rec->data_len >> 0 ) & 0xFF;
449 *add_data_len = 13 + 1 + rec->cid_len;
450 }
451 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100452#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100453 {
454 add_data[11 + 0] = ( rec->data_len >> 8 ) & 0xFF;
455 add_data[11 + 1] = ( rec->data_len >> 0 ) & 0xFF;
456 *add_data_len = 13;
457 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000458}
459
Hanno Becker9d062f92020-02-07 10:26:36 +0000460#if defined(MBEDTLS_SSL_PROTO_SSL3)
461
462#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
463
464/*
465 * SSLv3.0 MAC functions
466 */
467static void ssl_mac( mbedtls_md_context_t *md_ctx,
468 const unsigned char *secret,
469 const unsigned char *buf, size_t len,
470 const unsigned char *ctr, int type,
471 unsigned char out[SSL3_MAC_MAX_BYTES] )
472{
473 unsigned char header[11];
474 unsigned char padding[48];
475 int padlen;
476 int md_size = mbedtls_md_get_size( md_ctx->md_info );
477 int md_type = mbedtls_md_get_type( md_ctx->md_info );
478
479 /* Only MD5 and SHA-1 supported */
480 if( md_type == MBEDTLS_MD_MD5 )
481 padlen = 48;
482 else
483 padlen = 40;
484
485 memcpy( header, ctr, 8 );
486 header[ 8] = (unsigned char) type;
487 header[ 9] = (unsigned char)( len >> 8 );
488 header[10] = (unsigned char)( len );
489
490 memset( padding, 0x36, padlen );
491 mbedtls_md_starts( md_ctx );
492 mbedtls_md_update( md_ctx, secret, md_size );
493 mbedtls_md_update( md_ctx, padding, padlen );
494 mbedtls_md_update( md_ctx, header, 11 );
495 mbedtls_md_update( md_ctx, buf, len );
496 mbedtls_md_finish( md_ctx, out );
497
498 memset( padding, 0x5C, padlen );
499 mbedtls_md_starts( md_ctx );
500 mbedtls_md_update( md_ctx, secret, md_size );
501 mbedtls_md_update( md_ctx, padding, padlen );
502 mbedtls_md_update( md_ctx, out, md_size );
503 mbedtls_md_finish( md_ctx, out );
504}
505#endif /* MBEDTLS_SSL_PROTO_SSL3 */
506
Hanno Beckera18d1322018-01-03 14:27:32 +0000507int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
508 mbedtls_ssl_transform *transform,
509 mbedtls_record *rec,
510 int (*f_rng)(void *, unsigned char *, size_t),
511 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000512{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100514 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000515 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100516 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100517 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000518 size_t post_avail;
519
520 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000521#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200522 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000523 ((void) ssl);
524#endif
525
526 /* The PRNG is used for dynamic IV generation that's used
527 * for CBC transformations in TLS 1.1 and TLS 1.2. */
528#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
529 ( defined(MBEDTLS_AES_C) || \
530 defined(MBEDTLS_ARIA_C) || \
531 defined(MBEDTLS_CAMELLIA_C) ) && \
532 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
533 ((void) f_rng);
534 ((void) p_rng);
535#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000538
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000539 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100540 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
542 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
543 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100544 if( rec == NULL
545 || rec->buf == NULL
546 || rec->buf_len < rec->data_offset
547 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100548#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100549 || rec->cid_len != 0
550#endif
551 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000552 {
553 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100555 }
556
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000557 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100558 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000560 data, rec->data_len );
561
562 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
563
564 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
565 {
566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
567 (unsigned) rec->data_len,
568 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
569 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
570 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100571
Hanno Beckera0e20d02019-05-15 14:03:01 +0100572#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100573 /*
574 * Add CID information
575 */
576 rec->cid_len = transform->out_cid_len;
577 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
578 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100579
580 if( rec->cid_len != 0 )
581 {
582 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100583 * Wrap plaintext into DTLSInnerPlaintext structure.
584 * See ssl_cid_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100585 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100586 * Note that this changes `rec->data_len`, and hence
587 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100588 */
589 if( ssl_cid_build_inner_plaintext( data,
590 &rec->data_len,
591 post_avail,
592 rec->type ) != 0 )
593 {
594 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
595 }
596
597 rec->type = MBEDTLS_SSL_MSG_CID;
598 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100599#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100600
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100601 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
602
Paul Bakker5121ce52009-01-03 21:22:43 +0000603 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100604 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000605 */
Hanno Becker52344c22018-01-03 15:24:20 +0000606#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 if( mode == MBEDTLS_MODE_STREAM ||
608 ( mode == MBEDTLS_MODE_CBC
609#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000610 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100611#endif
612 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000613 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000614 if( post_avail < transform->maclen )
615 {
616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
617 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
618 }
619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000621 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200622 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000623 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000624 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
625 data, rec->data_len, rec->ctr, rec->type, mac );
626 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200627 }
628 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200629#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
631 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000632 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200633 {
Hanno Becker992b6872017-11-09 18:57:39 +0000634 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
635
Hanno Beckercab87e62019-04-29 13:52:53 +0100636 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker992b6872017-11-09 18:57:39 +0000637
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000638 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100639 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000640 mbedtls_md_hmac_update( &transform->md_ctx_enc,
641 data, rec->data_len );
642 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
643 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
644
645 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200646 }
647 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200648#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200649 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
651 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200652 }
653
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000654 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
655 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200656
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000657 rec->data_len += transform->maclen;
658 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100659 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200660 }
Hanno Becker52344c22018-01-03 15:24:20 +0000661#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000662
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663 /*
664 * Encrypt
665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200666#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
667 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000668 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000670 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000672 "including %d bytes of padding",
673 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000674
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000675 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
676 transform->iv_enc, transform->ivlen,
677 data, rec->data_len,
678 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200679 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200681 return( ret );
682 }
683
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000684 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200685 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200688 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000689 }
Paul Bakker68884e32013-01-07 18:20:04 +0100690 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200691#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000692
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200693#if defined(MBEDTLS_GCM_C) || \
694 defined(MBEDTLS_CCM_C) || \
695 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200697 mode == MBEDTLS_MODE_CCM ||
698 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000699 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000700 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200701 unsigned char iv[12];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000702 size_t explicit_iv_len = transform->ivlen - transform->fixed_ivlen;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000703
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 /* Check that there's space for both the authentication tag
705 * and the explicit IV before and after the record content. */
706 if( post_avail < transform->taglen ||
707 rec->data_offset < explicit_iv_len )
708 {
709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
710 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
711 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000712
Paul Bakker68884e32013-01-07 18:20:04 +0100713 /*
714 * Generate IV
715 */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200716 if( transform->ivlen == 12 && transform->fixed_ivlen == 4 )
717 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +0200718 /* GCM and CCM: fixed || explicit (=seqnum) */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200719 memcpy( iv, transform->iv_enc, transform->fixed_ivlen );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000720 memcpy( iv + transform->fixed_ivlen, rec->ctr,
721 explicit_iv_len );
722 /* Prefix record content with explicit IV. */
723 memcpy( data - explicit_iv_len, rec->ctr, explicit_iv_len );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200724 }
725 else if( transform->ivlen == 12 && transform->fixed_ivlen == 12 )
726 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +0200727 /* ChachaPoly: fixed XOR sequence number */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200728 unsigned char i;
729
730 memcpy( iv, transform->iv_enc, transform->fixed_ivlen );
731
732 for( i = 0; i < 8; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733 iv[i+4] ^= rec->ctr[i];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200734 }
735 else
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100736 {
737 /* Reminder if we ever add an AEAD mode with a different size */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
739 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100740 }
741
Hanno Beckercab87e62019-04-29 13:52:53 +0100742 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker1f10d762019-04-26 13:34:37 +0100743
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200744 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
745 iv, transform->ivlen );
746 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000747 data - explicit_iv_len, explicit_iv_len );
748 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100749 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200751 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000753
Paul Bakker68884e32013-01-07 18:20:04 +0100754 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200755 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200756 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200758 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000759 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100760 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000761 data, rec->data_len, /* source */
762 data, &rec->data_len, /* destination */
763 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200766 return( ret );
767 }
768
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000769 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
770 data + rec->data_len, transform->taglen );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200771
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000772 rec->data_len += transform->taglen + explicit_iv_len;
773 rec->data_offset -= explicit_iv_len;
774 post_avail -= transform->taglen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100775 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000776 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000777 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
779#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000780 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000782 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000783 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000784 size_t padlen, i;
785 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000786
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 /* Currently we're always using minimal padding
788 * (up to 255 bytes would be allowed). */
789 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
790 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000791 padlen = 0;
792
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000793 /* Check there's enough space in the buffer for the padding. */
794 if( post_avail < padlen + 1 )
795 {
796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
797 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
798 }
799
Paul Bakker5121ce52009-01-03 21:22:43 +0000800 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000802
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000803 rec->data_len += padlen + 1;
804 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000807 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000808 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
809 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000810 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000811 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000812 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000813 if( f_rng == NULL )
814 {
815 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
816 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
817 }
818
819 if( rec->data_offset < transform->ivlen )
820 {
821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
822 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
823 }
824
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000825 /*
826 * Generate IV
827 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000828 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000829 if( ret != 0 )
830 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000831
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000832 memcpy( data - transform->ivlen, transform->iv_enc,
833 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000834
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000835 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200836#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000839 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000840 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200841 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000842
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000843 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
844 transform->iv_enc,
845 transform->ivlen,
846 data, rec->data_len,
847 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200848 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200850 return( ret );
851 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200852
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200854 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
856 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200857 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200858
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200861 {
862 /*
863 * Save IV in SSL3 and TLS1
864 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000865 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
866 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000867 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000868 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200869#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000870 {
871 data -= transform->ivlen;
872 rec->data_offset -= transform->ivlen;
873 rec->data_len += transform->ivlen;
874 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100877 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100878 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000879 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
880
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100881 /*
882 * MAC(MAC_write_key, seq_num +
883 * TLSCipherText.type +
884 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100885 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100886 * IV + // except for TLS 1.0
887 * ENC(content + padding + padding_length));
888 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000889
890 if( post_avail < transform->maclen)
891 {
892 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
893 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
894 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100895
Hanno Beckercab87e62019-04-29 13:52:53 +0100896 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker1f10d762019-04-26 13:34:37 +0100897
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000899 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100900 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100903 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000904 mbedtls_md_hmac_update( &transform->md_ctx_enc,
905 data, rec->data_len );
906 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
907 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100910
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 rec->data_len += transform->maclen;
912 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100913 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100914 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200917 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000919 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200920 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
922 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200923 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000924
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100925 /* Make extra sure authentication was performed, exactly once */
926 if( auth_done != 1 )
927 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
929 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100930 }
931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000933
934 return( 0 );
935}
936
Hanno Becker605949f2019-07-12 08:23:59 +0100937int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000938 mbedtls_ssl_transform *transform,
939 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000940{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000941 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000943 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +0000944#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100945 size_t padlen = 0, correct = 1;
946#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000947 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100948 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100949 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000950
Hanno Beckera18d1322018-01-03 14:27:32 +0000951#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200952 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000953 ((void) ssl);
954#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000957 if( rec == NULL ||
958 rec->buf == NULL ||
959 rec->buf_len < rec->data_offset ||
960 rec->buf_len - rec->data_offset < rec->data_len )
961 {
962 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100964 }
965
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000966 data = rec->buf + rec->data_offset;
967 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000968
Hanno Beckera0e20d02019-05-15 14:03:01 +0100969#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100970 /*
971 * Match record's CID with incoming CID.
972 */
Hanno Becker938489a2019-05-08 13:02:22 +0100973 if( rec->cid_len != transform->in_cid_len ||
974 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
975 {
Hanno Becker8367ccc2019-05-14 11:30:10 +0100976 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +0100977 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100978#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
981 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +0100982 {
983 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000984 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
985 transform->iv_dec,
986 transform->ivlen,
987 data, rec->data_len,
988 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200989 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200991 return( ret );
992 }
993
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000994 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
997 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200998 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000999 }
Paul Bakker68884e32013-01-07 18:20:04 +01001000 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001002#if defined(MBEDTLS_GCM_C) || \
1003 defined(MBEDTLS_CCM_C) || \
1004 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001006 mode == MBEDTLS_MODE_CCM ||
1007 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001008 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001009 unsigned char iv[12];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001010 size_t explicit_iv_len = transform->ivlen - transform->fixed_ivlen;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001011
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001012 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001013 * Prepare IV from explicit and implicit data.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001014 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001015
1016 /* Check that there's enough space for the explicit IV
1017 * (at the beginning of the record) and the MAC (at the
1018 * end of the record). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001019 if( rec->data_len < explicit_iv_len + transform->taglen )
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001022 "+ taglen (%d)", rec->data_len,
1023 explicit_iv_len, transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001025 }
Paul Bakker68884e32013-01-07 18:20:04 +01001026
Hanno Beckerd96a6522019-07-10 13:55:25 +01001027#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001028 if( transform->ivlen == 12 && transform->fixed_ivlen == 4 )
1029 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001030 /* GCM and CCM: fixed || explicit */
Paul Bakker68884e32013-01-07 18:20:04 +01001031
Hanno Beckerd96a6522019-07-10 13:55:25 +01001032 /* Fixed */
1033 memcpy( iv, transform->iv_dec, transform->fixed_ivlen );
1034 /* Explicit */
1035 memcpy( iv + transform->fixed_ivlen, data, 8 );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001036 }
Hanno Beckerd96a6522019-07-10 13:55:25 +01001037 else
1038#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1039#if defined(MBEDTLS_CHACHAPOLY_C)
1040 if( transform->ivlen == 12 && transform->fixed_ivlen == 12 )
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001041 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +02001042 /* ChachaPoly: fixed XOR sequence number */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001043 unsigned char i;
1044
1045 memcpy( iv, transform->iv_dec, transform->fixed_ivlen );
1046
1047 for( i = 0; i < 8; i++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001048 iv[i+4] ^= rec->ctr[i];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001049 }
1050 else
Hanno Beckerd96a6522019-07-10 13:55:25 +01001051#endif /* MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001052 {
1053 /* Reminder if we ever add an AEAD mode with a different size */
1054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1055 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1056 }
1057
Hanno Beckerd96a6522019-07-10 13:55:25 +01001058 /* Group changes to data, data_len, and add_data, because
1059 * add_data depends on data_len. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001060 data += explicit_iv_len;
1061 rec->data_offset += explicit_iv_len;
1062 rec->data_len -= explicit_iv_len + transform->taglen;
1063
Hanno Beckercab87e62019-04-29 13:52:53 +01001064 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001065 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001066 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001067
Hanno Beckerd96a6522019-07-10 13:55:25 +01001068 /* Because of the check above, we know that there are
1069 * explicit_iv_len Bytes preceeding data, and taglen
1070 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001071 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001072 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001073
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001074 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001075 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001076 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001077
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001078 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001079 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001080 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001081 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1082 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001083 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001084 data, rec->data_len,
1085 data, &olen,
1086 data + rec->data_len,
1087 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001088 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1092 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001093
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001094 return( ret );
1095 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001096 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001097
Hanno Beckerd96a6522019-07-10 13:55:25 +01001098 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001099 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001100 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1102 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001103 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001104 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001105 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1107#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001108 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001110 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001111 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001112
Paul Bakker5121ce52009-01-03 21:22:43 +00001113 /*
Paul Bakker45829992013-01-03 14:52:21 +01001114 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001117 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1118 {
1119 /* The ciphertext is prefixed with the CBC IV. */
1120 minlen += transform->ivlen;
1121 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001122#endif
Paul Bakker45829992013-01-03 14:52:21 +01001123
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001124 /* Size considerations:
1125 *
1126 * - The CBC cipher text must not be empty and hence
1127 * at least of size transform->ivlen.
1128 *
1129 * Together with the potential IV-prefix, this explains
1130 * the first of the two checks below.
1131 *
1132 * - The record must contain a MAC, either in plain or
1133 * encrypted, depending on whether Encrypt-then-MAC
1134 * is used or not.
1135 * - If it is, the message contains the IV-prefix,
1136 * the CBC ciphertext, and the MAC.
1137 * - If it is not, the padded plaintext, and hence
1138 * the CBC ciphertext, has at least length maclen + 1
1139 * because there is at least the padding length byte.
1140 *
1141 * As the CBC ciphertext is not empty, both cases give the
1142 * lower bound minlen + maclen + 1 on the record size, which
1143 * we test for in the second check below.
1144 */
1145 if( rec->data_len < minlen + transform->ivlen ||
1146 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001147 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001149 "+ 1 ) ( + expl IV )", rec->data_len,
1150 transform->ivlen,
1151 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001153 }
1154
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001155 /*
1156 * Authenticate before decrypt if enabled
1157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001159 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001160 {
Hanno Becker992b6872017-11-09 18:57:39 +00001161 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001164
Hanno Beckerd96a6522019-07-10 13:55:25 +01001165 /* Update data_len in tandem with add_data.
1166 *
1167 * The subtraction is safe because of the previous check
1168 * data_len >= minlen + maclen + 1.
1169 *
1170 * Afterwards, we know that data + data_len is followed by at
1171 * least maclen Bytes, which justifies the call to
1172 * mbedtls_ssl_safer_memcmp() below.
1173 *
1174 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001175 rec->data_len -= transform->maclen;
Hanno Beckercab87e62019-04-29 13:52:53 +01001176 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001177
Hanno Beckerd96a6522019-07-10 13:55:25 +01001178 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001179 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1180 add_data_len );
1181 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1182 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001183 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1184 data, rec->data_len );
1185 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1186 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001187
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001188 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1189 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001190 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001191 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001192
Hanno Beckerd96a6522019-07-10 13:55:25 +01001193 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001194 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1195 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001199 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001200 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001201 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001203
1204 /*
1205 * Check length sanity
1206 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001207
1208 /* We know from above that data_len > minlen >= 0,
1209 * so the following check in particular implies that
1210 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001211 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001212 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001214 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001216 }
1217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001219 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001220 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001221 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001222 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001223 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001224 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001225 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001226
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001227 data += transform->ivlen;
1228 rec->data_offset += transform->ivlen;
1229 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001230 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001232
Hanno Beckerd96a6522019-07-10 13:55:25 +01001233 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1234
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001235 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1236 transform->iv_dec, transform->ivlen,
1237 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001238 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001240 return( ret );
1241 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001242
Hanno Beckerd96a6522019-07-10 13:55:25 +01001243 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001244 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +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 Bakkercca5b812013-08-31 17:40:26 +02001248 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001252 {
1253 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001254 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1255 * records is equivalent to CBC decryption of the concatenation
1256 * of the records; in other words, IVs are maintained across
1257 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001258 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001259 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1260 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001261 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001262#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001263
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001264 /* Safe since data_len >= minlen + maclen + 1, so after having
1265 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001266 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1267 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001268 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001269
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001270 if( auth_done == 1 )
1271 {
1272 correct *= ( rec->data_len >= padlen + 1 );
1273 padlen *= ( rec->data_len >= padlen + 1 );
1274 }
1275 else
Paul Bakker45829992013-01-03 14:52:21 +01001276 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001278 if( rec->data_len < transform->maclen + padlen + 1 )
1279 {
1280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1281 rec->data_len,
1282 transform->maclen,
1283 padlen + 1 ) );
1284 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001285#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001286
1287 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1288 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001291 padlen++;
1292
1293 /* Regardless of the validity of the padding,
1294 * we have data_len >= padlen here. */
1295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001297 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001298 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301#if defined(MBEDTLS_SSL_DEBUG_ALL)
1302 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001303 "should be no more than %d",
1304 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001305#endif
Paul Bakker45829992013-01-03 14:52:21 +01001306 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 }
1308 }
1309 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1311#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1312 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001313 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001314 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 /* The padding check involves a series of up to 256
1316 * consecutive memory reads at the end of the record
1317 * plaintext buffer. In order to hide the length and
1318 * validity of the padding, always perform exactly
1319 * `min(256,plaintext_len)` reads (but take into account
1320 * only the last `padlen` bytes for the padding check). */
1321 size_t pad_count = 0;
1322 size_t real_count = 0;
1323 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001324
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001325 /* Index of first padding byte; it has been ensured above
1326 * that the subtraction is safe. */
1327 size_t const padding_idx = rec->data_len - padlen;
1328 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1329 size_t const start_idx = rec->data_len - num_checks;
1330 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001331
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001333 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 real_count |= ( idx >= padding_idx );
1335 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001336 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001337 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001339#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001340 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001342#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001343 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001344 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001345 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1347 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001348 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1350 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001351 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001352
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001353 /* If the padding was found to be invalid, padlen == 0
1354 * and the subtraction is safe. If the padding was found valid,
1355 * padlen hasn't been changed and the previous assertion
1356 * data_len >= padlen still holds. */
1357 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001358 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001359 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001361 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001362 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1364 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001365 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001366
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001367#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001368 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001369 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001370#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001371
1372 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001373 * Authenticate if not done yet.
1374 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001375 */
Hanno Becker52344c22018-01-03 15:24:20 +00001376#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001377 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001378 {
Hanno Becker992b6872017-11-09 18:57:39 +00001379 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001380
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001381 /* If the initial value of padlen was such that
1382 * data_len < maclen + padlen + 1, then padlen
1383 * got reset to 1, and the initial check
1384 * data_len >= minlen + maclen + 1
1385 * guarantees that at this point we still
1386 * have at least data_len >= maclen.
1387 *
1388 * If the initial value of padlen was such that
1389 * data_len >= maclen + padlen + 1, then we have
1390 * subtracted either padlen + 1 (if the padding was correct)
1391 * or 0 (if the padding was incorrect) since then,
1392 * hence data_len >= maclen in any case.
1393 */
1394 rec->data_len -= transform->maclen;
Hanno Beckercab87e62019-04-29 13:52:53 +01001395 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001396
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001398 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001399 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001400 ssl_mac( &transform->md_ctx_dec,
1401 transform->mac_dec,
1402 data, rec->data_len,
1403 rec->ctr, rec->type,
1404 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001405 }
1406 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1408#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1409 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001410 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001411 {
1412 /*
1413 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001414 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001415 *
1416 * Known timing attacks:
1417 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1418 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001419 * To compensate for different timings for the MAC calculation
1420 * depending on how much padding was removed (which is determined
1421 * by padlen), process extra_run more blocks through the hash
1422 * function.
1423 *
1424 * The formula in the paper is
1425 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1426 * where L1 is the size of the header plus the decrypted message
1427 * plus CBC padding and L2 is the size of the header plus the
1428 * decrypted message. This is for an underlying hash function
1429 * with 64-byte blocks.
1430 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1431 * correctly. We round down instead of up, so -56 is the correct
1432 * value for our calculations instead of -55.
1433 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001434 * Repeat the formula rather than defining a block_size variable.
1435 * This avoids requiring division by a variable at runtime
1436 * (which would be marginally less efficient and would require
1437 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001438 */
1439 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001441
1442 /*
1443 * The next two sizes are the minimum and maximum values of
1444 * in_msglen over all padlen values.
1445 *
1446 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001447 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001448 *
1449 * Note that max_len + maclen is never more than the buffer
1450 * length, as we previously did in_msglen -= maclen too.
1451 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001452 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001453 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1454
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 memset( tmp, 0, sizeof( tmp ) );
1456
1457 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001458 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001459#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1460 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001461 case MBEDTLS_MD_MD5:
1462 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001463 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001464 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001465 extra_run =
1466 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1467 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001468 break;
1469#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001470#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001471 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001472 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001473 extra_run =
1474 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1475 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001476 break;
1477#endif
1478 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001480 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1481 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001482
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001483 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001484
Hanno Beckercab87e62019-04-29 13:52:53 +01001485 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1486 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001487 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1488 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001489 /* Make sure we access everything even when padlen > 0. This
1490 * makes the synchronisation requirements for just-in-time
1491 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 ssl_read_memory( data + rec->data_len, padlen );
1493 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001494
1495 /* Call mbedtls_md_process at least once due to cache attacks
1496 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001497 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001498 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001499
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001501
1502 /* Make sure we access all the memory that could contain the MAC,
1503 * before we check it in the next code block. This makes the
1504 * synchronisation requirements for just-in-time Prime+Probe
1505 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001506 ssl_read_memory( data + min_len,
1507 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001508 }
1509 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1511 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1514 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001515 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001516
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001517#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1519 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001520#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1523 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525#if defined(MBEDTLS_SSL_DEBUG_ALL)
1526 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001527#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001528 correct = 0;
1529 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001530 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001531 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001532
1533 /*
1534 * Finally check the correct flag
1535 */
1536 if( correct == 0 )
1537 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001538#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001539
1540 /* Make extra sure authentication was performed, exactly once */
1541 if( auth_done != 1 )
1542 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1544 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001545 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001546
Hanno Beckera0e20d02019-05-15 14:03:01 +01001547#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001548 if( rec->cid_len != 0 )
1549 {
1550 ret = ssl_cid_parse_inner_plaintext( data, &rec->data_len,
1551 &rec->type );
1552 if( ret != 0 )
1553 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1554 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001555#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001558
1559 return( 0 );
1560}
1561
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001562#undef MAC_NONE
1563#undef MAC_PLAINTEXT
1564#undef MAC_CIPHERTEXT
1565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001567/*
1568 * Compression/decompression functions
1569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001571{
Janos Follath865b3eb2019-12-16 11:46:15 +00001572 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001573 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001574 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001575 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001576 unsigned char *msg_pre = ssl->compress_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001579
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001580 if( len_pre == 0 )
1581 return( 0 );
1582
Paul Bakker2770fbd2012-07-03 13:30:23 +00001583 memcpy( msg_pre, ssl->out_msg, len_pre );
1584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001586 ssl->out_msglen ) );
1587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001589 ssl->out_msg, ssl->out_msglen );
1590
Paul Bakker48916f92012-09-16 19:57:18 +00001591 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1592 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1593 ssl->transform_out->ctx_deflate.next_out = msg_post;
Angus Grattond8213d02016-05-25 20:56:48 +10001594 ssl->transform_out->ctx_deflate.avail_out = MBEDTLS_SSL_OUT_BUFFER_LEN - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595
Paul Bakker48916f92012-09-16 19:57:18 +00001596 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001597 if( ret != Z_OK )
1598 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1600 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001601 }
1602
Angus Grattond8213d02016-05-25 20:56:48 +10001603 ssl->out_msglen = MBEDTLS_SSL_OUT_BUFFER_LEN -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001604 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001606 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001607 ssl->out_msglen ) );
1608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001610 ssl->out_msg, ssl->out_msglen );
1611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001613
1614 return( 0 );
1615}
1616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001618{
Janos Follath865b3eb2019-12-16 11:46:15 +00001619 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001620 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001621 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001622 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001623 unsigned char *msg_pre = ssl->compress_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001626
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001627 if( len_pre == 0 )
1628 return( 0 );
1629
Paul Bakker2770fbd2012-07-03 13:30:23 +00001630 memcpy( msg_pre, ssl->in_msg, len_pre );
1631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001633 ssl->in_msglen ) );
1634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001636 ssl->in_msg, ssl->in_msglen );
1637
Paul Bakker48916f92012-09-16 19:57:18 +00001638 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1639 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1640 ssl->transform_in->ctx_inflate.next_out = msg_post;
Angus Grattond8213d02016-05-25 20:56:48 +10001641 ssl->transform_in->ctx_inflate.avail_out = MBEDTLS_SSL_IN_BUFFER_LEN -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001642 header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001643
Paul Bakker48916f92012-09-16 19:57:18 +00001644 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001645 if( ret != Z_OK )
1646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1648 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001649 }
1650
Angus Grattond8213d02016-05-25 20:56:48 +10001651 ssl->in_msglen = MBEDTLS_SSL_IN_BUFFER_LEN -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001652 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001653
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001655 ssl->in_msglen ) );
1656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001658 ssl->in_msg, ssl->in_msglen );
1659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001661
1662 return( 0 );
1663}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001665
Paul Bakker5121ce52009-01-03 21:22:43 +00001666/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001667 * Fill the input message buffer by appending data to it.
1668 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001669 *
1670 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1671 * available (from this read and/or a previous one). Otherwise, an error code
1672 * is returned (possibly EOF or WANT_READ).
1673 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001674 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1675 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1676 * since we always read a whole datagram at once.
1677 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001678 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001679 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001682{
Janos Follath865b3eb2019-12-16 11:46:15 +00001683 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001684 size_t len;
Paul Bakker5121ce52009-01-03 21:22:43 +00001685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001687
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001688 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1689 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001691 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001693 }
1694
Angus Grattond8213d02016-05-25 20:56:48 +10001695 if( nb_want > MBEDTLS_SSL_IN_BUFFER_LEN - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001696 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1698 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001699 }
1700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001702 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001703 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001704 uint32_t timeout;
1705
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001706 /* Just to be sure */
1707 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1708 {
1709 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1710 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1711 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1712 }
1713
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001714 /*
1715 * The point is, we need to always read a full datagram at once, so we
1716 * sometimes read more then requested, and handle the additional data.
1717 * It could be the rest of the current record (while fetching the
1718 * header) and/or some other records in the same datagram.
1719 */
1720
1721 /*
1722 * Move to the next record in the already read datagram if applicable
1723 */
1724 if( ssl->next_record_offset != 0 )
1725 {
1726 if( ssl->in_left < ssl->next_record_offset )
1727 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1729 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001730 }
1731
1732 ssl->in_left -= ssl->next_record_offset;
1733
1734 if( ssl->in_left != 0 )
1735 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001737 ssl->next_record_offset ) );
1738 memmove( ssl->in_hdr,
1739 ssl->in_hdr + ssl->next_record_offset,
1740 ssl->in_left );
1741 }
1742
1743 ssl->next_record_offset = 0;
1744 }
1745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001747 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001748
1749 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001750 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001751 */
1752 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001753 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001755 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001756 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001757
1758 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001759 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001760 * are not at the beginning of a new record, the caller did something
1761 * wrong.
1762 */
1763 if( ssl->in_left != 0 )
1764 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1766 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001767 }
1768
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001769 /*
1770 * Don't even try to read if time's out already.
1771 * This avoids by-passing the timer when repeatedly receiving messages
1772 * that will end up being dropped.
1773 */
Hanno Becker7876d122020-02-05 10:39:31 +00001774 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001775 {
1776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001777 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001778 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001779 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001780 {
Angus Grattond8213d02016-05-25 20:56:48 +10001781 len = MBEDTLS_SSL_IN_BUFFER_LEN - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001784 timeout = ssl->handshake->retransmit_timeout;
1785 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001786 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001789
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001790 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001791 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1792 timeout );
1793 else
1794 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1795
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001797
1798 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001800 }
1801
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001802 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001805 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001806
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001808 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001809 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1810 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001812 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001813 }
1814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001816 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001818 return( ret );
1819 }
1820
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001821 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001822 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001824 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001826 {
Hanno Becker786300f2020-02-05 10:46:40 +00001827 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001828 {
Hanno Becker786300f2020-02-05 10:46:40 +00001829 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1830 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001831 return( ret );
1832 }
1833
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001834 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001835 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001837 }
1838
Paul Bakker5121ce52009-01-03 21:22:43 +00001839 if( ret < 0 )
1840 return( ret );
1841
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001842 ssl->in_left = ret;
1843 }
1844 else
1845#endif
1846 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001848 ssl->in_left, nb_want ) );
1849
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001850 while( ssl->in_left < nb_want )
1851 {
1852 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001853
Hanno Becker7876d122020-02-05 10:39:31 +00001854 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001855 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1856 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001857 {
1858 if( ssl->f_recv_timeout != NULL )
1859 {
1860 ret = ssl->f_recv_timeout( ssl->p_bio,
1861 ssl->in_hdr + ssl->in_left, len,
1862 ssl->conf->read_timeout );
1863 }
1864 else
1865 {
1866 ret = ssl->f_recv( ssl->p_bio,
1867 ssl->in_hdr + ssl->in_left, len );
1868 }
1869 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001872 ssl->in_left, nb_want ) );
1873 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001874
1875 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001877
1878 if( ret < 0 )
1879 return( ret );
1880
mohammad160352aecb92018-03-28 23:41:40 -07001881 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001882 {
Darryl Green11999bb2018-03-13 15:22:58 +00001883 MBEDTLS_SSL_DEBUG_MSG( 1,
1884 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07001885 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001886 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1887 }
1888
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001889 ssl->in_left += ret;
1890 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001891 }
1892
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001894
1895 return( 0 );
1896}
1897
1898/*
1899 * Flush any data not yet written
1900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001902{
Janos Follath865b3eb2019-12-16 11:46:15 +00001903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001904 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001907
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001908 if( ssl->f_send == NULL )
1909 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001911 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001913 }
1914
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001915 /* Avoid incrementing counter if data is flushed */
1916 if( ssl->out_left == 0 )
1917 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001919 return( 0 );
1920 }
1921
Paul Bakker5121ce52009-01-03 21:22:43 +00001922 while( ssl->out_left > 0 )
1923 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01001925 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001926
Hanno Becker2b1e3542018-08-06 11:19:13 +01001927 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001928 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001930 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001931
1932 if( ret <= 0 )
1933 return( ret );
1934
mohammad160352aecb92018-03-28 23:41:40 -07001935 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001936 {
Darryl Green11999bb2018-03-13 15:22:58 +00001937 MBEDTLS_SSL_DEBUG_MSG( 1,
1938 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07001939 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001940 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1941 }
1942
Paul Bakker5121ce52009-01-03 21:22:43 +00001943 ssl->out_left -= ret;
1944 }
1945
Hanno Becker2b1e3542018-08-06 11:19:13 +01001946#if defined(MBEDTLS_SSL_PROTO_DTLS)
1947 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001948 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001949 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001950 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001951 else
1952#endif
1953 {
1954 ssl->out_hdr = ssl->out_buf + 8;
1955 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001956 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001959
1960 return( 0 );
1961}
1962
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001963/*
1964 * Functions to handle the DTLS retransmission state machine
1965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001967/*
1968 * Append current handshake message to current outgoing flight
1969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001971{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1974 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1975 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001976
1977 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001978 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001979 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02001980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001982 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001983 }
1984
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001985 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001986 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02001987 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001989 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001990 }
1991
1992 /* Copy current handshake message with headers */
1993 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
1994 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001995 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001996 msg->next = NULL;
1997
1998 /* Append to the current flight */
1999 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002000 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002001 else
2002 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002004 while( cur->next != NULL )
2005 cur = cur->next;
2006 cur->next = msg;
2007 }
2008
Hanno Becker3b235902018-08-06 09:54:53 +01002009 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002010 return( 0 );
2011}
2012
2013/*
2014 * Free the current flight of handshake messages
2015 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002016void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002017{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018 mbedtls_ssl_flight_item *cur = flight;
2019 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002020
2021 while( cur != NULL )
2022 {
2023 next = cur->next;
2024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 mbedtls_free( cur->p );
2026 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002027
2028 cur = next;
2029 }
2030}
2031
2032/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002033 * Swap transform_out and out_ctr with the alternative ones
2034 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002035static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002036{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002038 unsigned char tmp_out_ctr[8];
2039
2040 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2041 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002043 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002044 }
2045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002047
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002048 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002049 tmp_transform = ssl->transform_out;
2050 ssl->transform_out = ssl->handshake->alt_transform_out;
2051 ssl->handshake->alt_transform_out = tmp_transform;
2052
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002053 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002054 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2055 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002056 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002057
2058 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002059 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2062 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002063 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002064 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2065 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002066 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002067 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2068 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002069 }
2070 }
2071#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002072
2073 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002074}
2075
2076/*
2077 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002078 */
2079int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2080{
2081 int ret = 0;
2082
2083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2084
2085 ret = mbedtls_ssl_flight_transmit( ssl );
2086
2087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2088
2089 return( ret );
2090}
2091
2092/*
2093 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002094 *
2095 * Need to remember the current message in case flush_output returns
2096 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002097 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002098 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002099int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002100{
Janos Follath865b3eb2019-12-16 11:46:15 +00002101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002102 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002105 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002107
2108 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002109 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002110 ret = ssl_swap_epochs( ssl );
2111 if( ret != 0 )
2112 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002116
2117 while( ssl->handshake->cur_msg != NULL )
2118 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002119 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002120 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002121
Hanno Beckere1dcb032018-08-17 16:47:58 +01002122 int const is_finished =
2123 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2124 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2125
Hanno Becker04da1892018-08-14 13:22:10 +01002126 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2127 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2128
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002129 /* Swap epochs before sending Finished: we can't do it after
2130 * sending ChangeCipherSpec, in case write returns WANT_READ.
2131 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002132 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002133 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002135 ret = ssl_swap_epochs( ssl );
2136 if( ret != 0 )
2137 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002138 }
2139
Hanno Becker67bc7c32018-08-06 11:33:50 +01002140 ret = ssl_get_remaining_payload_in_datagram( ssl );
2141 if( ret < 0 )
2142 return( ret );
2143 max_frag_len = (size_t) ret;
2144
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002145 /* CCS is copied as is, while HS messages may need fragmentation */
2146 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2147 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002148 if( max_frag_len == 0 )
2149 {
2150 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2151 return( ret );
2152
2153 continue;
2154 }
2155
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002156 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002157 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002158 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002159
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002160 /* Update position inside current message */
2161 ssl->handshake->cur_msg_p += cur->len;
2162 }
2163 else
2164 {
2165 const unsigned char * const p = ssl->handshake->cur_msg_p;
2166 const size_t hs_len = cur->len - 12;
2167 const size_t frag_off = p - ( cur->p + 12 );
2168 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002169 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002170
Hanno Beckere1dcb032018-08-17 16:47:58 +01002171 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002172 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002173 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002174 {
2175 ret = ssl_swap_epochs( ssl );
2176 if( ret != 0 )
2177 return( ret );
2178 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002179
Hanno Becker67bc7c32018-08-06 11:33:50 +01002180 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2181 return( ret );
2182
2183 continue;
2184 }
2185 max_hs_frag_len = max_frag_len - 12;
2186
2187 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2188 max_hs_frag_len : rem_len;
2189
2190 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002191 {
2192 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002193 (unsigned) cur_hs_frag_len,
2194 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002195 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002196
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002197 /* Messages are stored with handshake headers as if not fragmented,
2198 * copy beginning of headers then fill fragmentation fields.
2199 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2200 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002201
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002202 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2203 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2204 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2205
Hanno Becker67bc7c32018-08-06 11:33:50 +01002206 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2207 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2208 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002209
2210 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2211
Hanno Becker3f7b9732018-08-28 09:53:25 +01002212 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002213 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2214 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002215 ssl->out_msgtype = cur->type;
2216
2217 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002218 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002219 }
2220
2221 /* If done with the current message move to the next one if any */
2222 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2223 {
2224 if( cur->next != NULL )
2225 {
2226 ssl->handshake->cur_msg = cur->next;
2227 ssl->handshake->cur_msg_p = cur->next->p + 12;
2228 }
2229 else
2230 {
2231 ssl->handshake->cur_msg = NULL;
2232 ssl->handshake->cur_msg_p = NULL;
2233 }
2234 }
2235
2236 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002237 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002238 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002240 return( ret );
2241 }
2242 }
2243
Hanno Becker67bc7c32018-08-06 11:33:50 +01002244 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2245 return( ret );
2246
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002247 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2249 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002250 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002251 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002253 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002254 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002255
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002256 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257
2258 return( 0 );
2259}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002260
2261/*
2262 * To be called when the last message of an incoming flight is received.
2263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265{
2266 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002267 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002268 ssl->handshake->flight = NULL;
2269 ssl->handshake->cur_msg = NULL;
2270
2271 /* The next incoming flight will start with this msg_seq */
2272 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2273
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002274 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002275 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002276
Hanno Becker0271f962018-08-16 13:23:47 +01002277 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002278 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002279
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002280 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002281 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2284 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002285 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002287 }
2288 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002290}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002291
2292/*
2293 * To be called when the last message of an outgoing flight is send.
2294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002296{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002297 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002298 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2301 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002302 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002304 }
2305 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002307}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002309
Paul Bakker5121ce52009-01-03 21:22:43 +00002310/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002311 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
2314/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002315 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002316 *
2317 * - fill in handshake headers
2318 * - update handshake checksum
2319 * - DTLS: save message for resending
2320 * - then pass to the record layer
2321 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002322 * DTLS: except for HelloRequest, messages are only queued, and will only be
2323 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002324 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002325 * Inputs:
2326 * - ssl->out_msglen: 4 + actual handshake message len
2327 * (4 is the size of handshake headers for TLS)
2328 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2329 * - ssl->out_msg + 4: the handshake message body
2330 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002331 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002332 * - ssl->out_msglen: the length of the record contents
2333 * (including handshake headers but excluding record headers)
2334 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002335 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002336int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002337{
Janos Follath865b3eb2019-12-16 11:46:15 +00002338 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002339 const size_t hs_len = ssl->out_msglen - 4;
2340 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002341
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002342 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2343
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002344 /*
2345 * Sanity checks
2346 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002347 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002348 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2349 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002350 /* In SSLv3, the client might send a NoCertificate alert. */
2351#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2352 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2353 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2354 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2355#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2356 {
2357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2358 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2359 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002360 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002361
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002362 /* Whenever we send anything different from a
2363 * HelloRequest we should be in a handshake - double check. */
2364 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2365 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002366 ssl->handshake == NULL )
2367 {
2368 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2369 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2370 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002373 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002374 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002376 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002377 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2378 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002379 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002380#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002381
Hanno Beckerb50a2532018-08-06 11:52:54 +01002382 /* Double-check that we did not exceed the bounds
2383 * of the outgoing record buffer.
2384 * This should never fail as the various message
2385 * writing functions must obey the bounds of the
2386 * outgoing record buffer, but better be safe.
2387 *
2388 * Note: We deliberately do not check for the MTU or MFL here.
2389 */
2390 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2391 {
2392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2393 "size %u, maximum %u",
2394 (unsigned) ssl->out_msglen,
2395 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2396 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2397 }
2398
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002399 /*
2400 * Fill handshake headers
2401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002403 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002404 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2405 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2406 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002407
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002408 /*
2409 * DTLS has additional fields in the Handshake layer,
2410 * between the length field and the actual payload:
2411 * uint16 message_seq;
2412 * uint24 fragment_offset;
2413 * uint24 fragment_length;
2414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002416 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002417 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002418 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002419 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002420 {
2421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2422 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002423 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002424 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002425 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2426 }
2427
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002428 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002429 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002430
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002431 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002432 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002433 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002434 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2435 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2436 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002437 }
2438 else
2439 {
2440 ssl->out_msg[4] = 0;
2441 ssl->out_msg[5] = 0;
2442 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002443
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002444 /* Handshake hashes are computed without fragmentation,
2445 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002446 memset( ssl->out_msg + 6, 0x00, 3 );
2447 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002448 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002450
Hanno Becker0207e532018-08-28 10:28:28 +01002451 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002452 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2453 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002454 }
2455
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002456 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002458 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002459 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2460 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002461 {
2462 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002465 return( ret );
2466 }
2467 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002468 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002469#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002470 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002471 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002472 {
2473 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2474 return( ret );
2475 }
2476 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002477
2478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2479
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002480 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002481}
2482
2483/*
2484 * Record layer functions
2485 */
2486
2487/*
2488 * Write current record.
2489 *
2490 * Uses:
2491 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2492 * - ssl->out_msglen: length of the record content (excl headers)
2493 * - ssl->out_msg: record content
2494 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002495int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002496{
2497 int ret, done = 0;
2498 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002499 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002500
2501 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002504 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002506 {
2507 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2508 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002510 return( ret );
2511 }
2512
2513 len = ssl->out_msglen;
2514 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2518 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002522 ret = mbedtls_ssl_hw_record_write( ssl );
2523 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002524 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2526 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002527 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002528
2529 if( ret == 0 )
2530 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002531 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002533 if( !done )
2534 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002535 unsigned i;
2536 size_t protected_record_size;
2537
Hanno Becker6430faf2019-05-08 11:57:13 +01002538 /* Skip writing the record content type to after the encryption,
2539 * as it may change when using the CID extension. */
2540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002542 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002543
Hanno Becker19859472018-08-06 09:40:20 +01002544 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002545 ssl->out_len[0] = (unsigned char)( len >> 8 );
2546 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002547
Paul Bakker48916f92012-09-16 19:57:18 +00002548 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002549 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002550 mbedtls_record rec;
2551
2552 rec.buf = ssl->out_iv;
2553 rec.buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN -
2554 ( ssl->out_iv - ssl->out_buf );
2555 rec.data_len = ssl->out_msglen;
2556 rec.data_offset = ssl->out_msg - rec.buf;
2557
2558 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2559 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2560 ssl->conf->transport, rec.ver );
2561 rec.type = ssl->out_msgtype;
2562
Hanno Beckera0e20d02019-05-15 14:03:01 +01002563#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002564 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002565 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002566#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002567
Hanno Beckera18d1322018-01-03 14:27:32 +00002568 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002569 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002572 return( ret );
2573 }
2574
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002575 if( rec.data_offset != 0 )
2576 {
2577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2578 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2579 }
2580
Hanno Becker6430faf2019-05-08 11:57:13 +01002581 /* Update the record content type and CID. */
2582 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002583#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002584 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002585#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002586 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002587 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2588 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002589 }
2590
Hanno Becker5903de42019-05-03 14:46:38 +01002591 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002592
2593#if defined(MBEDTLS_SSL_PROTO_DTLS)
2594 /* In case of DTLS, double-check that we don't exceed
2595 * the remaining space in the datagram. */
2596 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2597 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002598 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002599 if( ret < 0 )
2600 return( ret );
2601
2602 if( protected_record_size > (size_t) ret )
2603 {
2604 /* Should never happen */
2605 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2606 }
2607 }
2608#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002609
Hanno Becker6430faf2019-05-08 11:57:13 +01002610 /* Now write the potentially updated record content type. */
2611 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002614 "version = [%d:%d], msglen = %d",
2615 ssl->out_hdr[0], ssl->out_hdr[1],
2616 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002619 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002620
2621 ssl->out_left += protected_record_size;
2622 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002623 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002624
Hanno Beckerdd772292020-02-05 10:38:31 +00002625 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002626 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2627 break;
2628
2629 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002630 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002631 {
2632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2633 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2634 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002635 }
2636
Hanno Becker67bc7c32018-08-06 11:33:50 +01002637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002638 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2639 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002640 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002641 size_t remaining;
2642 ret = ssl_get_remaining_payload_in_datagram( ssl );
2643 if( ret < 0 )
2644 {
2645 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2646 ret );
2647 return( ret );
2648 }
2649
2650 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002651 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002652 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002653 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002654 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002655 else
2656 {
Hanno Becker513815a2018-08-20 11:56:09 +01002657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002658 }
2659 }
2660#endif /* MBEDTLS_SSL_PROTO_DTLS */
2661
2662 if( ( flush == SSL_FORCE_FLUSH ) &&
2663 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002664 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002666 return( ret );
2667 }
2668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002670
2671 return( 0 );
2672}
2673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002675
2676static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2677{
2678 if( ssl->in_msglen < ssl->in_hslen ||
2679 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2680 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2681 {
2682 return( 1 );
2683 }
2684 return( 0 );
2685}
Hanno Becker44650b72018-08-16 12:51:11 +01002686
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002687static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002688{
2689 return( ( ssl->in_msg[9] << 16 ) |
2690 ( ssl->in_msg[10] << 8 ) |
2691 ssl->in_msg[11] );
2692}
2693
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002694static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002695{
2696 return( ( ssl->in_msg[6] << 16 ) |
2697 ( ssl->in_msg[7] << 8 ) |
2698 ssl->in_msg[8] );
2699}
2700
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002701static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002702{
2703 uint32_t msg_len, frag_off, frag_len;
2704
2705 msg_len = ssl_get_hs_total_len( ssl );
2706 frag_off = ssl_get_hs_frag_off( ssl );
2707 frag_len = ssl_get_hs_frag_len( ssl );
2708
2709 if( frag_off > msg_len )
2710 return( -1 );
2711
2712 if( frag_len > msg_len - frag_off )
2713 return( -1 );
2714
2715 if( frag_len + 12 > ssl->in_msglen )
2716 return( -1 );
2717
2718 return( 0 );
2719}
2720
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002721/*
2722 * Mark bits in bitmask (used for DTLS HS reassembly)
2723 */
2724static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2725{
2726 unsigned int start_bits, end_bits;
2727
2728 start_bits = 8 - ( offset % 8 );
2729 if( start_bits != 8 )
2730 {
2731 size_t first_byte_idx = offset / 8;
2732
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002733 /* Special case */
2734 if( len <= start_bits )
2735 {
2736 for( ; len != 0; len-- )
2737 mask[first_byte_idx] |= 1 << ( start_bits - len );
2738
2739 /* Avoid potential issues with offset or len becoming invalid */
2740 return;
2741 }
2742
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002743 offset += start_bits; /* Now offset % 8 == 0 */
2744 len -= start_bits;
2745
2746 for( ; start_bits != 0; start_bits-- )
2747 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2748 }
2749
2750 end_bits = len % 8;
2751 if( end_bits != 0 )
2752 {
2753 size_t last_byte_idx = ( offset + len ) / 8;
2754
2755 len -= end_bits; /* Now len % 8 == 0 */
2756
2757 for( ; end_bits != 0; end_bits-- )
2758 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2759 }
2760
2761 memset( mask + offset / 8, 0xFF, len / 8 );
2762}
2763
2764/*
2765 * Check that bitmask is full
2766 */
2767static int ssl_bitmask_check( unsigned char *mask, size_t len )
2768{
2769 size_t i;
2770
2771 for( i = 0; i < len / 8; i++ )
2772 if( mask[i] != 0xFF )
2773 return( -1 );
2774
2775 for( i = 0; i < len % 8; i++ )
2776 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2777 return( -1 );
2778
2779 return( 0 );
2780}
2781
Hanno Becker56e205e2018-08-16 09:06:12 +01002782/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002783static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002784 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002785{
Hanno Becker56e205e2018-08-16 09:06:12 +01002786 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002787
Hanno Becker56e205e2018-08-16 09:06:12 +01002788 alloc_len = 12; /* Handshake header */
2789 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002790
Hanno Beckerd07df862018-08-16 09:14:58 +01002791 if( add_bitmap )
2792 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002793
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002794 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002795}
Hanno Becker56e205e2018-08-16 09:06:12 +01002796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002798
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002799static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002800{
2801 return( ( ssl->in_msg[1] << 16 ) |
2802 ( ssl->in_msg[2] << 8 ) |
2803 ssl->in_msg[3] );
2804}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002805
Simon Butcher99000142016-10-13 17:21:01 +01002806int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002807{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002811 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002813 }
2814
Hanno Becker12555c62018-08-16 12:47:53 +01002815 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002818 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002819 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002822 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002823 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002824 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002825 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002826
Hanno Becker44650b72018-08-16 12:51:11 +01002827 if( ssl_check_hs_header( ssl ) != 0 )
2828 {
2829 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2830 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2831 }
2832
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002833 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002834 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2835 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2836 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2837 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002838 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002839 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2840 {
2841 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2842 recv_msg_seq,
2843 ssl->handshake->in_msg_seq ) );
2844 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2845 }
2846
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002847 /* Retransmit only on last message from previous flight, to avoid
2848 * too many retransmissions.
2849 * Besides, No sane server ever retransmits HelloVerifyRequest */
2850 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002854 "message_seq = %d, start_of_flight = %d",
2855 recv_msg_seq,
2856 ssl->handshake->in_flight_start_seq ) );
2857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002861 return( ret );
2862 }
2863 }
2864 else
2865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002867 "message_seq = %d, expected = %d",
2868 recv_msg_seq,
2869 ssl->handshake->in_msg_seq ) );
2870 }
2871
Hanno Becker90333da2017-10-10 11:27:13 +01002872 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002873 }
2874 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002875
Hanno Becker6d97ef52018-08-16 13:09:04 +01002876 /* Message reassembly is handled alongside buffering of future
2877 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002878 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002879 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002880 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002883 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002884 }
2885 }
2886 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002888 /* With TLS we don't handle fragmentation (for now) */
2889 if( ssl->in_msglen < ssl->in_hslen )
2890 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2892 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002893 }
2894
Simon Butcher99000142016-10-13 17:21:01 +01002895 return( 0 );
2896}
2897
2898void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2899{
Hanno Becker0271f962018-08-16 13:23:47 +01002900 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002901
Hanno Becker0271f962018-08-16 13:23:47 +01002902 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002903 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002904 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002905 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002906
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002907 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002909 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002910 ssl->handshake != NULL )
2911 {
Hanno Becker0271f962018-08-16 13:23:47 +01002912 unsigned offset;
2913 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002914
Hanno Becker0271f962018-08-16 13:23:47 +01002915 /* Increment handshake sequence number */
2916 hs->in_msg_seq++;
2917
2918 /*
2919 * Clear up handshake buffering and reassembly structure.
2920 */
2921
2922 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002923 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002924
2925 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002926 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2927 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002928 offset++, hs_buf++ )
2929 {
2930 *hs_buf = *(hs_buf + 1);
2931 }
2932
2933 /* Create a fresh last entry */
2934 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002935 }
2936#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002937}
2938
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002939/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002940 * DTLS anti-replay: RFC 6347 4.1.2.6
2941 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002942 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2943 * Bit n is set iff record number in_window_top - n has been seen.
2944 *
2945 * Usually, in_window_top is the last record number seen and the lsb of
2946 * in_window is set. The only exception is the initial state (record number 0
2947 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002950void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002951{
2952 ssl->in_window_top = 0;
2953 ssl->in_window = 0;
2954}
2955
2956static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2957{
2958 return( ( (uint64_t) buf[0] << 40 ) |
2959 ( (uint64_t) buf[1] << 32 ) |
2960 ( (uint64_t) buf[2] << 24 ) |
2961 ( (uint64_t) buf[3] << 16 ) |
2962 ( (uint64_t) buf[4] << 8 ) |
2963 ( (uint64_t) buf[5] ) );
2964}
2965
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002966static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2967{
Janos Follath865b3eb2019-12-16 11:46:15 +00002968 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002969 unsigned char *original_in_ctr;
2970
2971 // save original in_ctr
2972 original_in_ctr = ssl->in_ctr;
2973
2974 // use counter from record
2975 ssl->in_ctr = record_in_ctr;
2976
2977 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2978
2979 // restore the counter
2980 ssl->in_ctr = original_in_ctr;
2981
2982 return ret;
2983}
2984
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002985/*
2986 * Return 0 if sequence number is acceptable, -1 otherwise
2987 */
Hanno Becker0183d692019-07-12 08:50:37 +01002988int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002989{
2990 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2991 uint64_t bit;
2992
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002993 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002994 return( 0 );
2995
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002996 if( rec_seqnum > ssl->in_window_top )
2997 return( 0 );
2998
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002999 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003000
3001 if( bit >= 64 )
3002 return( -1 );
3003
3004 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3005 return( -1 );
3006
3007 return( 0 );
3008}
3009
3010/*
3011 * Update replay window on new validated record
3012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003014{
3015 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3016
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003017 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003018 return;
3019
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003020 if( rec_seqnum > ssl->in_window_top )
3021 {
3022 /* Update window_top and the contents of the window */
3023 uint64_t shift = rec_seqnum - ssl->in_window_top;
3024
3025 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003026 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003027 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003028 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003029 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003030 ssl->in_window |= 1;
3031 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003032
3033 ssl->in_window_top = rec_seqnum;
3034 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003035 else
3036 {
3037 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003038 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003039
3040 if( bit < 64 ) /* Always true, but be extra sure */
3041 ssl->in_window |= (uint64_t) 1 << bit;
3042 }
3043}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003045
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003046#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003047/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003048 * Without any SSL context, check if a datagram looks like a ClientHello with
3049 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003050 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003051 *
3052 * - if cookie is valid, return 0
3053 * - if ClientHello looks superficially valid but cookie is not,
3054 * fill obuf and set olen, then
3055 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3056 * - otherwise return a specific error code
3057 */
3058static int ssl_check_dtls_clihlo_cookie(
3059 mbedtls_ssl_cookie_write_t *f_cookie_write,
3060 mbedtls_ssl_cookie_check_t *f_cookie_check,
3061 void *p_cookie,
3062 const unsigned char *cli_id, size_t cli_id_len,
3063 const unsigned char *in, size_t in_len,
3064 unsigned char *obuf, size_t buf_len, size_t *olen )
3065{
3066 size_t sid_len, cookie_len;
3067 unsigned char *p;
3068
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003069 /*
3070 * Structure of ClientHello with record and handshake headers,
3071 * and expected values. We don't need to check a lot, more checks will be
3072 * done when actually parsing the ClientHello - skipping those checks
3073 * avoids code duplication and does not make cookie forging any easier.
3074 *
3075 * 0-0 ContentType type; copied, must be handshake
3076 * 1-2 ProtocolVersion version; copied
3077 * 3-4 uint16 epoch; copied, must be 0
3078 * 5-10 uint48 sequence_number; copied
3079 * 11-12 uint16 length; (ignored)
3080 *
3081 * 13-13 HandshakeType msg_type; (ignored)
3082 * 14-16 uint24 length; (ignored)
3083 * 17-18 uint16 message_seq; copied
3084 * 19-21 uint24 fragment_offset; copied, must be 0
3085 * 22-24 uint24 fragment_length; (ignored)
3086 *
3087 * 25-26 ProtocolVersion client_version; (ignored)
3088 * 27-58 Random random; (ignored)
3089 * 59-xx SessionID session_id; 1 byte len + sid_len content
3090 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3091 * ...
3092 *
3093 * Minimum length is 61 bytes.
3094 */
3095 if( in_len < 61 ||
3096 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3097 in[3] != 0 || in[4] != 0 ||
3098 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3099 {
3100 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3101 }
3102
3103 sid_len = in[59];
3104 if( sid_len > in_len - 61 )
3105 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3106
3107 cookie_len = in[60 + sid_len];
3108 if( cookie_len > in_len - 60 )
3109 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3110
3111 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3112 cli_id, cli_id_len ) == 0 )
3113 {
3114 /* Valid cookie */
3115 return( 0 );
3116 }
3117
3118 /*
3119 * If we get here, we've got an invalid cookie, let's prepare HVR.
3120 *
3121 * 0-0 ContentType type; copied
3122 * 1-2 ProtocolVersion version; copied
3123 * 3-4 uint16 epoch; copied
3124 * 5-10 uint48 sequence_number; copied
3125 * 11-12 uint16 length; olen - 13
3126 *
3127 * 13-13 HandshakeType msg_type; hello_verify_request
3128 * 14-16 uint24 length; olen - 25
3129 * 17-18 uint16 message_seq; copied
3130 * 19-21 uint24 fragment_offset; copied
3131 * 22-24 uint24 fragment_length; olen - 25
3132 *
3133 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3134 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3135 *
3136 * Minimum length is 28.
3137 */
3138 if( buf_len < 28 )
3139 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3140
3141 /* Copy most fields and adapt others */
3142 memcpy( obuf, in, 25 );
3143 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3144 obuf[25] = 0xfe;
3145 obuf[26] = 0xff;
3146
3147 /* Generate and write actual cookie */
3148 p = obuf + 28;
3149 if( f_cookie_write( p_cookie,
3150 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3151 {
3152 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3153 }
3154
3155 *olen = p - obuf;
3156
3157 /* Go back and fill length fields */
3158 obuf[27] = (unsigned char)( *olen - 28 );
3159
3160 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3161 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3162 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3163
3164 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3165 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3166
3167 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3168}
3169
3170/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003171 * Handle possible client reconnect with the same UDP quadruplet
3172 * (RFC 6347 Section 4.2.8).
3173 *
3174 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3175 * that looks like a ClientHello.
3176 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003177 * - if the input looks like a ClientHello without cookies,
3178 * send back HelloVerifyRequest, then
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003179 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003180 * - if the input looks like a ClientHello with a valid cookie,
3181 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003182 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003183 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003184 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003185 * mbedtls_ssl_read_record() will ignore the record if anything else than
Simon Butcherd0bf6a32015-09-11 17:34:49 +01003186 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT or 0 is returned, although this function
3187 * cannot not return 0.
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003188 */
3189static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3190{
Janos Follath865b3eb2019-12-16 11:46:15 +00003191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003192 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003193
Hanno Becker2fddd372019-07-10 14:37:41 +01003194 if( ssl->conf->f_cookie_write == NULL ||
3195 ssl->conf->f_cookie_check == NULL )
3196 {
3197 /* If we can't use cookies to verify reachability of the peer,
3198 * drop the record. */
3199 return( 0 );
3200 }
3201
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003202 ret = ssl_check_dtls_clihlo_cookie(
3203 ssl->conf->f_cookie_write,
3204 ssl->conf->f_cookie_check,
3205 ssl->conf->p_cookie,
3206 ssl->cli_id, ssl->cli_id_len,
3207 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003208 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003209
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003210 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3211
3212 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003213 {
Brian J Murray1903fb32016-11-06 04:45:15 -08003214 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003215 * If the error is permanent we'll catch it later,
3216 * if it's not, then hopefully it'll work next time. */
3217 (void) ssl->f_send( ssl->p_bio, ssl->out_buf, len );
Hanno Becker2fddd372019-07-10 14:37:41 +01003218 ret = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003219 }
3220
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003221 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003222 {
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003223 /* Got a valid cookie, partially reset context */
Hanno Becker43aefe22020-02-05 10:44:56 +00003224 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003225 {
3226 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3227 return( ret );
3228 }
3229
3230 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003231 }
3232
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003233 return( ret );
3234}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003235#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003236
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003237static int ssl_check_record_type( uint8_t record_type )
3238{
3239 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3240 record_type != MBEDTLS_SSL_MSG_ALERT &&
3241 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3242 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3243 {
3244 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3245 }
3246
3247 return( 0 );
3248}
3249
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003250/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003251 * ContentType type;
3252 * ProtocolVersion version;
3253 * uint16 epoch; // DTLS only
3254 * uint48 sequence_number; // DTLS only
3255 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003256 *
3257 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003258 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003259 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3260 *
3261 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003262 * 1. proceed with the record if this function returns 0
3263 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3264 * 3. return CLIENT_RECONNECT if this function return that value
3265 * 4. drop the whole datagram if this function returns anything else.
3266 * Point 2 is needed when the peer is resending, and we have already received
3267 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003268 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003269static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003270 unsigned char *buf,
3271 size_t len,
3272 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003273{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003274 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003275
Hanno Beckere5e7e782019-07-11 12:29:35 +01003276 size_t const rec_hdr_type_offset = 0;
3277 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003278
Hanno Beckere5e7e782019-07-11 12:29:35 +01003279 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3280 rec_hdr_type_len;
3281 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003282
Hanno Beckere5e7e782019-07-11 12:29:35 +01003283 size_t const rec_hdr_ctr_len = 8;
3284#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003285 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003286 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3287 rec_hdr_version_len;
3288
Hanno Beckera0e20d02019-05-15 14:03:01 +01003289#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003290 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3291 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003292 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003293#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3294#endif /* MBEDTLS_SSL_PROTO_DTLS */
3295
3296 size_t rec_hdr_len_offset; /* To be determined */
3297 size_t const rec_hdr_len_len = 2;
3298
3299 /*
3300 * Check minimum lengths for record header.
3301 */
3302
3303#if defined(MBEDTLS_SSL_PROTO_DTLS)
3304 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3305 {
3306 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3307 }
3308 else
3309#endif /* MBEDTLS_SSL_PROTO_DTLS */
3310 {
3311 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3312 }
3313
3314 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3315 {
3316 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3317 (unsigned) len,
3318 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3319 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3320 }
3321
3322 /*
3323 * Parse and validate record content type
3324 */
3325
3326 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003327
3328 /* Check record content type */
3329#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3330 rec->cid_len = 0;
3331
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003332 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003333 ssl->conf->cid_len != 0 &&
3334 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003335 {
3336 /* Shift pointers to account for record header including CID
3337 * struct {
3338 * ContentType special_type = tls12_cid;
3339 * ProtocolVersion version;
3340 * uint16 epoch;
3341 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003342 * opaque cid[cid_length]; // Additional field compared to
3343 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003344 * uint16 length;
3345 * opaque enc_content[DTLSCiphertext.length];
3346 * } DTLSCiphertext;
3347 */
3348
3349 /* So far, we only support static CID lengths
3350 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003351 rec_hdr_cid_len = ssl->conf->cid_len;
3352 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003353
Hanno Beckere5e7e782019-07-11 12:29:35 +01003354 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003355 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3357 (unsigned) len,
3358 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003359 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003360 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003361
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003362 /* configured CID len is guaranteed at most 255, see
3363 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3364 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003365 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003366 }
3367 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003368#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003369 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003370 if( ssl_check_record_type( rec->type ) )
3371 {
Hanno Becker54229812019-07-12 14:40:00 +01003372 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3373 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003374 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3375 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003376 }
3377
Hanno Beckere5e7e782019-07-11 12:29:35 +01003378 /*
3379 * Parse and validate record version
3380 */
3381
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003382 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3383 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003384 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3385 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003386 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003387
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003388 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3391 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003392 }
3393
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003394 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003395 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3397 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003398 }
3399
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 /*
3401 * Parse/Copy record sequence number.
3402 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003403
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404#if defined(MBEDTLS_SSL_PROTO_DTLS)
3405 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003406 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407 /* Copy explicit record sequence number from input buffer. */
3408 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3409 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003410 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003411 else
3412#endif /* MBEDTLS_SSL_PROTO_DTLS */
3413 {
3414 /* Copy implicit record sequence number from SSL context structure. */
3415 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3416 }
Paul Bakker40e46942009-01-03 21:51:57 +00003417
Hanno Beckere5e7e782019-07-11 12:29:35 +01003418 /*
3419 * Parse record length.
3420 */
3421
Hanno Beckere5e7e782019-07-11 12:29:35 +01003422 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003423 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3424 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003425 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003426
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003427 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003428 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003429 rec->type,
3430 major_ver, minor_ver, rec->data_len ) );
3431
3432 rec->buf = buf;
3433 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003434
Hanno Beckerd417cc92019-07-26 08:20:27 +01003435 if( rec->data_len == 0 )
3436 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003437
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003438 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003439 * DTLS-related tests.
3440 * Check epoch before checking length constraint because
3441 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3442 * message gets duplicated before the corresponding Finished message,
3443 * the second ChangeCipherSpec should be discarded because it belongs
3444 * to an old epoch, but not because its length is shorter than
3445 * the minimum record length for packets using the new record transform.
3446 * Note that these two kinds of failures are handled differently,
3447 * as an unexpected record is silently skipped but an invalid
3448 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003449 */
3450#if defined(MBEDTLS_SSL_PROTO_DTLS)
3451 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3452 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003453 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003454
Hanno Becker955a5c92019-07-10 17:12:07 +01003455 /* Check that the datagram is large enough to contain a record
3456 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003457 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003458 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3460 (unsigned) len,
3461 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003462 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3463 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003464
Hanno Becker37cfe732019-07-10 17:20:01 +01003465 /* Records from other, non-matching epochs are silently discarded.
3466 * (The case of same-port Client reconnects must be considered in
3467 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003468 if( rec_epoch != ssl->in_epoch )
3469 {
3470 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3471 "expected %d, received %d",
3472 ssl->in_epoch, rec_epoch ) );
3473
Hanno Becker552f7472019-07-19 10:59:12 +01003474 /* Records from the next epoch are considered for buffering
3475 * (concretely: early Finished messages). */
3476 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003477 {
Hanno Becker552f7472019-07-19 10:59:12 +01003478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3479 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003480 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003481
Hanno Becker2fddd372019-07-10 14:37:41 +01003482 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003483 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003484#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003485 /* For records from the correct epoch, check whether their
3486 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003487 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3488 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003489 {
3490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3491 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3492 }
3493#endif
3494 }
3495#endif /* MBEDTLS_SSL_PROTO_DTLS */
3496
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003497 return( 0 );
3498}
Paul Bakker5121ce52009-01-03 21:22:43 +00003499
Paul Bakker5121ce52009-01-03 21:22:43 +00003500
Hanno Becker2fddd372019-07-10 14:37:41 +01003501#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3502static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3503{
3504 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3505
3506 /*
3507 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3508 * access the first byte of record content (handshake type), as we
3509 * have an active transform (possibly iv_len != 0), so use the
3510 * fact that the record header len is 13 instead.
3511 */
3512 if( rec_epoch == 0 &&
3513 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3514 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3515 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3516 ssl->in_left > 13 &&
3517 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3518 {
3519 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3520 "from the same port" ) );
3521 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003522 }
3523
3524 return( 0 );
3525}
Hanno Becker2fddd372019-07-10 14:37:41 +01003526#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003527
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003528/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003529 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003530 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003531static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3532 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003533{
3534 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003537 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003538
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003539#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3540 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003541 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 ret = mbedtls_ssl_hw_record_read( ssl );
3545 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3548 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003549 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003550
3551 if( ret == 0 )
3552 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003553 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003555 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003556 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003557 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003558
Hanno Beckera18d1322018-01-03 14:27:32 +00003559 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003560 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003561 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003563
Hanno Beckera0e20d02019-05-15 14:03:01 +01003564#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003565 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3566 ssl->conf->ignore_unexpected_cid
3567 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3568 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003569 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003570 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003571 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003572#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003573
Paul Bakker5121ce52009-01-03 21:22:43 +00003574 return( ret );
3575 }
3576
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003577 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003578 {
3579 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003580 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003581 }
3582
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003583 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003584 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003585
Hanno Beckera0e20d02019-05-15 14:03:01 +01003586#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003587 /* We have already checked the record content type
3588 * in ssl_parse_record_header(), failing or silently
3589 * dropping the record in the case of an unknown type.
3590 *
3591 * Since with the use of CIDs, the record content type
3592 * might change during decryption, re-check the record
3593 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003594 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003595 {
3596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3597 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3598 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003599#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003600
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003601 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003602 {
3603#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3604 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003605 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003606 {
3607 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3609 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3610 }
3611#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3612
3613 ssl->nb_zero++;
3614
3615 /*
3616 * Three or more empty messages may be a DoS attack
3617 * (excessive CPU consumption).
3618 */
3619 if( ssl->nb_zero > 3 )
3620 {
3621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003622 "messages, possible DoS attack" ) );
3623 /* Treat the records as if they were not properly authenticated,
3624 * thereby failing the connection if we see more than allowed
3625 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003626 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3627 }
3628 }
3629 else
3630 ssl->nb_zero = 0;
3631
3632#if defined(MBEDTLS_SSL_PROTO_DTLS)
3633 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3634 {
3635 ; /* in_ctr read from peer, not maintained internally */
3636 }
3637 else
3638#endif
3639 {
3640 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003641 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003642 if( ++ssl->in_ctr[i - 1] != 0 )
3643 break;
3644
3645 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003646 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003647 {
3648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3649 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3650 }
3651 }
3652
Paul Bakker5121ce52009-01-03 21:22:43 +00003653 }
3654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003656 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003657 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003659 }
3660#endif
3661
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003662 /* Check actual (decrypted) record content length against
3663 * configured maximum. */
3664 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3665 {
3666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3667 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3668 }
3669
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003670 return( 0 );
3671}
3672
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003673/*
3674 * Read a record.
3675 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003676 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3677 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3678 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003679 */
Hanno Becker1097b342018-08-15 14:09:41 +01003680
3681/* Helper functions for mbedtls_ssl_read_record(). */
3682static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003683static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3684static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003685
Hanno Becker327c93b2018-08-15 13:56:18 +01003686int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003687 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003688{
Janos Follath865b3eb2019-12-16 11:46:15 +00003689 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003692
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003693 if( ssl->keep_current_message == 0 )
3694 {
3695 do {
Simon Butcher99000142016-10-13 17:21:01 +01003696
Hanno Becker26994592018-08-15 14:14:59 +01003697 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003698 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003699 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003700
Hanno Beckere74d5562018-08-15 14:26:08 +01003701 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003702 {
Hanno Becker40f50842018-08-15 14:48:01 +01003703#if defined(MBEDTLS_SSL_PROTO_DTLS)
3704 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003705
Hanno Becker40f50842018-08-15 14:48:01 +01003706 /* We only check for buffered messages if the
3707 * current datagram is fully consumed. */
3708 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003709 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003710 {
Hanno Becker40f50842018-08-15 14:48:01 +01003711 if( ssl_load_buffered_message( ssl ) == 0 )
3712 have_buffered = 1;
3713 }
3714
3715 if( have_buffered == 0 )
3716#endif /* MBEDTLS_SSL_PROTO_DTLS */
3717 {
3718 ret = ssl_get_next_record( ssl );
3719 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3720 continue;
3721
3722 if( ret != 0 )
3723 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003724 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003725 return( ret );
3726 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003727 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003728 }
3729
3730 ret = mbedtls_ssl_handle_message_type( ssl );
3731
Hanno Becker40f50842018-08-15 14:48:01 +01003732#if defined(MBEDTLS_SSL_PROTO_DTLS)
3733 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3734 {
3735 /* Buffer future message */
3736 ret = ssl_buffer_message( ssl );
3737 if( ret != 0 )
3738 return( ret );
3739
3740 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3741 }
3742#endif /* MBEDTLS_SSL_PROTO_DTLS */
3743
Hanno Becker90333da2017-10-10 11:27:13 +01003744 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3745 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003746
3747 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003748 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003749 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003750 return( ret );
3751 }
3752
Hanno Becker327c93b2018-08-15 13:56:18 +01003753 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003754 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003755 {
3756 mbedtls_ssl_update_handshake_status( ssl );
3757 }
Simon Butcher99000142016-10-13 17:21:01 +01003758 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003759 else
Simon Butcher99000142016-10-13 17:21:01 +01003760 {
Hanno Becker02f59072018-08-15 14:00:24 +01003761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003762 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003763 }
3764
3765 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3766
3767 return( 0 );
3768}
3769
Hanno Becker40f50842018-08-15 14:48:01 +01003770#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003771static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003772{
Hanno Becker40f50842018-08-15 14:48:01 +01003773 if( ssl->in_left > ssl->next_record_offset )
3774 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003775
Hanno Becker40f50842018-08-15 14:48:01 +01003776 return( 0 );
3777}
3778
3779static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3780{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003781 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003782 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003783 int ret = 0;
3784
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003785 if( hs == NULL )
3786 return( -1 );
3787
Hanno Beckere00ae372018-08-20 09:39:42 +01003788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3789
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003790 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3791 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3792 {
3793 /* Check if we have seen a ChangeCipherSpec before.
3794 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003795 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003796 {
3797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3798 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003799 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003800 }
3801
Hanno Becker39b8bc92018-08-28 17:17:13 +01003802 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003803 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3804 ssl->in_msglen = 1;
3805 ssl->in_msg[0] = 1;
3806
3807 /* As long as they are equal, the exact value doesn't matter. */
3808 ssl->in_left = 0;
3809 ssl->next_record_offset = 0;
3810
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003811 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003812 goto exit;
3813 }
Hanno Becker37f95322018-08-16 13:55:32 +01003814
Hanno Beckerb8f50142018-08-28 10:01:34 +01003815#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003816 /* Debug only */
3817 {
3818 unsigned offset;
3819 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3820 {
3821 hs_buf = &hs->buffering.hs[offset];
3822 if( hs_buf->is_valid == 1 )
3823 {
3824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3825 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003826 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003827 }
3828 }
3829 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003830#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003831
3832 /* Check if we have buffered and/or fully reassembled the
3833 * next handshake message. */
3834 hs_buf = &hs->buffering.hs[0];
3835 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3836 {
3837 /* Synthesize a record containing the buffered HS message. */
3838 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3839 ( hs_buf->data[2] << 8 ) |
3840 hs_buf->data[3];
3841
3842 /* Double-check that we haven't accidentally buffered
3843 * a message that doesn't fit into the input buffer. */
3844 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3845 {
3846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3847 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3848 }
3849
3850 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3851 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3852 hs_buf->data, msg_len + 12 );
3853
3854 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3855 ssl->in_hslen = msg_len + 12;
3856 ssl->in_msglen = msg_len + 12;
3857 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3858
3859 ret = 0;
3860 goto exit;
3861 }
3862 else
3863 {
3864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3865 hs->in_msg_seq ) );
3866 }
3867
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003868 ret = -1;
3869
3870exit:
3871
3872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3873 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003874}
3875
Hanno Beckera02b0b42018-08-21 17:20:27 +01003876static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3877 size_t desired )
3878{
3879 int offset;
3880 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003881 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3882 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003883
Hanno Becker01315ea2018-08-21 17:22:17 +01003884 /* Get rid of future records epoch first, if such exist. */
3885 ssl_free_buffered_record( ssl );
3886
3887 /* Check if we have enough space available now. */
3888 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3889 hs->buffering.total_bytes_buffered ) )
3890 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003891 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003892 return( 0 );
3893 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003894
Hanno Becker4f432ad2018-08-28 10:02:32 +01003895 /* We don't have enough space to buffer the next expected handshake
3896 * message. Remove buffers used for future messages to gain space,
3897 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003898 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3899 offset >= 0; offset-- )
3900 {
3901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3902 offset ) );
3903
Hanno Beckerb309b922018-08-23 13:18:05 +01003904 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003905
3906 /* Check if we have enough space available now. */
3907 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3908 hs->buffering.total_bytes_buffered ) )
3909 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003911 return( 0 );
3912 }
3913 }
3914
3915 return( -1 );
3916}
3917
Hanno Becker40f50842018-08-15 14:48:01 +01003918static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3919{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003920 int ret = 0;
3921 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3922
3923 if( hs == NULL )
3924 return( 0 );
3925
3926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3927
3928 switch( ssl->in_msgtype )
3929 {
3930 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003932
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003933 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003934 break;
3935
3936 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003937 {
3938 unsigned recv_msg_seq_offset;
3939 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3940 mbedtls_ssl_hs_buffer *hs_buf;
3941 size_t msg_len = ssl->in_hslen - 12;
3942
3943 /* We should never receive an old handshake
3944 * message - double-check nonetheless. */
3945 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3946 {
3947 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3948 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3949 }
3950
3951 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3952 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3953 {
3954 /* Silently ignore -- message too far in the future */
3955 MBEDTLS_SSL_DEBUG_MSG( 2,
3956 ( "Ignore future HS message with sequence number %u, "
3957 "buffering window %u - %u",
3958 recv_msg_seq, ssl->handshake->in_msg_seq,
3959 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3960
3961 goto exit;
3962 }
3963
3964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3965 recv_msg_seq, recv_msg_seq_offset ) );
3966
3967 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3968
3969 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003970 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003971 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003972 size_t reassembly_buf_sz;
3973
Hanno Becker37f95322018-08-16 13:55:32 +01003974 hs_buf->is_fragmented =
3975 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3976
3977 /* We copy the message back into the input buffer
3978 * after reassembly, so check that it's not too large.
3979 * This is an implementation-specific limitation
3980 * and not one from the standard, hence it is not
3981 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003982 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003983 {
3984 /* Ignore message */
3985 goto exit;
3986 }
3987
Hanno Beckere0b150f2018-08-21 15:51:03 +01003988 /* Check if we have enough space to buffer the message. */
3989 if( hs->buffering.total_bytes_buffered >
3990 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3991 {
3992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3993 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3994 }
3995
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003996 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3997 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003998
3999 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4000 hs->buffering.total_bytes_buffered ) )
4001 {
4002 if( recv_msg_seq_offset > 0 )
4003 {
4004 /* If we can't buffer a future message because
4005 * of space limitations -- ignore. */
4006 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",
4007 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4008 (unsigned) hs->buffering.total_bytes_buffered ) );
4009 goto exit;
4010 }
Hanno Beckere1801392018-08-21 16:51:05 +01004011 else
4012 {
4013 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",
4014 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4015 (unsigned) hs->buffering.total_bytes_buffered ) );
4016 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004017
Hanno Beckera02b0b42018-08-21 17:20:27 +01004018 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004019 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004020 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",
4021 (unsigned) msg_len,
4022 (unsigned) reassembly_buf_sz,
4023 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004024 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004025 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4026 goto exit;
4027 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004028 }
4029
4030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4031 msg_len ) );
4032
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004033 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4034 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004035 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004036 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004037 goto exit;
4038 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004039 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004040
4041 /* Prepare final header: copy msg_type, length and message_seq,
4042 * then add standardised fragment_offset and fragment_length */
4043 memcpy( hs_buf->data, ssl->in_msg, 6 );
4044 memset( hs_buf->data + 6, 0, 3 );
4045 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4046
4047 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004048
4049 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004050 }
4051 else
4052 {
4053 /* Make sure msg_type and length are consistent */
4054 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4055 {
4056 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4057 /* Ignore */
4058 goto exit;
4059 }
4060 }
4061
Hanno Becker4422bbb2018-08-20 09:40:19 +01004062 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004063 {
4064 size_t frag_len, frag_off;
4065 unsigned char * const msg = hs_buf->data + 12;
4066
4067 /*
4068 * Check and copy current fragment
4069 */
4070
4071 /* Validation of header fields already done in
4072 * mbedtls_ssl_prepare_handshake_record(). */
4073 frag_off = ssl_get_hs_frag_off( ssl );
4074 frag_len = ssl_get_hs_frag_len( ssl );
4075
4076 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4077 frag_off, frag_len ) );
4078 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4079
4080 if( hs_buf->is_fragmented )
4081 {
4082 unsigned char * const bitmask = msg + msg_len;
4083 ssl_bitmask_set( bitmask, frag_off, frag_len );
4084 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4085 msg_len ) == 0 );
4086 }
4087 else
4088 {
4089 hs_buf->is_complete = 1;
4090 }
4091
4092 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4093 hs_buf->is_complete ? "" : "not yet " ) );
4094 }
4095
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004096 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004097 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004098
4099 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004100 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004101 break;
4102 }
4103
4104exit:
4105
4106 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4107 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004108}
4109#endif /* MBEDTLS_SSL_PROTO_DTLS */
4110
Hanno Becker1097b342018-08-15 14:09:41 +01004111static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004112{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004113 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004114 * Consume last content-layer message and potentially
4115 * update in_msglen which keeps track of the contents'
4116 * consumption state.
4117 *
4118 * (1) Handshake messages:
4119 * Remove last handshake message, move content
4120 * and adapt in_msglen.
4121 *
4122 * (2) Alert messages:
4123 * Consume whole record content, in_msglen = 0.
4124 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004125 * (3) Change cipher spec:
4126 * Consume whole record content, in_msglen = 0.
4127 *
4128 * (4) Application data:
4129 * Don't do anything - the record layer provides
4130 * the application data as a stream transport
4131 * and consumes through mbedtls_ssl_read only.
4132 *
4133 */
4134
4135 /* Case (1): Handshake messages */
4136 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004137 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004138 /* Hard assertion to be sure that no application data
4139 * is in flight, as corrupting ssl->in_msglen during
4140 * ssl->in_offt != NULL is fatal. */
4141 if( ssl->in_offt != NULL )
4142 {
4143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4145 }
4146
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004147 /*
4148 * Get next Handshake message in the current record
4149 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004150
Hanno Becker4a810fb2017-05-24 16:27:30 +01004151 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004152 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004153 * current handshake content: If DTLS handshake
4154 * fragmentation is used, that's the fragment
4155 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004156 * size here is faulty and should be changed at
4157 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004158 * (2) While it doesn't seem to cause problems, one
4159 * has to be very careful not to assume that in_hslen
4160 * is always <= in_msglen in a sensible communication.
4161 * Again, it's wrong for DTLS handshake fragmentation.
4162 * The following check is therefore mandatory, and
4163 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004164 * Additionally, ssl->in_hslen might be arbitrarily out of
4165 * bounds after handling a DTLS message with an unexpected
4166 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004167 */
4168 if( ssl->in_hslen < ssl->in_msglen )
4169 {
4170 ssl->in_msglen -= ssl->in_hslen;
4171 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4172 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004173
Hanno Becker4a810fb2017-05-24 16:27:30 +01004174 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4175 ssl->in_msg, ssl->in_msglen );
4176 }
4177 else
4178 {
4179 ssl->in_msglen = 0;
4180 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004181
Hanno Becker4a810fb2017-05-24 16:27:30 +01004182 ssl->in_hslen = 0;
4183 }
4184 /* Case (4): Application data */
4185 else if( ssl->in_offt != NULL )
4186 {
4187 return( 0 );
4188 }
4189 /* Everything else (CCS & Alerts) */
4190 else
4191 {
4192 ssl->in_msglen = 0;
4193 }
4194
Hanno Becker1097b342018-08-15 14:09:41 +01004195 return( 0 );
4196}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004197
Hanno Beckere74d5562018-08-15 14:26:08 +01004198static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4199{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004200 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004201 return( 1 );
4202
4203 return( 0 );
4204}
4205
Hanno Becker5f066e72018-08-16 14:56:31 +01004206#if defined(MBEDTLS_SSL_PROTO_DTLS)
4207
4208static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4209{
4210 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4211 if( hs == NULL )
4212 return;
4213
Hanno Becker01315ea2018-08-21 17:22:17 +01004214 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004215 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004216 hs->buffering.total_bytes_buffered -=
4217 hs->buffering.future_record.len;
4218
4219 mbedtls_free( hs->buffering.future_record.data );
4220 hs->buffering.future_record.data = NULL;
4221 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004222}
4223
4224static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4225{
4226 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4227 unsigned char * rec;
4228 size_t rec_len;
4229 unsigned rec_epoch;
4230
4231 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4232 return( 0 );
4233
4234 if( hs == NULL )
4235 return( 0 );
4236
Hanno Becker5f066e72018-08-16 14:56:31 +01004237 rec = hs->buffering.future_record.data;
4238 rec_len = hs->buffering.future_record.len;
4239 rec_epoch = hs->buffering.future_record.epoch;
4240
4241 if( rec == NULL )
4242 return( 0 );
4243
Hanno Becker4cb782d2018-08-20 11:19:05 +01004244 /* Only consider loading future records if the
4245 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004246 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004247 return( 0 );
4248
Hanno Becker5f066e72018-08-16 14:56:31 +01004249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4250
4251 if( rec_epoch != ssl->in_epoch )
4252 {
4253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4254 goto exit;
4255 }
4256
4257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4258
4259 /* Double-check that the record is not too large */
4260 if( rec_len > MBEDTLS_SSL_IN_BUFFER_LEN -
4261 (size_t)( ssl->in_hdr - ssl->in_buf ) )
4262 {
4263 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4264 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4265 }
4266
4267 memcpy( ssl->in_hdr, rec, rec_len );
4268 ssl->in_left = rec_len;
4269 ssl->next_record_offset = 0;
4270
4271 ssl_free_buffered_record( ssl );
4272
4273exit:
4274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4275 return( 0 );
4276}
4277
Hanno Becker519f15d2019-07-11 12:43:20 +01004278static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4279 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004280{
4281 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004282
4283 /* Don't buffer future records outside handshakes. */
4284 if( hs == NULL )
4285 return( 0 );
4286
4287 /* Only buffer handshake records (we are only interested
4288 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004289 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004290 return( 0 );
4291
4292 /* Don't buffer more than one future epoch record. */
4293 if( hs->buffering.future_record.data != NULL )
4294 return( 0 );
4295
Hanno Becker01315ea2018-08-21 17:22:17 +01004296 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004297 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004298 hs->buffering.total_bytes_buffered ) )
4299 {
4300 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 +01004301 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004302 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004303 return( 0 );
4304 }
4305
Hanno Becker5f066e72018-08-16 14:56:31 +01004306 /* Buffer record */
4307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4308 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004309 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004310
4311 /* ssl_parse_record_header() only considers records
4312 * of the next epoch as candidates for buffering. */
4313 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004314 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004315
4316 hs->buffering.future_record.data =
4317 mbedtls_calloc( 1, hs->buffering.future_record.len );
4318 if( hs->buffering.future_record.data == NULL )
4319 {
4320 /* If we run out of RAM trying to buffer a
4321 * record from the next epoch, just ignore. */
4322 return( 0 );
4323 }
4324
Hanno Becker519f15d2019-07-11 12:43:20 +01004325 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004326
Hanno Becker519f15d2019-07-11 12:43:20 +01004327 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004328 return( 0 );
4329}
4330
4331#endif /* MBEDTLS_SSL_PROTO_DTLS */
4332
Hanno Beckere74d5562018-08-15 14:26:08 +01004333static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004334{
Janos Follath865b3eb2019-12-16 11:46:15 +00004335 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004336 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004337
Hanno Becker5f066e72018-08-16 14:56:31 +01004338#if defined(MBEDTLS_SSL_PROTO_DTLS)
4339 /* We might have buffered a future record; if so,
4340 * and if the epoch matches now, load it.
4341 * On success, this call will set ssl->in_left to
4342 * the length of the buffered record, so that
4343 * the calls to ssl_fetch_input() below will
4344 * essentially be no-ops. */
4345 ret = ssl_load_buffered_record( ssl );
4346 if( ret != 0 )
4347 return( ret );
4348#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004349
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004350 /* Ensure that we have enough space available for the default form
4351 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4352 * with no space for CIDs counted in). */
4353 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4354 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004357 return( ret );
4358 }
4359
Hanno Beckere5e7e782019-07-11 12:29:35 +01004360 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4361 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004362 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004363#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004364 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004365 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004366 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4367 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004368 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004369 if( ret != 0 )
4370 return( ret );
4371
4372 /* Fall through to handling of unexpected records */
4373 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4374 }
4375
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004376 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4377 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004378#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004379 /* Reset in pointers to default state for TLS/DTLS records,
4380 * assuming no CID and no offset between record content and
4381 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004382 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004383
Hanno Becker7ae20e02019-07-12 08:33:49 +01004384 /* Setup internal message pointers from record structure. */
4385 ssl->in_msgtype = rec.type;
4386#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4387 ssl->in_len = ssl->in_cid + rec.cid_len;
4388#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4389 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4390 ssl->in_msglen = rec.data_len;
4391
Hanno Becker2fddd372019-07-10 14:37:41 +01004392 ret = ssl_check_client_reconnect( ssl );
4393 if( ret != 0 )
4394 return( ret );
4395#endif
4396
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004397 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004398 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004399
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004400 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4401 "(header)" ) );
4402 }
4403 else
4404 {
4405 /* Skip invalid record and the rest of the datagram */
4406 ssl->next_record_offset = 0;
4407 ssl->in_left = 0;
4408
4409 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4410 "(header)" ) );
4411 }
4412
4413 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004414 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004415 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004416 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004417#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004418 {
4419 return( ret );
4420 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004421 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004423#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004424 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004425 {
Hanno Beckera8814792019-07-10 15:01:45 +01004426 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004427 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004428 if( ssl->next_record_offset < ssl->in_left )
4429 {
4430 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4431 }
4432 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004433 else
4434#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004435 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004436 /*
4437 * Fetch record contents from underlying transport.
4438 */
Hanno Beckera3175662019-07-11 12:50:29 +01004439 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004440 if( ret != 0 )
4441 {
4442 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4443 return( ret );
4444 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004445
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004446 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004447 }
4448
4449 /*
4450 * Decrypt record contents.
4451 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004452
Hanno Beckerfdf66042019-07-11 13:07:45 +01004453 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004454 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004455#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004456 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004457 {
4458 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004459 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004460 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004461 /* Except when waiting for Finished as a bad mac here
4462 * probably means something went wrong in the handshake
4463 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4464 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4465 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4466 {
4467#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4468 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4469 {
4470 mbedtls_ssl_send_alert_message( ssl,
4471 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4472 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4473 }
4474#endif
4475 return( ret );
4476 }
4477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004478#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004479 if( ssl->conf->badmac_limit != 0 &&
4480 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4483 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004484 }
4485#endif
4486
Hanno Becker4a810fb2017-05-24 16:27:30 +01004487 /* As above, invalid records cause
4488 * dismissal of the whole datagram. */
4489
4490 ssl->next_record_offset = 0;
4491 ssl->in_left = 0;
4492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004494 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004495 }
4496
4497 return( ret );
4498 }
4499 else
4500#endif
4501 {
4502 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004503#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4504 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004505 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004506 mbedtls_ssl_send_alert_message( ssl,
4507 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4508 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004509 }
4510#endif
4511 return( ret );
4512 }
4513 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004514
Hanno Becker44d89b22019-07-12 09:40:44 +01004515
4516 /* Reset in pointers to default state for TLS/DTLS records,
4517 * assuming no CID and no offset between record content and
4518 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004519 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004520#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4521 ssl->in_len = ssl->in_cid + rec.cid_len;
4522#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004523 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004524
Hanno Becker8685c822019-07-12 09:37:30 +01004525 /* The record content type may change during decryption,
4526 * so re-read it. */
4527 ssl->in_msgtype = rec.type;
4528 /* Also update the input buffer, because unfortunately
4529 * the server-side ssl_parse_client_hello() reparses the
4530 * record header when receiving a ClientHello initiating
4531 * a renegotiation. */
4532 ssl->in_hdr[0] = rec.type;
4533 ssl->in_msg = rec.buf + rec.data_offset;
4534 ssl->in_msglen = rec.data_len;
4535 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4536 ssl->in_len[1] = (unsigned char)( rec.data_len );
4537
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004538#if defined(MBEDTLS_ZLIB_SUPPORT)
4539 if( ssl->transform_in != NULL &&
4540 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4541 {
4542 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4543 {
4544 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4545 return( ret );
4546 }
4547
4548 /* Check actual (decompress) record content length against
4549 * configured maximum. */
4550 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4551 {
4552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4553 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4554 }
4555 }
4556#endif /* MBEDTLS_ZLIB_SUPPORT */
4557
Simon Butcher99000142016-10-13 17:21:01 +01004558 return( 0 );
4559}
4560
4561int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4562{
Janos Follath865b3eb2019-12-16 11:46:15 +00004563 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004564
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004565 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004566 * Handle particular types of records
4567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004568 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004569 {
Simon Butcher99000142016-10-13 17:21:01 +01004570 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4571 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004572 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004573 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004574 }
4575
Hanno Beckere678eaa2018-08-21 14:57:46 +01004576 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004577 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004578 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004579 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4581 ssl->in_msglen ) );
4582 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004583 }
4584
Hanno Beckere678eaa2018-08-21 14:57:46 +01004585 if( ssl->in_msg[0] != 1 )
4586 {
4587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4588 ssl->in_msg[0] ) );
4589 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4590 }
4591
4592#if defined(MBEDTLS_SSL_PROTO_DTLS)
4593 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4594 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4595 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4596 {
4597 if( ssl->handshake == NULL )
4598 {
4599 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4600 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4601 }
4602
4603 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4604 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4605 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004606#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004607 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004609 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004610 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004611 if( ssl->in_msglen != 2 )
4612 {
4613 /* Note: Standard allows for more than one 2 byte alert
4614 to be packed in a single message, but Mbed TLS doesn't
4615 currently support this. */
4616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4617 ssl->in_msglen ) );
4618 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4619 }
4620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004622 ssl->in_msg[0], ssl->in_msg[1] ) );
4623
4624 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004625 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004627 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004628 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004629 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004630 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004631 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004632 }
4633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004634 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4635 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4638 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004639 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004640
4641#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4642 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4643 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4644 {
Hanno Becker90333da2017-10-10 11:27:13 +01004645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004646 /* Will be handled when trying to parse ServerHello */
4647 return( 0 );
4648 }
4649#endif
4650
4651#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4652 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4653 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4654 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4655 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4656 {
4657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4658 /* Will be handled in mbedtls_ssl_parse_certificate() */
4659 return( 0 );
4660 }
4661#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4662
4663 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004664 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004665 }
4666
Hanno Beckerc76c6192017-06-06 10:03:17 +01004667#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004668 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004669 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004670 /* Drop unexpected ApplicationData records,
4671 * except at the beginning of renegotiations */
4672 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4673 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4674#if defined(MBEDTLS_SSL_RENEGOTIATION)
4675 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4676 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004677#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004678 )
4679 {
4680 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4681 return( MBEDTLS_ERR_SSL_NON_FATAL );
4682 }
4683
4684 if( ssl->handshake != NULL &&
4685 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4686 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004687 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004688 }
4689 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004690#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004691
Paul Bakker5121ce52009-01-03 21:22:43 +00004692 return( 0 );
4693}
4694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004696{
irwir6c0da642019-09-26 21:07:41 +03004697 return( mbedtls_ssl_send_alert_message( ssl,
4698 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4699 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004700}
4701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004702int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004703 unsigned char level,
4704 unsigned char message )
4705{
Janos Follath865b3eb2019-12-16 11:46:15 +00004706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004707
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004708 if( ssl == NULL || ssl->conf == NULL )
4709 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004712 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004715 ssl->out_msglen = 2;
4716 ssl->out_msg[0] = level;
4717 ssl->out_msg[1] = message;
4718
Hanno Becker67bc7c32018-08-06 11:33:50 +01004719 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004720 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004722 return( ret );
4723 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004724 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004725
4726 return( 0 );
4727}
4728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004729int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004730{
Janos Follath865b3eb2019-12-16 11:46:15 +00004731 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004734
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004735 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004736 ssl->out_msglen = 1;
4737 ssl->out_msg[0] = 1;
4738
Paul Bakker5121ce52009-01-03 21:22:43 +00004739 ssl->state++;
4740
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004741 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004742 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004743 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004744 return( ret );
4745 }
4746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004748
4749 return( 0 );
4750}
4751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004753{
Janos Follath865b3eb2019-12-16 11:46:15 +00004754 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004755
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004756 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004757
Hanno Becker327c93b2018-08-15 13:56:18 +01004758 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004760 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004761 return( ret );
4762 }
4763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004765 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004766 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004767 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4768 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004769 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004770 }
4771
Hanno Beckere678eaa2018-08-21 14:57:46 +01004772 /* CCS records are only accepted if they have length 1 and content '1',
4773 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004774
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004775 /*
4776 * Switch to our negotiated transform and session parameters for inbound
4777 * data.
4778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004780 ssl->transform_in = ssl->transform_negotiate;
4781 ssl->session_in = ssl->session_negotiate;
4782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004783#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004784 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004785 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004787 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004788#endif
4789
4790 /* Increment epoch */
4791 if( ++ssl->in_epoch == 0 )
4792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004793 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004794 /* This is highly unlikely to happen for legitimate reasons, so
4795 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004796 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004797 }
4798 }
4799 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004801 memset( ssl->in_ctr, 0, 8 );
4802
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004803 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004805#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4806 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004808 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004809 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004810 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004811 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4812 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004813 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004814 }
4815 }
4816#endif
4817
Paul Bakker5121ce52009-01-03 21:22:43 +00004818 ssl->state++;
4819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004821
4822 return( 0 );
4823}
4824
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004825/* Once ssl->out_hdr as the address of the beginning of the
4826 * next outgoing record is set, deduce the other pointers.
4827 *
4828 * Note: For TLS, we save the implicit record sequence number
4829 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4830 * and the caller has to make sure there's space for this.
4831 */
4832
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004833void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4834 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004835{
4836#if defined(MBEDTLS_SSL_PROTO_DTLS)
4837 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4838 {
4839 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004840#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004841 ssl->out_cid = ssl->out_ctr + 8;
4842 ssl->out_len = ssl->out_cid;
4843 if( transform != NULL )
4844 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004845#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004846 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004847#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004848 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004849 }
4850 else
4851#endif
4852 {
4853 ssl->out_ctr = ssl->out_hdr - 8;
4854 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004855#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004856 ssl->out_cid = ssl->out_len;
4857#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004858 ssl->out_iv = ssl->out_hdr + 5;
4859 }
4860
4861 /* Adjust out_msg to make space for explicit IV, if used. */
4862 if( transform != NULL &&
4863 ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
4864 {
4865 ssl->out_msg = ssl->out_iv + transform->ivlen - transform->fixed_ivlen;
4866 }
4867 else
4868 ssl->out_msg = ssl->out_iv;
4869}
4870
4871/* Once ssl->in_hdr as the address of the beginning of the
4872 * next incoming record is set, deduce the other pointers.
4873 *
4874 * Note: For TLS, we save the implicit record sequence number
4875 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4876 * and the caller has to make sure there's space for this.
4877 */
4878
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004879void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004880{
Hanno Becker79594fd2019-05-08 09:38:41 +01004881 /* This function sets the pointers to match the case
4882 * of unprotected TLS/DTLS records, with both ssl->in_iv
4883 * and ssl->in_msg pointing to the beginning of the record
4884 * content.
4885 *
4886 * When decrypting a protected record, ssl->in_msg
4887 * will be shifted to point to the beginning of the
4888 * record plaintext.
4889 */
4890
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004891#if defined(MBEDTLS_SSL_PROTO_DTLS)
4892 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4893 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004894 /* This sets the header pointers to match records
4895 * without CID. When we receive a record containing
4896 * a CID, the fields are shifted accordingly in
4897 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004898 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004899#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004900 ssl->in_cid = ssl->in_ctr + 8;
4901 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004902#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004903 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004904#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004905 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004906 }
4907 else
4908#endif
4909 {
4910 ssl->in_ctr = ssl->in_hdr - 8;
4911 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004912#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004913 ssl->in_cid = ssl->in_len;
4914#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004915 ssl->in_iv = ssl->in_hdr + 5;
4916 }
4917
Hanno Becker79594fd2019-05-08 09:38:41 +01004918 /* This will be adjusted at record decryption time. */
4919 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004920}
4921
Paul Bakker5121ce52009-01-03 21:22:43 +00004922/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004923 * Setup an SSL context
4924 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004925
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004926void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004927{
4928 /* Set the incoming and outgoing record pointers. */
4929#if defined(MBEDTLS_SSL_PROTO_DTLS)
4930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4931 {
4932 ssl->out_hdr = ssl->out_buf;
4933 ssl->in_hdr = ssl->in_buf;
4934 }
4935 else
4936#endif /* MBEDTLS_SSL_PROTO_DTLS */
4937 {
4938 ssl->out_hdr = ssl->out_buf + 8;
4939 ssl->in_hdr = ssl->in_buf + 8;
4940 }
4941
4942 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004943 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4944 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004945}
4946
Paul Bakker5121ce52009-01-03 21:22:43 +00004947/*
4948 * SSL get accessors
4949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004951{
4952 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4953}
4954
Hanno Becker8b170a02017-10-10 11:51:19 +01004955int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4956{
4957 /*
4958 * Case A: We're currently holding back
4959 * a message for further processing.
4960 */
4961
4962 if( ssl->keep_current_message == 1 )
4963 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004964 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004965 return( 1 );
4966 }
4967
4968 /*
4969 * Case B: Further records are pending in the current datagram.
4970 */
4971
4972#if defined(MBEDTLS_SSL_PROTO_DTLS)
4973 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4974 ssl->in_left > ssl->next_record_offset )
4975 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004976 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004977 return( 1 );
4978 }
4979#endif /* MBEDTLS_SSL_PROTO_DTLS */
4980
4981 /*
4982 * Case C: A handshake message is being processed.
4983 */
4984
Hanno Becker8b170a02017-10-10 11:51:19 +01004985 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4986 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004987 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004988 return( 1 );
4989 }
4990
4991 /*
4992 * Case D: An application data message is being processed
4993 */
4994 if( ssl->in_offt != NULL )
4995 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004996 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004997 return( 1 );
4998 }
4999
5000 /*
5001 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005002 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005003 * we implement support for multiple alerts in single records.
5004 */
5005
5006 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5007 return( 0 );
5008}
5009
Paul Bakker43ca69c2011-01-15 17:35:19 +00005010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005012{
Hanno Becker3136ede2018-08-17 15:28:19 +01005013 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005015 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005016
Hanno Becker5903de42019-05-03 14:46:38 +01005017 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5018
Hanno Becker78640902018-08-13 16:35:15 +01005019 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005020 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022#if defined(MBEDTLS_ZLIB_SUPPORT)
5023 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5024 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005025#endif
5026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005027 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005028 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005029 case MBEDTLS_MODE_GCM:
5030 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005031 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005032 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005033 transform_expansion = transform->minlen;
5034 break;
5035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005036 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005037
5038 block_size = mbedtls_cipher_get_block_size(
5039 &transform->cipher_ctx_enc );
5040
Hanno Becker3136ede2018-08-17 15:28:19 +01005041 /* Expansion due to the addition of the MAC. */
5042 transform_expansion += transform->maclen;
5043
5044 /* Expansion due to the addition of CBC padding;
5045 * Theoretically up to 256 bytes, but we never use
5046 * more than the block size of the underlying cipher. */
5047 transform_expansion += block_size;
5048
5049 /* For TLS 1.1 or higher, an explicit IV is added
5050 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005051#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5052 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005053 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005054#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005055
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005056 break;
5057
5058 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005061 }
5062
Hanno Beckera0e20d02019-05-15 14:03:01 +01005063#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005064 if( transform->out_cid_len != 0 )
5065 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005066#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005067
Hanno Becker5903de42019-05-03 14:46:38 +01005068 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005069}
5070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005071#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005072/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005073 * Check record counters and renegotiate if they're above the limit.
5074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005075static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005076{
Hanno Beckerdd772292020-02-05 10:38:31 +00005077 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005078 int in_ctr_cmp;
5079 int out_ctr_cmp;
5080
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005081 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5082 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005083 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005084 {
5085 return( 0 );
5086 }
5087
Andres AG2196c7f2016-12-15 17:01:16 +00005088 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5089 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005090 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005091 ssl->conf->renego_period + ep_len, 8 - ep_len );
5092
5093 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005094 {
5095 return( 0 );
5096 }
5097
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005100}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005102
5103/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005104 * Receive application data decrypted from the SSL layer
5105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005106int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005107{
Janos Follath865b3eb2019-12-16 11:46:15 +00005108 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005109 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005110
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005111 if( ssl == NULL || ssl->conf == NULL )
5112 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005114 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005116#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005117 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005118 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005120 return( ret );
5121
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005122 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005123 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005124 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005125 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005126 return( ret );
5127 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005128 }
5129#endif
5130
Hanno Becker4a810fb2017-05-24 16:27:30 +01005131 /*
5132 * Check if renegotiation is necessary and/or handshake is
5133 * in process. If yes, perform/continue, and fall through
5134 * if an unexpected packet is received while the client
5135 * is waiting for the ServerHello.
5136 *
5137 * (There is no equivalent to the last condition on
5138 * the server-side as it is not treated as within
5139 * a handshake while waiting for the ClientHello
5140 * after a renegotiation request.)
5141 */
5142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005143#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005144 ret = ssl_check_ctr_renegotiate( ssl );
5145 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5146 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005147 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005148 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005149 return( ret );
5150 }
5151#endif
5152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005153 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005154 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005155 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005156 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5157 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005158 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005159 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005160 return( ret );
5161 }
5162 }
5163
Hanno Beckere41158b2017-10-23 13:30:32 +01005164 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005165 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005166 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005167 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005168 if( ssl->f_get_timer != NULL &&
5169 ssl->f_get_timer( ssl->p_timer ) == -1 )
5170 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005171 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005172 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005173
Hanno Becker327c93b2018-08-15 13:56:18 +01005174 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005175 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005176 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5177 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005178
Hanno Becker4a810fb2017-05-24 16:27:30 +01005179 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5180 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005181 }
5182
5183 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005184 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005185 {
5186 /*
5187 * OpenSSL sends empty messages to randomize the IV
5188 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005189 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005190 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005192 return( 0 );
5193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005194 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005195 return( ret );
5196 }
5197 }
5198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005199 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005200 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005201 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005202
Hanno Becker4a810fb2017-05-24 16:27:30 +01005203 /*
5204 * - For client-side, expect SERVER_HELLO_REQUEST.
5205 * - For server-side, expect CLIENT_HELLO.
5206 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5207 */
5208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005209#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005210 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005211 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005212 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005213 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005215
5216 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005217#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005218 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005219 {
5220 continue;
5221 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005222#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005223 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005224 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005225#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005226
Hanno Becker4a810fb2017-05-24 16:27:30 +01005227#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005228 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005231 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005232
5233 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005234#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005235 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005236 {
5237 continue;
5238 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005239#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005240 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005241 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005242#endif /* MBEDTLS_SSL_SRV_C */
5243
Hanno Becker21df7f92017-10-17 11:03:26 +01005244#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005245 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005246 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5247 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5248 ssl->conf->allow_legacy_renegotiation ==
5249 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5250 {
5251 /*
5252 * Accept renegotiation request
5253 */
Paul Bakker48916f92012-09-16 19:57:18 +00005254
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005255 /* DTLS clients need to know renego is server-initiated */
5256#if defined(MBEDTLS_SSL_PROTO_DTLS)
5257 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5258 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5259 {
5260 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5261 }
5262#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005263 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005264 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5265 ret != 0 )
5266 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005267 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5268 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005269 return( ret );
5270 }
5271 }
5272 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005273#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005274 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005275 /*
5276 * Refuse renegotiation
5277 */
5278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005279 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005281#if defined(MBEDTLS_SSL_PROTO_SSL3)
5282 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005283 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005284 /* SSLv3 does not have a "no_renegotiation" warning, so
5285 we send a fatal alert and abort the connection. */
5286 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5287 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5288 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005289 }
5290 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005291#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5292#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5293 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5294 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005295 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005296 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5297 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5298 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005299 {
5300 return( ret );
5301 }
Paul Bakker48916f92012-09-16 19:57:18 +00005302 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005303 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005304#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5305 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005306 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005307 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5308 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005309 }
Paul Bakker48916f92012-09-16 19:57:18 +00005310 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005311
Hanno Becker90333da2017-10-10 11:27:13 +01005312 /* At this point, we don't know whether the renegotiation has been
5313 * completed or not. The cases to consider are the following:
5314 * 1) The renegotiation is complete. In this case, no new record
5315 * has been read yet.
5316 * 2) The renegotiation is incomplete because the client received
5317 * an application data record while awaiting the ServerHello.
5318 * 3) The renegotiation is incomplete because the client received
5319 * a non-handshake, non-application data message while awaiting
5320 * the ServerHello.
5321 * In each of these case, looping will be the proper action:
5322 * - For 1), the next iteration will read a new record and check
5323 * if it's application data.
5324 * - For 2), the loop condition isn't satisfied as application data
5325 * is present, hence continue is the same as break
5326 * - For 3), the loop condition is satisfied and read_record
5327 * will re-deliver the message that was held back by the client
5328 * when expecting the ServerHello.
5329 */
5330 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005331 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005332#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005333 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005334 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005335 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005336 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005337 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005340 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005341 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005342 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005343 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005344 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005347 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5348 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005351 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005352 }
5353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5357 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005358 }
5359
5360 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005361
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005362 /* We're going to return something now, cancel timer,
5363 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005365 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005366
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005367#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005368 /* If we requested renego but received AppData, resend HelloRequest.
5369 * Do it now, after setting in_offt, to avoid taking this branch
5370 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005372 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005373 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005374 {
Hanno Becker786300f2020-02-05 10:46:40 +00005375 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005376 {
Hanno Becker786300f2020-02-05 10:46:40 +00005377 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5378 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005379 return( ret );
5380 }
5381 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005382#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005383#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005384 }
5385
5386 n = ( len < ssl->in_msglen )
5387 ? len : ssl->in_msglen;
5388
5389 memcpy( buf, ssl->in_offt, n );
5390 ssl->in_msglen -= n;
5391
5392 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005393 {
5394 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005395 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005396 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005397 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005398 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005399 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005400 /* more data available */
5401 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005402 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005405
Paul Bakker23986e52011-04-24 08:57:21 +00005406 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005407}
5408
5409/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005410 * Send application data to be encrypted by the SSL layer, taking care of max
5411 * fragment length and buffer size.
5412 *
5413 * According to RFC 5246 Section 6.2.1:
5414 *
5415 * Zero-length fragments of Application data MAY be sent as they are
5416 * potentially useful as a traffic analysis countermeasure.
5417 *
5418 * Therefore, it is possible that the input message length is 0 and the
5419 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005420 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005421static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005422 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005423{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005424 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5425 const size_t max_len = (size_t) ret;
5426
5427 if( ret < 0 )
5428 {
5429 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5430 return( ret );
5431 }
5432
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005433 if( len > max_len )
5434 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005436 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005437 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005439 "maximum fragment length: %d > %d",
5440 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005442 }
5443 else
5444#endif
5445 len = max_len;
5446 }
Paul Bakker887bd502011-06-08 13:10:54 +00005447
Paul Bakker5121ce52009-01-03 21:22:43 +00005448 if( ssl->out_left != 0 )
5449 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005450 /*
5451 * The user has previously tried to send the data and
5452 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5453 * written. In this case, we expect the high-level write function
5454 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005456 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005457 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005458 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005459 return( ret );
5460 }
5461 }
Paul Bakker887bd502011-06-08 13:10:54 +00005462 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005463 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005464 /*
5465 * The user is trying to send a message the first time, so we need to
5466 * copy the data into the internal buffers and setup the data structure
5467 * to keep track of partial writes
5468 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005469 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005470 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005471 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005472
Hanno Becker67bc7c32018-08-06 11:33:50 +01005473 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005474 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005475 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005476 return( ret );
5477 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005478 }
5479
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005480 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005481}
5482
5483/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005484 * Write application data, doing 1/n-1 splitting if necessary.
5485 *
5486 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005487 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005488 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005490#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005491static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005492 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005493{
Janos Follath865b3eb2019-12-16 11:46:15 +00005494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005495
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005496 if( ssl->conf->cbc_record_splitting ==
5497 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005498 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005499 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5500 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5501 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005502 {
5503 return( ssl_write_real( ssl, buf, len ) );
5504 }
5505
5506 if( ssl->split_done == 0 )
5507 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005508 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005509 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005510 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005511 }
5512
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005513 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5514 return( ret );
5515 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005516
5517 return( ret + 1 );
5518}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005520
5521/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005522 * Write application data (public-facing wrapper)
5523 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005524int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005525{
Janos Follath865b3eb2019-12-16 11:46:15 +00005526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005527
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005529
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005530 if( ssl == NULL || ssl->conf == NULL )
5531 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5532
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005533#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005534 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5535 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005536 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005537 return( ret );
5538 }
5539#endif
5540
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005541 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005542 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005543 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005544 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005545 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005546 return( ret );
5547 }
5548 }
5549
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005550#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005551 ret = ssl_write_split( ssl, buf, len );
5552#else
5553 ret = ssl_write_real( ssl, buf, len );
5554#endif
5555
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005557
5558 return( ret );
5559}
5560
5561/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005562 * Notify the peer that the connection is being closed
5563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005564int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005565{
Janos Follath865b3eb2019-12-16 11:46:15 +00005566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005567
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005568 if( ssl == NULL || ssl->conf == NULL )
5569 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005572
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005573 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005574 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005577 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005578 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5579 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5580 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005581 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005582 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005583 return( ret );
5584 }
5585 }
5586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005588
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005589 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005590}
5591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005592void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005593{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005594 if( transform == NULL )
5595 return;
5596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005597#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005598 deflateEnd( &transform->ctx_deflate );
5599 inflateEnd( &transform->ctx_inflate );
5600#endif
5601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005602 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5603 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005604
Hanno Beckerd56ed242018-01-03 15:32:51 +00005605#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005606 mbedtls_md_free( &transform->md_ctx_enc );
5607 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005608#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005609
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005610 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005611}
5612
Hanno Becker0271f962018-08-16 13:23:47 +01005613#if defined(MBEDTLS_SSL_PROTO_DTLS)
5614
Hanno Becker533ab5f2020-02-05 10:49:13 +00005615void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005616{
5617 unsigned offset;
5618 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5619
5620 if( hs == NULL )
5621 return;
5622
Hanno Becker283f5ef2018-08-24 09:34:47 +01005623 ssl_free_buffered_record( ssl );
5624
Hanno Becker0271f962018-08-16 13:23:47 +01005625 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005626 ssl_buffering_free_slot( ssl, offset );
5627}
5628
5629static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5630 uint8_t slot )
5631{
5632 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5633 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005634
5635 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5636 return;
5637
Hanno Beckere605b192018-08-21 15:59:07 +01005638 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005639 {
Hanno Beckere605b192018-08-21 15:59:07 +01005640 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005641 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005642 mbedtls_free( hs_buf->data );
5643 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005644 }
5645}
5646
5647#endif /* MBEDTLS_SSL_PROTO_DTLS */
5648
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005649/*
5650 * Convert version numbers to/from wire format
5651 * and, for DTLS, to/from TLS equivalent.
5652 *
5653 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005654 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005655 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5656 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005658void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005659 unsigned char ver[2] )
5660{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005661#if defined(MBEDTLS_SSL_PROTO_DTLS)
5662 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005663 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005664 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005665 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5666
5667 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5668 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5669 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005670 else
5671#else
5672 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005673#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005674 {
5675 ver[0] = (unsigned char) major;
5676 ver[1] = (unsigned char) minor;
5677 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005678}
5679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005680void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005681 const unsigned char ver[2] )
5682{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683#if defined(MBEDTLS_SSL_PROTO_DTLS)
5684 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005685 {
5686 *major = 255 - ver[0] + 2;
5687 *minor = 255 - ver[1] + 1;
5688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005689 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005690 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5691 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005692 else
5693#else
5694 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005695#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005696 {
5697 *major = ver[0];
5698 *minor = ver[1];
5699 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005700}
5701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702#endif /* MBEDTLS_SSL_TLS_C */