blob: 9c2d615095a4570af23f7ccc593dcbf0417953ff [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é-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035static void 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é-Gonnard5d8ba532014-09-19 15:09:21 +02002043 return;
2044 }
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é-Gonnard2cf5a7c2015-04-08 12:49:31 +02002064 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND ) ) != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002065 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2067 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002068 }
2069 }
2070#endif
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002071}
2072
2073/*
2074 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002075 */
2076int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2077{
2078 int ret = 0;
2079
2080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2081
2082 ret = mbedtls_ssl_flight_transmit( ssl );
2083
2084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2085
2086 return( ret );
2087}
2088
2089/*
2090 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002091 *
2092 * Need to remember the current message in case flush_output returns
2093 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002094 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002095 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002096int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002097{
Janos Follath865b3eb2019-12-16 11:46:15 +00002098 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002102 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002104
2105 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002106 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002107 ssl_swap_epochs( ssl );
2108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002110 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002111
2112 while( ssl->handshake->cur_msg != NULL )
2113 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002114 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002115 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002116
Hanno Beckere1dcb032018-08-17 16:47:58 +01002117 int const is_finished =
2118 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2119 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2120
Hanno Becker04da1892018-08-14 13:22:10 +01002121 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2122 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2123
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002124 /* Swap epochs before sending Finished: we can't do it after
2125 * sending ChangeCipherSpec, in case write returns WANT_READ.
2126 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002127 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002128 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002130 ssl_swap_epochs( ssl );
2131 }
2132
Hanno Becker67bc7c32018-08-06 11:33:50 +01002133 ret = ssl_get_remaining_payload_in_datagram( ssl );
2134 if( ret < 0 )
2135 return( ret );
2136 max_frag_len = (size_t) ret;
2137
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002138 /* CCS is copied as is, while HS messages may need fragmentation */
2139 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2140 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002141 if( max_frag_len == 0 )
2142 {
2143 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2144 return( ret );
2145
2146 continue;
2147 }
2148
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002149 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002150 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002151 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002152
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002153 /* Update position inside current message */
2154 ssl->handshake->cur_msg_p += cur->len;
2155 }
2156 else
2157 {
2158 const unsigned char * const p = ssl->handshake->cur_msg_p;
2159 const size_t hs_len = cur->len - 12;
2160 const size_t frag_off = p - ( cur->p + 12 );
2161 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002162 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163
Hanno Beckere1dcb032018-08-17 16:47:58 +01002164 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002165 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002166 if( is_finished )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002167 ssl_swap_epochs( ssl );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002168
Hanno Becker67bc7c32018-08-06 11:33:50 +01002169 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2170 return( ret );
2171
2172 continue;
2173 }
2174 max_hs_frag_len = max_frag_len - 12;
2175
2176 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2177 max_hs_frag_len : rem_len;
2178
2179 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002180 {
2181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002182 (unsigned) cur_hs_frag_len,
2183 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002184 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002185
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002186 /* Messages are stored with handshake headers as if not fragmented,
2187 * copy beginning of headers then fill fragmentation fields.
2188 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2189 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002190
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002191 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2192 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2193 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2194
Hanno Becker67bc7c32018-08-06 11:33:50 +01002195 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2196 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2197 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002198
2199 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2200
Hanno Becker3f7b9732018-08-28 09:53:25 +01002201 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002202 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2203 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002204 ssl->out_msgtype = cur->type;
2205
2206 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002207 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002208 }
2209
2210 /* If done with the current message move to the next one if any */
2211 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2212 {
2213 if( cur->next != NULL )
2214 {
2215 ssl->handshake->cur_msg = cur->next;
2216 ssl->handshake->cur_msg_p = cur->next->p + 12;
2217 }
2218 else
2219 {
2220 ssl->handshake->cur_msg = NULL;
2221 ssl->handshake->cur_msg_p = NULL;
2222 }
2223 }
2224
2225 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002226 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002227 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002228 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002229 return( ret );
2230 }
2231 }
2232
Hanno Becker67bc7c32018-08-06 11:33:50 +01002233 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2234 return( ret );
2235
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002236 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2238 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002239 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002242 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002243 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002244
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002246
2247 return( 0 );
2248}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002249
2250/*
2251 * To be called when the last message of an incoming flight is received.
2252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254{
2255 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002256 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002257 ssl->handshake->flight = NULL;
2258 ssl->handshake->cur_msg = NULL;
2259
2260 /* The next incoming flight will start with this msg_seq */
2261 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2262
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002263 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002264 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002265
Hanno Becker0271f962018-08-16 13:23:47 +01002266 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002267 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002268
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002269 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002270 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002271
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2273 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002274 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002276 }
2277 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002279}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002280
2281/*
2282 * To be called when the last message of an outgoing flight is send.
2283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002284void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002285{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002286 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002287 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2290 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002291 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002293 }
2294 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002296}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002298
Paul Bakker5121ce52009-01-03 21:22:43 +00002299/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002300 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002301 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002302
2303/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002304 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002305 *
2306 * - fill in handshake headers
2307 * - update handshake checksum
2308 * - DTLS: save message for resending
2309 * - then pass to the record layer
2310 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002311 * DTLS: except for HelloRequest, messages are only queued, and will only be
2312 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002313 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002314 * Inputs:
2315 * - ssl->out_msglen: 4 + actual handshake message len
2316 * (4 is the size of handshake headers for TLS)
2317 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2318 * - ssl->out_msg + 4: the handshake message body
2319 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002320 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002321 * - ssl->out_msglen: the length of the record contents
2322 * (including handshake headers but excluding record headers)
2323 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002324 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002325int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002326{
Janos Follath865b3eb2019-12-16 11:46:15 +00002327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002328 const size_t hs_len = ssl->out_msglen - 4;
2329 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002330
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2332
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002333 /*
2334 * Sanity checks
2335 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002336 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002337 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2338 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002339 /* In SSLv3, the client might send a NoCertificate alert. */
2340#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2341 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2342 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2343 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2344#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2345 {
2346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2347 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2348 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002349 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002350
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002351 /* Whenever we send anything different from a
2352 * HelloRequest we should be in a handshake - double check. */
2353 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2354 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002355 ssl->handshake == NULL )
2356 {
2357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2358 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2359 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002362 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002363 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002365 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002366 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2367 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002368 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002369#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002370
Hanno Beckerb50a2532018-08-06 11:52:54 +01002371 /* Double-check that we did not exceed the bounds
2372 * of the outgoing record buffer.
2373 * This should never fail as the various message
2374 * writing functions must obey the bounds of the
2375 * outgoing record buffer, but better be safe.
2376 *
2377 * Note: We deliberately do not check for the MTU or MFL here.
2378 */
2379 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2380 {
2381 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2382 "size %u, maximum %u",
2383 (unsigned) ssl->out_msglen,
2384 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2385 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2386 }
2387
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002388 /*
2389 * Fill handshake headers
2390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002393 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2394 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2395 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002397 /*
2398 * DTLS has additional fields in the Handshake layer,
2399 * between the length field and the actual payload:
2400 * uint16 message_seq;
2401 * uint24 fragment_offset;
2402 * uint24 fragment_length;
2403 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002405 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002406 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002407 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002408 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002409 {
2410 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2411 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002412 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002413 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002414 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2415 }
2416
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002417 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002418 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002419
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002420 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002421 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002422 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002423 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2424 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2425 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002426 }
2427 else
2428 {
2429 ssl->out_msg[4] = 0;
2430 ssl->out_msg[5] = 0;
2431 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002432
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002433 /* Handshake hashes are computed without fragmentation,
2434 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002435 memset( ssl->out_msg + 6, 0x00, 3 );
2436 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002437 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002439
Hanno Becker0207e532018-08-28 10:28:28 +01002440 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002441 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2442 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002443 }
2444
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002445 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002447 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002448 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2449 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002450 {
2451 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2452 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002453 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454 return( ret );
2455 }
2456 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002457 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002458#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002459 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002460 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002461 {
2462 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2463 return( ret );
2464 }
2465 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002466
2467 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2468
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002469 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002470}
2471
2472/*
2473 * Record layer functions
2474 */
2475
2476/*
2477 * Write current record.
2478 *
2479 * Uses:
2480 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2481 * - ssl->out_msglen: length of the record content (excl headers)
2482 * - ssl->out_msg: record content
2483 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002484int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002485{
2486 int ret, done = 0;
2487 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002488 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002489
2490 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002493 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002495 {
2496 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002499 return( ret );
2500 }
2501
2502 len = ssl->out_msglen;
2503 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002505
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2507 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002508 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 ret = mbedtls_ssl_hw_record_write( ssl );
2512 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002513 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2515 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002516 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002517
2518 if( ret == 0 )
2519 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002520 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002522 if( !done )
2523 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002524 unsigned i;
2525 size_t protected_record_size;
2526
Hanno Becker6430faf2019-05-08 11:57:13 +01002527 /* Skip writing the record content type to after the encryption,
2528 * as it may change when using the CID extension. */
2529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002531 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002532
Hanno Becker19859472018-08-06 09:40:20 +01002533 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002534 ssl->out_len[0] = (unsigned char)( len >> 8 );
2535 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002536
Paul Bakker48916f92012-09-16 19:57:18 +00002537 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002538 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002539 mbedtls_record rec;
2540
2541 rec.buf = ssl->out_iv;
2542 rec.buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN -
2543 ( ssl->out_iv - ssl->out_buf );
2544 rec.data_len = ssl->out_msglen;
2545 rec.data_offset = ssl->out_msg - rec.buf;
2546
2547 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2548 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2549 ssl->conf->transport, rec.ver );
2550 rec.type = ssl->out_msgtype;
2551
Hanno Beckera0e20d02019-05-15 14:03:01 +01002552#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002553 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002554 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002555#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002556
Hanno Beckera18d1322018-01-03 14:27:32 +00002557 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002558 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002559 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002561 return( ret );
2562 }
2563
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002564 if( rec.data_offset != 0 )
2565 {
2566 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2567 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2568 }
2569
Hanno Becker6430faf2019-05-08 11:57:13 +01002570 /* Update the record content type and CID. */
2571 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002572#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002573 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002574#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002575 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002576 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2577 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002578 }
2579
Hanno Becker5903de42019-05-03 14:46:38 +01002580 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002581
2582#if defined(MBEDTLS_SSL_PROTO_DTLS)
2583 /* In case of DTLS, double-check that we don't exceed
2584 * the remaining space in the datagram. */
2585 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2586 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002587 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002588 if( ret < 0 )
2589 return( ret );
2590
2591 if( protected_record_size > (size_t) ret )
2592 {
2593 /* Should never happen */
2594 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2595 }
2596 }
2597#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002598
Hanno Becker6430faf2019-05-08 11:57:13 +01002599 /* Now write the potentially updated record content type. */
2600 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002603 "version = [%d:%d], msglen = %d",
2604 ssl->out_hdr[0], ssl->out_hdr[1],
2605 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002608 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002609
2610 ssl->out_left += protected_record_size;
2611 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002612 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002613
Hanno Beckerdd772292020-02-05 10:38:31 +00002614 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002615 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2616 break;
2617
2618 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002619 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002620 {
2621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2622 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2623 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002624 }
2625
Hanno Becker67bc7c32018-08-06 11:33:50 +01002626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002627 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2628 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002629 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002630 size_t remaining;
2631 ret = ssl_get_remaining_payload_in_datagram( ssl );
2632 if( ret < 0 )
2633 {
2634 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2635 ret );
2636 return( ret );
2637 }
2638
2639 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002640 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002641 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002642 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002643 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002644 else
2645 {
Hanno Becker513815a2018-08-20 11:56:09 +01002646 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002647 }
2648 }
2649#endif /* MBEDTLS_SSL_PROTO_DTLS */
2650
2651 if( ( flush == SSL_FORCE_FLUSH ) &&
2652 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002653 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002655 return( ret );
2656 }
2657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002659
2660 return( 0 );
2661}
2662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002664
2665static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2666{
2667 if( ssl->in_msglen < ssl->in_hslen ||
2668 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2669 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2670 {
2671 return( 1 );
2672 }
2673 return( 0 );
2674}
Hanno Becker44650b72018-08-16 12:51:11 +01002675
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002676static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002677{
2678 return( ( ssl->in_msg[9] << 16 ) |
2679 ( ssl->in_msg[10] << 8 ) |
2680 ssl->in_msg[11] );
2681}
2682
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002683static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002684{
2685 return( ( ssl->in_msg[6] << 16 ) |
2686 ( ssl->in_msg[7] << 8 ) |
2687 ssl->in_msg[8] );
2688}
2689
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002690static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002691{
2692 uint32_t msg_len, frag_off, frag_len;
2693
2694 msg_len = ssl_get_hs_total_len( ssl );
2695 frag_off = ssl_get_hs_frag_off( ssl );
2696 frag_len = ssl_get_hs_frag_len( ssl );
2697
2698 if( frag_off > msg_len )
2699 return( -1 );
2700
2701 if( frag_len > msg_len - frag_off )
2702 return( -1 );
2703
2704 if( frag_len + 12 > ssl->in_msglen )
2705 return( -1 );
2706
2707 return( 0 );
2708}
2709
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002710/*
2711 * Mark bits in bitmask (used for DTLS HS reassembly)
2712 */
2713static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2714{
2715 unsigned int start_bits, end_bits;
2716
2717 start_bits = 8 - ( offset % 8 );
2718 if( start_bits != 8 )
2719 {
2720 size_t first_byte_idx = offset / 8;
2721
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002722 /* Special case */
2723 if( len <= start_bits )
2724 {
2725 for( ; len != 0; len-- )
2726 mask[first_byte_idx] |= 1 << ( start_bits - len );
2727
2728 /* Avoid potential issues with offset or len becoming invalid */
2729 return;
2730 }
2731
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002732 offset += start_bits; /* Now offset % 8 == 0 */
2733 len -= start_bits;
2734
2735 for( ; start_bits != 0; start_bits-- )
2736 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2737 }
2738
2739 end_bits = len % 8;
2740 if( end_bits != 0 )
2741 {
2742 size_t last_byte_idx = ( offset + len ) / 8;
2743
2744 len -= end_bits; /* Now len % 8 == 0 */
2745
2746 for( ; end_bits != 0; end_bits-- )
2747 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2748 }
2749
2750 memset( mask + offset / 8, 0xFF, len / 8 );
2751}
2752
2753/*
2754 * Check that bitmask is full
2755 */
2756static int ssl_bitmask_check( unsigned char *mask, size_t len )
2757{
2758 size_t i;
2759
2760 for( i = 0; i < len / 8; i++ )
2761 if( mask[i] != 0xFF )
2762 return( -1 );
2763
2764 for( i = 0; i < len % 8; i++ )
2765 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2766 return( -1 );
2767
2768 return( 0 );
2769}
2770
Hanno Becker56e205e2018-08-16 09:06:12 +01002771/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002772static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002773 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002774{
Hanno Becker56e205e2018-08-16 09:06:12 +01002775 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002776
Hanno Becker56e205e2018-08-16 09:06:12 +01002777 alloc_len = 12; /* Handshake header */
2778 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002779
Hanno Beckerd07df862018-08-16 09:14:58 +01002780 if( add_bitmap )
2781 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002782
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002783 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002784}
Hanno Becker56e205e2018-08-16 09:06:12 +01002785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002787
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002788static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002789{
2790 return( ( ssl->in_msg[1] << 16 ) |
2791 ( ssl->in_msg[2] << 8 ) |
2792 ssl->in_msg[3] );
2793}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002794
Simon Butcher99000142016-10-13 17:21:01 +01002795int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002796{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002800 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002802 }
2803
Hanno Becker12555c62018-08-16 12:47:53 +01002804 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002807 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002808 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002811 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002812 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002814 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002815
Hanno Becker44650b72018-08-16 12:51:11 +01002816 if( ssl_check_hs_header( ssl ) != 0 )
2817 {
2818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2819 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2820 }
2821
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002822 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002823 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2824 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2825 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2826 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002827 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002828 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2829 {
2830 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2831 recv_msg_seq,
2832 ssl->handshake->in_msg_seq ) );
2833 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2834 }
2835
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002836 /* Retransmit only on last message from previous flight, to avoid
2837 * too many retransmissions.
2838 * Besides, No sane server ever retransmits HelloVerifyRequest */
2839 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002841 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002843 "message_seq = %d, start_of_flight = %d",
2844 recv_msg_seq,
2845 ssl->handshake->in_flight_start_seq ) );
2846
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002847 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002848 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002850 return( ret );
2851 }
2852 }
2853 else
2854 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002856 "message_seq = %d, expected = %d",
2857 recv_msg_seq,
2858 ssl->handshake->in_msg_seq ) );
2859 }
2860
Hanno Becker90333da2017-10-10 11:27:13 +01002861 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002862 }
2863 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002864
Hanno Becker6d97ef52018-08-16 13:09:04 +01002865 /* Message reassembly is handled alongside buffering of future
2866 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002867 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002868 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002869 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002870 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002872 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002873 }
2874 }
2875 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002877 /* With TLS we don't handle fragmentation (for now) */
2878 if( ssl->in_msglen < ssl->in_hslen )
2879 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2881 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002882 }
2883
Simon Butcher99000142016-10-13 17:21:01 +01002884 return( 0 );
2885}
2886
2887void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2888{
Hanno Becker0271f962018-08-16 13:23:47 +01002889 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002890
Hanno Becker0271f962018-08-16 13:23:47 +01002891 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002892 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002893 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002894 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002895
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002896 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002898 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002899 ssl->handshake != NULL )
2900 {
Hanno Becker0271f962018-08-16 13:23:47 +01002901 unsigned offset;
2902 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002903
Hanno Becker0271f962018-08-16 13:23:47 +01002904 /* Increment handshake sequence number */
2905 hs->in_msg_seq++;
2906
2907 /*
2908 * Clear up handshake buffering and reassembly structure.
2909 */
2910
2911 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002912 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002913
2914 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002915 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2916 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002917 offset++, hs_buf++ )
2918 {
2919 *hs_buf = *(hs_buf + 1);
2920 }
2921
2922 /* Create a fresh last entry */
2923 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002924 }
2925#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002926}
2927
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002928/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002929 * DTLS anti-replay: RFC 6347 4.1.2.6
2930 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002931 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2932 * Bit n is set iff record number in_window_top - n has been seen.
2933 *
2934 * Usually, in_window_top is the last record number seen and the lsb of
2935 * in_window is set. The only exception is the initial state (record number 0
2936 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002939void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002940{
2941 ssl->in_window_top = 0;
2942 ssl->in_window = 0;
2943}
2944
2945static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2946{
2947 return( ( (uint64_t) buf[0] << 40 ) |
2948 ( (uint64_t) buf[1] << 32 ) |
2949 ( (uint64_t) buf[2] << 24 ) |
2950 ( (uint64_t) buf[3] << 16 ) |
2951 ( (uint64_t) buf[4] << 8 ) |
2952 ( (uint64_t) buf[5] ) );
2953}
2954
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002955static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2956{
Janos Follath865b3eb2019-12-16 11:46:15 +00002957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002958 unsigned char *original_in_ctr;
2959
2960 // save original in_ctr
2961 original_in_ctr = ssl->in_ctr;
2962
2963 // use counter from record
2964 ssl->in_ctr = record_in_ctr;
2965
2966 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
2967
2968 // restore the counter
2969 ssl->in_ctr = original_in_ctr;
2970
2971 return ret;
2972}
2973
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002974/*
2975 * Return 0 if sequence number is acceptable, -1 otherwise
2976 */
Hanno Becker0183d692019-07-12 08:50:37 +01002977int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002978{
2979 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
2980 uint64_t bit;
2981
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002982 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002983 return( 0 );
2984
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002985 if( rec_seqnum > ssl->in_window_top )
2986 return( 0 );
2987
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002988 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002989
2990 if( bit >= 64 )
2991 return( -1 );
2992
2993 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
2994 return( -1 );
2995
2996 return( 0 );
2997}
2998
2999/*
3000 * Update replay window on new validated record
3001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003003{
3004 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3005
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003006 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003007 return;
3008
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003009 if( rec_seqnum > ssl->in_window_top )
3010 {
3011 /* Update window_top and the contents of the window */
3012 uint64_t shift = rec_seqnum - ssl->in_window_top;
3013
3014 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003015 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003016 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003017 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003018 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003019 ssl->in_window |= 1;
3020 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003021
3022 ssl->in_window_top = rec_seqnum;
3023 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003024 else
3025 {
3026 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003027 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003028
3029 if( bit < 64 ) /* Always true, but be extra sure */
3030 ssl->in_window |= (uint64_t) 1 << bit;
3031 }
3032}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003034
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003035#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003036/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003037 * Without any SSL context, check if a datagram looks like a ClientHello with
3038 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003039 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003040 *
3041 * - if cookie is valid, return 0
3042 * - if ClientHello looks superficially valid but cookie is not,
3043 * fill obuf and set olen, then
3044 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3045 * - otherwise return a specific error code
3046 */
3047static int ssl_check_dtls_clihlo_cookie(
3048 mbedtls_ssl_cookie_write_t *f_cookie_write,
3049 mbedtls_ssl_cookie_check_t *f_cookie_check,
3050 void *p_cookie,
3051 const unsigned char *cli_id, size_t cli_id_len,
3052 const unsigned char *in, size_t in_len,
3053 unsigned char *obuf, size_t buf_len, size_t *olen )
3054{
3055 size_t sid_len, cookie_len;
3056 unsigned char *p;
3057
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003058 /*
3059 * Structure of ClientHello with record and handshake headers,
3060 * and expected values. We don't need to check a lot, more checks will be
3061 * done when actually parsing the ClientHello - skipping those checks
3062 * avoids code duplication and does not make cookie forging any easier.
3063 *
3064 * 0-0 ContentType type; copied, must be handshake
3065 * 1-2 ProtocolVersion version; copied
3066 * 3-4 uint16 epoch; copied, must be 0
3067 * 5-10 uint48 sequence_number; copied
3068 * 11-12 uint16 length; (ignored)
3069 *
3070 * 13-13 HandshakeType msg_type; (ignored)
3071 * 14-16 uint24 length; (ignored)
3072 * 17-18 uint16 message_seq; copied
3073 * 19-21 uint24 fragment_offset; copied, must be 0
3074 * 22-24 uint24 fragment_length; (ignored)
3075 *
3076 * 25-26 ProtocolVersion client_version; (ignored)
3077 * 27-58 Random random; (ignored)
3078 * 59-xx SessionID session_id; 1 byte len + sid_len content
3079 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3080 * ...
3081 *
3082 * Minimum length is 61 bytes.
3083 */
3084 if( in_len < 61 ||
3085 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3086 in[3] != 0 || in[4] != 0 ||
3087 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3088 {
3089 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3090 }
3091
3092 sid_len = in[59];
3093 if( sid_len > in_len - 61 )
3094 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3095
3096 cookie_len = in[60 + sid_len];
3097 if( cookie_len > in_len - 60 )
3098 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3099
3100 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3101 cli_id, cli_id_len ) == 0 )
3102 {
3103 /* Valid cookie */
3104 return( 0 );
3105 }
3106
3107 /*
3108 * If we get here, we've got an invalid cookie, let's prepare HVR.
3109 *
3110 * 0-0 ContentType type; copied
3111 * 1-2 ProtocolVersion version; copied
3112 * 3-4 uint16 epoch; copied
3113 * 5-10 uint48 sequence_number; copied
3114 * 11-12 uint16 length; olen - 13
3115 *
3116 * 13-13 HandshakeType msg_type; hello_verify_request
3117 * 14-16 uint24 length; olen - 25
3118 * 17-18 uint16 message_seq; copied
3119 * 19-21 uint24 fragment_offset; copied
3120 * 22-24 uint24 fragment_length; olen - 25
3121 *
3122 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3123 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3124 *
3125 * Minimum length is 28.
3126 */
3127 if( buf_len < 28 )
3128 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3129
3130 /* Copy most fields and adapt others */
3131 memcpy( obuf, in, 25 );
3132 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3133 obuf[25] = 0xfe;
3134 obuf[26] = 0xff;
3135
3136 /* Generate and write actual cookie */
3137 p = obuf + 28;
3138 if( f_cookie_write( p_cookie,
3139 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3140 {
3141 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3142 }
3143
3144 *olen = p - obuf;
3145
3146 /* Go back and fill length fields */
3147 obuf[27] = (unsigned char)( *olen - 28 );
3148
3149 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3150 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3151 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3152
3153 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3154 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3155
3156 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3157}
3158
3159/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003160 * Handle possible client reconnect with the same UDP quadruplet
3161 * (RFC 6347 Section 4.2.8).
3162 *
3163 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3164 * that looks like a ClientHello.
3165 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003166 * - if the input looks like a ClientHello without cookies,
3167 * send back HelloVerifyRequest, then
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003168 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003169 * - if the input looks like a ClientHello with a valid cookie,
3170 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003171 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003172 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003173 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003174 * mbedtls_ssl_read_record() will ignore the record if anything else than
Simon Butcherd0bf6a32015-09-11 17:34:49 +01003175 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT or 0 is returned, although this function
3176 * cannot not return 0.
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003177 */
3178static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3179{
Janos Follath865b3eb2019-12-16 11:46:15 +00003180 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003181 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003182
Hanno Becker2fddd372019-07-10 14:37:41 +01003183 if( ssl->conf->f_cookie_write == NULL ||
3184 ssl->conf->f_cookie_check == NULL )
3185 {
3186 /* If we can't use cookies to verify reachability of the peer,
3187 * drop the record. */
3188 return( 0 );
3189 }
3190
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003191 ret = ssl_check_dtls_clihlo_cookie(
3192 ssl->conf->f_cookie_write,
3193 ssl->conf->f_cookie_check,
3194 ssl->conf->p_cookie,
3195 ssl->cli_id, ssl->cli_id_len,
3196 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003197 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003198
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003199 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3200
3201 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003202 {
Brian J Murray1903fb32016-11-06 04:45:15 -08003203 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003204 * If the error is permanent we'll catch it later,
3205 * if it's not, then hopefully it'll work next time. */
3206 (void) ssl->f_send( ssl->p_bio, ssl->out_buf, len );
Hanno Becker2fddd372019-07-10 14:37:41 +01003207 ret = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003208 }
3209
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003210 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003211 {
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003212 /* Got a valid cookie, partially reset context */
Hanno Becker43aefe22020-02-05 10:44:56 +00003213 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003214 {
3215 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3216 return( ret );
3217 }
3218
3219 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003220 }
3221
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003222 return( ret );
3223}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003224#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003225
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003226static int ssl_check_record_type( uint8_t record_type )
3227{
3228 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3229 record_type != MBEDTLS_SSL_MSG_ALERT &&
3230 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3231 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3232 {
3233 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3234 }
3235
3236 return( 0 );
3237}
3238
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003239/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003240 * ContentType type;
3241 * ProtocolVersion version;
3242 * uint16 epoch; // DTLS only
3243 * uint48 sequence_number; // DTLS only
3244 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003245 *
3246 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003247 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003248 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3249 *
3250 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003251 * 1. proceed with the record if this function returns 0
3252 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3253 * 3. return CLIENT_RECONNECT if this function return that value
3254 * 4. drop the whole datagram if this function returns anything else.
3255 * Point 2 is needed when the peer is resending, and we have already received
3256 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003257 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003258static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003259 unsigned char *buf,
3260 size_t len,
3261 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003262{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003263 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003264
Hanno Beckere5e7e782019-07-11 12:29:35 +01003265 size_t const rec_hdr_type_offset = 0;
3266 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003267
Hanno Beckere5e7e782019-07-11 12:29:35 +01003268 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3269 rec_hdr_type_len;
3270 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003271
Hanno Beckere5e7e782019-07-11 12:29:35 +01003272 size_t const rec_hdr_ctr_len = 8;
3273#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003274 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003275 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3276 rec_hdr_version_len;
3277
Hanno Beckera0e20d02019-05-15 14:03:01 +01003278#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003279 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3280 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003281 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003282#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3283#endif /* MBEDTLS_SSL_PROTO_DTLS */
3284
3285 size_t rec_hdr_len_offset; /* To be determined */
3286 size_t const rec_hdr_len_len = 2;
3287
3288 /*
3289 * Check minimum lengths for record header.
3290 */
3291
3292#if defined(MBEDTLS_SSL_PROTO_DTLS)
3293 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3294 {
3295 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3296 }
3297 else
3298#endif /* MBEDTLS_SSL_PROTO_DTLS */
3299 {
3300 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3301 }
3302
3303 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3304 {
3305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3306 (unsigned) len,
3307 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3308 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3309 }
3310
3311 /*
3312 * Parse and validate record content type
3313 */
3314
3315 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003316
3317 /* Check record content type */
3318#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3319 rec->cid_len = 0;
3320
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003321 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003322 ssl->conf->cid_len != 0 &&
3323 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003324 {
3325 /* Shift pointers to account for record header including CID
3326 * struct {
3327 * ContentType special_type = tls12_cid;
3328 * ProtocolVersion version;
3329 * uint16 epoch;
3330 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003331 * opaque cid[cid_length]; // Additional field compared to
3332 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003333 * uint16 length;
3334 * opaque enc_content[DTLSCiphertext.length];
3335 * } DTLSCiphertext;
3336 */
3337
3338 /* So far, we only support static CID lengths
3339 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003340 rec_hdr_cid_len = ssl->conf->cid_len;
3341 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003342
Hanno Beckere5e7e782019-07-11 12:29:35 +01003343 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003344 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3346 (unsigned) len,
3347 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003348 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003349 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003350
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003351 /* configured CID len is guaranteed at most 255, see
3352 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3353 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003354 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003355 }
3356 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003357#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003358 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003359 if( ssl_check_record_type( rec->type ) )
3360 {
Hanno Becker54229812019-07-12 14:40:00 +01003361 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3362 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003363 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3364 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003365 }
3366
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367 /*
3368 * Parse and validate record version
3369 */
3370
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003371 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3372 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003373 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3374 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003375 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003376
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003377 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3380 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003381 }
3382
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003383 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003384 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3386 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003387 }
3388
Hanno Beckere5e7e782019-07-11 12:29:35 +01003389 /*
3390 * Parse/Copy record sequence number.
3391 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003392
Hanno Beckere5e7e782019-07-11 12:29:35 +01003393#if defined(MBEDTLS_SSL_PROTO_DTLS)
3394 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003395 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003396 /* Copy explicit record sequence number from input buffer. */
3397 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3398 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003399 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003400 else
3401#endif /* MBEDTLS_SSL_PROTO_DTLS */
3402 {
3403 /* Copy implicit record sequence number from SSL context structure. */
3404 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3405 }
Paul Bakker40e46942009-01-03 21:51:57 +00003406
Hanno Beckere5e7e782019-07-11 12:29:35 +01003407 /*
3408 * Parse record length.
3409 */
3410
Hanno Beckere5e7e782019-07-11 12:29:35 +01003411 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003412 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3413 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003414 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003415
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003416 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003417 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003418 rec->type,
3419 major_ver, minor_ver, rec->data_len ) );
3420
3421 rec->buf = buf;
3422 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003423
Hanno Beckerd417cc92019-07-26 08:20:27 +01003424 if( rec->data_len == 0 )
3425 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003426
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003427 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003428 * DTLS-related tests.
3429 * Check epoch before checking length constraint because
3430 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3431 * message gets duplicated before the corresponding Finished message,
3432 * the second ChangeCipherSpec should be discarded because it belongs
3433 * to an old epoch, but not because its length is shorter than
3434 * the minimum record length for packets using the new record transform.
3435 * Note that these two kinds of failures are handled differently,
3436 * as an unexpected record is silently skipped but an invalid
3437 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003438 */
3439#if defined(MBEDTLS_SSL_PROTO_DTLS)
3440 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3441 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003442 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003443
Hanno Becker955a5c92019-07-10 17:12:07 +01003444 /* Check that the datagram is large enough to contain a record
3445 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003446 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003447 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003448 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3449 (unsigned) len,
3450 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003451 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3452 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003453
Hanno Becker37cfe732019-07-10 17:20:01 +01003454 /* Records from other, non-matching epochs are silently discarded.
3455 * (The case of same-port Client reconnects must be considered in
3456 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003457 if( rec_epoch != ssl->in_epoch )
3458 {
3459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3460 "expected %d, received %d",
3461 ssl->in_epoch, rec_epoch ) );
3462
Hanno Becker552f7472019-07-19 10:59:12 +01003463 /* Records from the next epoch are considered for buffering
3464 * (concretely: early Finished messages). */
3465 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003466 {
Hanno Becker552f7472019-07-19 10:59:12 +01003467 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3468 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003469 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003470
Hanno Becker2fddd372019-07-10 14:37:41 +01003471 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003472 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003473#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003474 /* For records from the correct epoch, check whether their
3475 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003476 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3477 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003478 {
3479 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3480 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3481 }
3482#endif
3483 }
3484#endif /* MBEDTLS_SSL_PROTO_DTLS */
3485
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003486 return( 0 );
3487}
Paul Bakker5121ce52009-01-03 21:22:43 +00003488
Paul Bakker5121ce52009-01-03 21:22:43 +00003489
Hanno Becker2fddd372019-07-10 14:37:41 +01003490#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3491static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3492{
3493 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3494
3495 /*
3496 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3497 * access the first byte of record content (handshake type), as we
3498 * have an active transform (possibly iv_len != 0), so use the
3499 * fact that the record header len is 13 instead.
3500 */
3501 if( rec_epoch == 0 &&
3502 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3503 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3504 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3505 ssl->in_left > 13 &&
3506 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3507 {
3508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3509 "from the same port" ) );
3510 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003511 }
3512
3513 return( 0 );
3514}
Hanno Becker2fddd372019-07-10 14:37:41 +01003515#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003516
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003517/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003518 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003519 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003520static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3521 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003522{
3523 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003525 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003526 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003528#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3529 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003530 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533 ret = mbedtls_ssl_hw_record_read( ssl );
3534 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3537 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003538 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003539
3540 if( ret == 0 )
3541 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003542 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003544 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003545 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003546 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003547
Hanno Beckera18d1322018-01-03 14:27:32 +00003548 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003549 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003550 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003552
Hanno Beckera0e20d02019-05-15 14:03:01 +01003553#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003554 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3555 ssl->conf->ignore_unexpected_cid
3556 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3557 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003558 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003559 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003560 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003561#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003562
Paul Bakker5121ce52009-01-03 21:22:43 +00003563 return( ret );
3564 }
3565
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003566 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003567 {
3568 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003569 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003570 }
3571
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003572 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003573 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003574
Hanno Beckera0e20d02019-05-15 14:03:01 +01003575#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003576 /* We have already checked the record content type
3577 * in ssl_parse_record_header(), failing or silently
3578 * dropping the record in the case of an unknown type.
3579 *
3580 * Since with the use of CIDs, the record content type
3581 * might change during decryption, re-check the record
3582 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003583 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003584 {
3585 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3586 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3587 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003588#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003589
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003590 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003591 {
3592#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3593 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003594 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003595 {
3596 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3598 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3599 }
3600#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3601
3602 ssl->nb_zero++;
3603
3604 /*
3605 * Three or more empty messages may be a DoS attack
3606 * (excessive CPU consumption).
3607 */
3608 if( ssl->nb_zero > 3 )
3609 {
3610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003611 "messages, possible DoS attack" ) );
3612 /* Treat the records as if they were not properly authenticated,
3613 * thereby failing the connection if we see more than allowed
3614 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003615 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3616 }
3617 }
3618 else
3619 ssl->nb_zero = 0;
3620
3621#if defined(MBEDTLS_SSL_PROTO_DTLS)
3622 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3623 {
3624 ; /* in_ctr read from peer, not maintained internally */
3625 }
3626 else
3627#endif
3628 {
3629 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003630 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003631 if( ++ssl->in_ctr[i - 1] != 0 )
3632 break;
3633
3634 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003635 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003636 {
3637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3638 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3639 }
3640 }
3641
Paul Bakker5121ce52009-01-03 21:22:43 +00003642 }
3643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003645 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003648 }
3649#endif
3650
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003651 /* Check actual (decrypted) record content length against
3652 * configured maximum. */
3653 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3654 {
3655 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3656 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3657 }
3658
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003659 return( 0 );
3660}
3661
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003662/*
3663 * Read a record.
3664 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003665 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3666 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3667 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003668 */
Hanno Becker1097b342018-08-15 14:09:41 +01003669
3670/* Helper functions for mbedtls_ssl_read_record(). */
3671static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003672static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3673static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003674
Hanno Becker327c93b2018-08-15 13:56:18 +01003675int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003676 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003677{
Janos Follath865b3eb2019-12-16 11:46:15 +00003678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003681
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003682 if( ssl->keep_current_message == 0 )
3683 {
3684 do {
Simon Butcher99000142016-10-13 17:21:01 +01003685
Hanno Becker26994592018-08-15 14:14:59 +01003686 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003687 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003688 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003689
Hanno Beckere74d5562018-08-15 14:26:08 +01003690 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003691 {
Hanno Becker40f50842018-08-15 14:48:01 +01003692#if defined(MBEDTLS_SSL_PROTO_DTLS)
3693 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003694
Hanno Becker40f50842018-08-15 14:48:01 +01003695 /* We only check for buffered messages if the
3696 * current datagram is fully consumed. */
3697 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003698 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003699 {
Hanno Becker40f50842018-08-15 14:48:01 +01003700 if( ssl_load_buffered_message( ssl ) == 0 )
3701 have_buffered = 1;
3702 }
3703
3704 if( have_buffered == 0 )
3705#endif /* MBEDTLS_SSL_PROTO_DTLS */
3706 {
3707 ret = ssl_get_next_record( ssl );
3708 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3709 continue;
3710
3711 if( ret != 0 )
3712 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003713 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003714 return( ret );
3715 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003716 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003717 }
3718
3719 ret = mbedtls_ssl_handle_message_type( ssl );
3720
Hanno Becker40f50842018-08-15 14:48:01 +01003721#if defined(MBEDTLS_SSL_PROTO_DTLS)
3722 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3723 {
3724 /* Buffer future message */
3725 ret = ssl_buffer_message( ssl );
3726 if( ret != 0 )
3727 return( ret );
3728
3729 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3730 }
3731#endif /* MBEDTLS_SSL_PROTO_DTLS */
3732
Hanno Becker90333da2017-10-10 11:27:13 +01003733 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3734 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003735
3736 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003737 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003738 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003739 return( ret );
3740 }
3741
Hanno Becker327c93b2018-08-15 13:56:18 +01003742 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003743 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003744 {
3745 mbedtls_ssl_update_handshake_status( ssl );
3746 }
Simon Butcher99000142016-10-13 17:21:01 +01003747 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003748 else
Simon Butcher99000142016-10-13 17:21:01 +01003749 {
Hanno Becker02f59072018-08-15 14:00:24 +01003750 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003751 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003752 }
3753
3754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3755
3756 return( 0 );
3757}
3758
Hanno Becker40f50842018-08-15 14:48:01 +01003759#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003760static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003761{
Hanno Becker40f50842018-08-15 14:48:01 +01003762 if( ssl->in_left > ssl->next_record_offset )
3763 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003764
Hanno Becker40f50842018-08-15 14:48:01 +01003765 return( 0 );
3766}
3767
3768static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3769{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003770 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003771 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003772 int ret = 0;
3773
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003774 if( hs == NULL )
3775 return( -1 );
3776
Hanno Beckere00ae372018-08-20 09:39:42 +01003777 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3778
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003779 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3780 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3781 {
3782 /* Check if we have seen a ChangeCipherSpec before.
3783 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003784 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003785 {
3786 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3787 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003788 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003789 }
3790
Hanno Becker39b8bc92018-08-28 17:17:13 +01003791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003792 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3793 ssl->in_msglen = 1;
3794 ssl->in_msg[0] = 1;
3795
3796 /* As long as they are equal, the exact value doesn't matter. */
3797 ssl->in_left = 0;
3798 ssl->next_record_offset = 0;
3799
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003800 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003801 goto exit;
3802 }
Hanno Becker37f95322018-08-16 13:55:32 +01003803
Hanno Beckerb8f50142018-08-28 10:01:34 +01003804#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003805 /* Debug only */
3806 {
3807 unsigned offset;
3808 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3809 {
3810 hs_buf = &hs->buffering.hs[offset];
3811 if( hs_buf->is_valid == 1 )
3812 {
3813 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3814 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003815 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003816 }
3817 }
3818 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003819#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003820
3821 /* Check if we have buffered and/or fully reassembled the
3822 * next handshake message. */
3823 hs_buf = &hs->buffering.hs[0];
3824 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3825 {
3826 /* Synthesize a record containing the buffered HS message. */
3827 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3828 ( hs_buf->data[2] << 8 ) |
3829 hs_buf->data[3];
3830
3831 /* Double-check that we haven't accidentally buffered
3832 * a message that doesn't fit into the input buffer. */
3833 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3834 {
3835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3836 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3837 }
3838
3839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3840 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3841 hs_buf->data, msg_len + 12 );
3842
3843 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3844 ssl->in_hslen = msg_len + 12;
3845 ssl->in_msglen = msg_len + 12;
3846 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3847
3848 ret = 0;
3849 goto exit;
3850 }
3851 else
3852 {
3853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3854 hs->in_msg_seq ) );
3855 }
3856
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003857 ret = -1;
3858
3859exit:
3860
3861 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3862 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003863}
3864
Hanno Beckera02b0b42018-08-21 17:20:27 +01003865static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3866 size_t desired )
3867{
3868 int offset;
3869 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003870 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3871 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003872
Hanno Becker01315ea2018-08-21 17:22:17 +01003873 /* Get rid of future records epoch first, if such exist. */
3874 ssl_free_buffered_record( ssl );
3875
3876 /* Check if we have enough space available now. */
3877 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3878 hs->buffering.total_bytes_buffered ) )
3879 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003881 return( 0 );
3882 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003883
Hanno Becker4f432ad2018-08-28 10:02:32 +01003884 /* We don't have enough space to buffer the next expected handshake
3885 * message. Remove buffers used for future messages to gain space,
3886 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003887 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3888 offset >= 0; offset-- )
3889 {
3890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3891 offset ) );
3892
Hanno Beckerb309b922018-08-23 13:18:05 +01003893 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003894
3895 /* Check if we have enough space available now. */
3896 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3897 hs->buffering.total_bytes_buffered ) )
3898 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003900 return( 0 );
3901 }
3902 }
3903
3904 return( -1 );
3905}
3906
Hanno Becker40f50842018-08-15 14:48:01 +01003907static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3908{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003909 int ret = 0;
3910 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3911
3912 if( hs == NULL )
3913 return( 0 );
3914
3915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3916
3917 switch( ssl->in_msgtype )
3918 {
3919 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3920 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003921
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003922 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003923 break;
3924
3925 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003926 {
3927 unsigned recv_msg_seq_offset;
3928 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3929 mbedtls_ssl_hs_buffer *hs_buf;
3930 size_t msg_len = ssl->in_hslen - 12;
3931
3932 /* We should never receive an old handshake
3933 * message - double-check nonetheless. */
3934 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3935 {
3936 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3937 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3938 }
3939
3940 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3941 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3942 {
3943 /* Silently ignore -- message too far in the future */
3944 MBEDTLS_SSL_DEBUG_MSG( 2,
3945 ( "Ignore future HS message with sequence number %u, "
3946 "buffering window %u - %u",
3947 recv_msg_seq, ssl->handshake->in_msg_seq,
3948 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3949
3950 goto exit;
3951 }
3952
3953 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3954 recv_msg_seq, recv_msg_seq_offset ) );
3955
3956 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
3957
3958 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003959 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01003960 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003961 size_t reassembly_buf_sz;
3962
Hanno Becker37f95322018-08-16 13:55:32 +01003963 hs_buf->is_fragmented =
3964 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
3965
3966 /* We copy the message back into the input buffer
3967 * after reassembly, so check that it's not too large.
3968 * This is an implementation-specific limitation
3969 * and not one from the standard, hence it is not
3970 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01003971 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01003972 {
3973 /* Ignore message */
3974 goto exit;
3975 }
3976
Hanno Beckere0b150f2018-08-21 15:51:03 +01003977 /* Check if we have enough space to buffer the message. */
3978 if( hs->buffering.total_bytes_buffered >
3979 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
3980 {
3981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3983 }
3984
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003985 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
3986 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01003987
3988 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3989 hs->buffering.total_bytes_buffered ) )
3990 {
3991 if( recv_msg_seq_offset > 0 )
3992 {
3993 /* If we can't buffer a future message because
3994 * of space limitations -- ignore. */
3995 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",
3996 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
3997 (unsigned) hs->buffering.total_bytes_buffered ) );
3998 goto exit;
3999 }
Hanno Beckere1801392018-08-21 16:51:05 +01004000 else
4001 {
4002 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",
4003 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4004 (unsigned) hs->buffering.total_bytes_buffered ) );
4005 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004006
Hanno Beckera02b0b42018-08-21 17:20:27 +01004007 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004008 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004009 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",
4010 (unsigned) msg_len,
4011 (unsigned) reassembly_buf_sz,
4012 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004013 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004014 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4015 goto exit;
4016 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004017 }
4018
4019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4020 msg_len ) );
4021
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004022 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4023 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004024 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004025 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004026 goto exit;
4027 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004028 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004029
4030 /* Prepare final header: copy msg_type, length and message_seq,
4031 * then add standardised fragment_offset and fragment_length */
4032 memcpy( hs_buf->data, ssl->in_msg, 6 );
4033 memset( hs_buf->data + 6, 0, 3 );
4034 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4035
4036 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037
4038 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004039 }
4040 else
4041 {
4042 /* Make sure msg_type and length are consistent */
4043 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4044 {
4045 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4046 /* Ignore */
4047 goto exit;
4048 }
4049 }
4050
Hanno Becker4422bbb2018-08-20 09:40:19 +01004051 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004052 {
4053 size_t frag_len, frag_off;
4054 unsigned char * const msg = hs_buf->data + 12;
4055
4056 /*
4057 * Check and copy current fragment
4058 */
4059
4060 /* Validation of header fields already done in
4061 * mbedtls_ssl_prepare_handshake_record(). */
4062 frag_off = ssl_get_hs_frag_off( ssl );
4063 frag_len = ssl_get_hs_frag_len( ssl );
4064
4065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4066 frag_off, frag_len ) );
4067 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4068
4069 if( hs_buf->is_fragmented )
4070 {
4071 unsigned char * const bitmask = msg + msg_len;
4072 ssl_bitmask_set( bitmask, frag_off, frag_len );
4073 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4074 msg_len ) == 0 );
4075 }
4076 else
4077 {
4078 hs_buf->is_complete = 1;
4079 }
4080
4081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4082 hs_buf->is_complete ? "" : "not yet " ) );
4083 }
4084
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004085 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004086 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004087
4088 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004089 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004090 break;
4091 }
4092
4093exit:
4094
4095 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4096 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004097}
4098#endif /* MBEDTLS_SSL_PROTO_DTLS */
4099
Hanno Becker1097b342018-08-15 14:09:41 +01004100static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004101{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004102 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004103 * Consume last content-layer message and potentially
4104 * update in_msglen which keeps track of the contents'
4105 * consumption state.
4106 *
4107 * (1) Handshake messages:
4108 * Remove last handshake message, move content
4109 * and adapt in_msglen.
4110 *
4111 * (2) Alert messages:
4112 * Consume whole record content, in_msglen = 0.
4113 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004114 * (3) Change cipher spec:
4115 * Consume whole record content, in_msglen = 0.
4116 *
4117 * (4) Application data:
4118 * Don't do anything - the record layer provides
4119 * the application data as a stream transport
4120 * and consumes through mbedtls_ssl_read only.
4121 *
4122 */
4123
4124 /* Case (1): Handshake messages */
4125 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004126 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004127 /* Hard assertion to be sure that no application data
4128 * is in flight, as corrupting ssl->in_msglen during
4129 * ssl->in_offt != NULL is fatal. */
4130 if( ssl->in_offt != NULL )
4131 {
4132 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4133 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4134 }
4135
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004136 /*
4137 * Get next Handshake message in the current record
4138 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004139
Hanno Becker4a810fb2017-05-24 16:27:30 +01004140 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004141 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004142 * current handshake content: If DTLS handshake
4143 * fragmentation is used, that's the fragment
4144 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004145 * size here is faulty and should be changed at
4146 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004147 * (2) While it doesn't seem to cause problems, one
4148 * has to be very careful not to assume that in_hslen
4149 * is always <= in_msglen in a sensible communication.
4150 * Again, it's wrong for DTLS handshake fragmentation.
4151 * The following check is therefore mandatory, and
4152 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004153 * Additionally, ssl->in_hslen might be arbitrarily out of
4154 * bounds after handling a DTLS message with an unexpected
4155 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004156 */
4157 if( ssl->in_hslen < ssl->in_msglen )
4158 {
4159 ssl->in_msglen -= ssl->in_hslen;
4160 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4161 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004162
Hanno Becker4a810fb2017-05-24 16:27:30 +01004163 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4164 ssl->in_msg, ssl->in_msglen );
4165 }
4166 else
4167 {
4168 ssl->in_msglen = 0;
4169 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004170
Hanno Becker4a810fb2017-05-24 16:27:30 +01004171 ssl->in_hslen = 0;
4172 }
4173 /* Case (4): Application data */
4174 else if( ssl->in_offt != NULL )
4175 {
4176 return( 0 );
4177 }
4178 /* Everything else (CCS & Alerts) */
4179 else
4180 {
4181 ssl->in_msglen = 0;
4182 }
4183
Hanno Becker1097b342018-08-15 14:09:41 +01004184 return( 0 );
4185}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004186
Hanno Beckere74d5562018-08-15 14:26:08 +01004187static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4188{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004189 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004190 return( 1 );
4191
4192 return( 0 );
4193}
4194
Hanno Becker5f066e72018-08-16 14:56:31 +01004195#if defined(MBEDTLS_SSL_PROTO_DTLS)
4196
4197static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4198{
4199 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4200 if( hs == NULL )
4201 return;
4202
Hanno Becker01315ea2018-08-21 17:22:17 +01004203 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004204 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004205 hs->buffering.total_bytes_buffered -=
4206 hs->buffering.future_record.len;
4207
4208 mbedtls_free( hs->buffering.future_record.data );
4209 hs->buffering.future_record.data = NULL;
4210 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004211}
4212
4213static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4214{
4215 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4216 unsigned char * rec;
4217 size_t rec_len;
4218 unsigned rec_epoch;
4219
4220 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4221 return( 0 );
4222
4223 if( hs == NULL )
4224 return( 0 );
4225
Hanno Becker5f066e72018-08-16 14:56:31 +01004226 rec = hs->buffering.future_record.data;
4227 rec_len = hs->buffering.future_record.len;
4228 rec_epoch = hs->buffering.future_record.epoch;
4229
4230 if( rec == NULL )
4231 return( 0 );
4232
Hanno Becker4cb782d2018-08-20 11:19:05 +01004233 /* Only consider loading future records if the
4234 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004235 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004236 return( 0 );
4237
Hanno Becker5f066e72018-08-16 14:56:31 +01004238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4239
4240 if( rec_epoch != ssl->in_epoch )
4241 {
4242 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4243 goto exit;
4244 }
4245
4246 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4247
4248 /* Double-check that the record is not too large */
4249 if( rec_len > MBEDTLS_SSL_IN_BUFFER_LEN -
4250 (size_t)( ssl->in_hdr - ssl->in_buf ) )
4251 {
4252 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4253 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4254 }
4255
4256 memcpy( ssl->in_hdr, rec, rec_len );
4257 ssl->in_left = rec_len;
4258 ssl->next_record_offset = 0;
4259
4260 ssl_free_buffered_record( ssl );
4261
4262exit:
4263 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4264 return( 0 );
4265}
4266
Hanno Becker519f15d2019-07-11 12:43:20 +01004267static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4268 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004269{
4270 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004271
4272 /* Don't buffer future records outside handshakes. */
4273 if( hs == NULL )
4274 return( 0 );
4275
4276 /* Only buffer handshake records (we are only interested
4277 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004278 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004279 return( 0 );
4280
4281 /* Don't buffer more than one future epoch record. */
4282 if( hs->buffering.future_record.data != NULL )
4283 return( 0 );
4284
Hanno Becker01315ea2018-08-21 17:22:17 +01004285 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004286 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004287 hs->buffering.total_bytes_buffered ) )
4288 {
4289 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 +01004290 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004291 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004292 return( 0 );
4293 }
4294
Hanno Becker5f066e72018-08-16 14:56:31 +01004295 /* Buffer record */
4296 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4297 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004298 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004299
4300 /* ssl_parse_record_header() only considers records
4301 * of the next epoch as candidates for buffering. */
4302 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004303 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004304
4305 hs->buffering.future_record.data =
4306 mbedtls_calloc( 1, hs->buffering.future_record.len );
4307 if( hs->buffering.future_record.data == NULL )
4308 {
4309 /* If we run out of RAM trying to buffer a
4310 * record from the next epoch, just ignore. */
4311 return( 0 );
4312 }
4313
Hanno Becker519f15d2019-07-11 12:43:20 +01004314 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004315
Hanno Becker519f15d2019-07-11 12:43:20 +01004316 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004317 return( 0 );
4318}
4319
4320#endif /* MBEDTLS_SSL_PROTO_DTLS */
4321
Hanno Beckere74d5562018-08-15 14:26:08 +01004322static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004323{
Janos Follath865b3eb2019-12-16 11:46:15 +00004324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004325 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004326
Hanno Becker5f066e72018-08-16 14:56:31 +01004327#if defined(MBEDTLS_SSL_PROTO_DTLS)
4328 /* We might have buffered a future record; if so,
4329 * and if the epoch matches now, load it.
4330 * On success, this call will set ssl->in_left to
4331 * the length of the buffered record, so that
4332 * the calls to ssl_fetch_input() below will
4333 * essentially be no-ops. */
4334 ret = ssl_load_buffered_record( ssl );
4335 if( ret != 0 )
4336 return( ret );
4337#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004338
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004339 /* Ensure that we have enough space available for the default form
4340 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4341 * with no space for CIDs counted in). */
4342 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4343 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004345 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004346 return( ret );
4347 }
4348
Hanno Beckere5e7e782019-07-11 12:29:35 +01004349 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4350 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004351 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004353 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004354 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004355 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4356 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004357 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004358 if( ret != 0 )
4359 return( ret );
4360
4361 /* Fall through to handling of unexpected records */
4362 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4363 }
4364
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004365 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4366 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004367#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004368 /* Reset in pointers to default state for TLS/DTLS records,
4369 * assuming no CID and no offset between record content and
4370 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004371 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004372
Hanno Becker7ae20e02019-07-12 08:33:49 +01004373 /* Setup internal message pointers from record structure. */
4374 ssl->in_msgtype = rec.type;
4375#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4376 ssl->in_len = ssl->in_cid + rec.cid_len;
4377#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4378 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4379 ssl->in_msglen = rec.data_len;
4380
Hanno Becker2fddd372019-07-10 14:37:41 +01004381 ret = ssl_check_client_reconnect( ssl );
4382 if( ret != 0 )
4383 return( ret );
4384#endif
4385
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004386 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004387 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004388
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4390 "(header)" ) );
4391 }
4392 else
4393 {
4394 /* Skip invalid record and the rest of the datagram */
4395 ssl->next_record_offset = 0;
4396 ssl->in_left = 0;
4397
4398 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4399 "(header)" ) );
4400 }
4401
4402 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004403 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004404 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004405 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004406#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004407 {
4408 return( ret );
4409 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004410 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004412#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004413 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004414 {
Hanno Beckera8814792019-07-10 15:01:45 +01004415 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004416 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004417 if( ssl->next_record_offset < ssl->in_left )
4418 {
4419 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4420 }
4421 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004422 else
4423#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004424 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004425 /*
4426 * Fetch record contents from underlying transport.
4427 */
Hanno Beckera3175662019-07-11 12:50:29 +01004428 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004429 if( ret != 0 )
4430 {
4431 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4432 return( ret );
4433 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004434
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004435 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004436 }
4437
4438 /*
4439 * Decrypt record contents.
4440 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004441
Hanno Beckerfdf66042019-07-11 13:07:45 +01004442 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004443 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004444#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004445 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004446 {
4447 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004448 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004449 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004450 /* Except when waiting for Finished as a bad mac here
4451 * probably means something went wrong in the handshake
4452 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4453 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4454 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4455 {
4456#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4457 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4458 {
4459 mbedtls_ssl_send_alert_message( ssl,
4460 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4461 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4462 }
4463#endif
4464 return( ret );
4465 }
4466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004467#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004468 if( ssl->conf->badmac_limit != 0 &&
4469 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4472 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004473 }
4474#endif
4475
Hanno Becker4a810fb2017-05-24 16:27:30 +01004476 /* As above, invalid records cause
4477 * dismissal of the whole datagram. */
4478
4479 ssl->next_record_offset = 0;
4480 ssl->in_left = 0;
4481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004483 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004484 }
4485
4486 return( ret );
4487 }
4488 else
4489#endif
4490 {
4491 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004492#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4493 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004494 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004495 mbedtls_ssl_send_alert_message( ssl,
4496 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4497 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004498 }
4499#endif
4500 return( ret );
4501 }
4502 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004503
Hanno Becker44d89b22019-07-12 09:40:44 +01004504
4505 /* Reset in pointers to default state for TLS/DTLS records,
4506 * assuming no CID and no offset between record content and
4507 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004508 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004509#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4510 ssl->in_len = ssl->in_cid + rec.cid_len;
4511#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004512 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004513
Hanno Becker8685c822019-07-12 09:37:30 +01004514 /* The record content type may change during decryption,
4515 * so re-read it. */
4516 ssl->in_msgtype = rec.type;
4517 /* Also update the input buffer, because unfortunately
4518 * the server-side ssl_parse_client_hello() reparses the
4519 * record header when receiving a ClientHello initiating
4520 * a renegotiation. */
4521 ssl->in_hdr[0] = rec.type;
4522 ssl->in_msg = rec.buf + rec.data_offset;
4523 ssl->in_msglen = rec.data_len;
4524 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4525 ssl->in_len[1] = (unsigned char)( rec.data_len );
4526
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004527#if defined(MBEDTLS_ZLIB_SUPPORT)
4528 if( ssl->transform_in != NULL &&
4529 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4530 {
4531 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4532 {
4533 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4534 return( ret );
4535 }
4536
4537 /* Check actual (decompress) record content length against
4538 * configured maximum. */
4539 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4540 {
4541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4542 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4543 }
4544 }
4545#endif /* MBEDTLS_ZLIB_SUPPORT */
4546
Simon Butcher99000142016-10-13 17:21:01 +01004547 return( 0 );
4548}
4549
4550int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4551{
Janos Follath865b3eb2019-12-16 11:46:15 +00004552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004553
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004554 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004555 * Handle particular types of records
4556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004558 {
Simon Butcher99000142016-10-13 17:21:01 +01004559 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4560 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004561 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004562 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004563 }
4564
Hanno Beckere678eaa2018-08-21 14:57:46 +01004565 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004566 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004567 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004568 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4570 ssl->in_msglen ) );
4571 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004572 }
4573
Hanno Beckere678eaa2018-08-21 14:57:46 +01004574 if( ssl->in_msg[0] != 1 )
4575 {
4576 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4577 ssl->in_msg[0] ) );
4578 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4579 }
4580
4581#if defined(MBEDTLS_SSL_PROTO_DTLS)
4582 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4583 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4584 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4585 {
4586 if( ssl->handshake == NULL )
4587 {
4588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4589 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4590 }
4591
4592 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4593 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4594 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004595#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004596 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004599 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004600 if( ssl->in_msglen != 2 )
4601 {
4602 /* Note: Standard allows for more than one 2 byte alert
4603 to be packed in a single message, but Mbed TLS doesn't
4604 currently support this. */
4605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4606 ssl->in_msglen ) );
4607 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4608 }
4609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004610 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004611 ssl->in_msg[0], ssl->in_msg[1] ) );
4612
4613 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004614 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004617 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004619 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004620 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004621 }
4622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004623 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4624 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004625 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4627 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004628 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004629
4630#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4631 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4632 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4633 {
Hanno Becker90333da2017-10-10 11:27:13 +01004634 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004635 /* Will be handled when trying to parse ServerHello */
4636 return( 0 );
4637 }
4638#endif
4639
4640#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4641 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4642 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4643 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4644 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4645 {
4646 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4647 /* Will be handled in mbedtls_ssl_parse_certificate() */
4648 return( 0 );
4649 }
4650#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4651
4652 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004653 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004654 }
4655
Hanno Beckerc76c6192017-06-06 10:03:17 +01004656#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004657 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004658 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004659 /* Drop unexpected ApplicationData records,
4660 * except at the beginning of renegotiations */
4661 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4662 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4663#if defined(MBEDTLS_SSL_RENEGOTIATION)
4664 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4665 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004666#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004667 )
4668 {
4669 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4670 return( MBEDTLS_ERR_SSL_NON_FATAL );
4671 }
4672
4673 if( ssl->handshake != NULL &&
4674 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4675 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004676 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004677 }
4678 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004679#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004680
Paul Bakker5121ce52009-01-03 21:22:43 +00004681 return( 0 );
4682}
4683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004685{
irwir6c0da642019-09-26 21:07:41 +03004686 return( mbedtls_ssl_send_alert_message( ssl,
4687 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4688 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004689}
4690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004692 unsigned char level,
4693 unsigned char message )
4694{
Janos Follath865b3eb2019-12-16 11:46:15 +00004695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004696
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004697 if( ssl == NULL || ssl->conf == NULL )
4698 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004700 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004701 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004703 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004704 ssl->out_msglen = 2;
4705 ssl->out_msg[0] = level;
4706 ssl->out_msg[1] = message;
4707
Hanno Becker67bc7c32018-08-06 11:33:50 +01004708 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004709 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004711 return( ret );
4712 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004714
4715 return( 0 );
4716}
4717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004719{
Janos Follath865b3eb2019-12-16 11:46:15 +00004720 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004722 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004724 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004725 ssl->out_msglen = 1;
4726 ssl->out_msg[0] = 1;
4727
Paul Bakker5121ce52009-01-03 21:22:43 +00004728 ssl->state++;
4729
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004730 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004731 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004732 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004733 return( ret );
4734 }
4735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004736 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004737
4738 return( 0 );
4739}
4740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004742{
Janos Follath865b3eb2019-12-16 11:46:15 +00004743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004746
Hanno Becker327c93b2018-08-15 13:56:18 +01004747 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004749 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004750 return( ret );
4751 }
4752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004753 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004754 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004755 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004756 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4757 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 }
4760
Hanno Beckere678eaa2018-08-21 14:57:46 +01004761 /* CCS records are only accepted if they have length 1 and content '1',
4762 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004763
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004764 /*
4765 * Switch to our negotiated transform and session parameters for inbound
4766 * data.
4767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004769 ssl->transform_in = ssl->transform_negotiate;
4770 ssl->session_in = ssl->session_negotiate;
4771
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004772#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004773 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004775#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004776 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004777#endif
4778
4779 /* Increment epoch */
4780 if( ++ssl->in_epoch == 0 )
4781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004783 /* This is highly unlikely to happen for legitimate reasons, so
4784 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004786 }
4787 }
4788 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004790 memset( ssl->in_ctr, 0, 8 );
4791
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004792 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4795 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004798 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004799 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004800 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4801 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004803 }
4804 }
4805#endif
4806
Paul Bakker5121ce52009-01-03 21:22:43 +00004807 ssl->state++;
4808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004810
4811 return( 0 );
4812}
4813
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004814/* Once ssl->out_hdr as the address of the beginning of the
4815 * next outgoing record is set, deduce the other pointers.
4816 *
4817 * Note: For TLS, we save the implicit record sequence number
4818 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4819 * and the caller has to make sure there's space for this.
4820 */
4821
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004822void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4823 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004824{
4825#if defined(MBEDTLS_SSL_PROTO_DTLS)
4826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4827 {
4828 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004829#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004830 ssl->out_cid = ssl->out_ctr + 8;
4831 ssl->out_len = ssl->out_cid;
4832 if( transform != NULL )
4833 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004834#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004835 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004836#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004837 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004838 }
4839 else
4840#endif
4841 {
4842 ssl->out_ctr = ssl->out_hdr - 8;
4843 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004844#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004845 ssl->out_cid = ssl->out_len;
4846#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004847 ssl->out_iv = ssl->out_hdr + 5;
4848 }
4849
4850 /* Adjust out_msg to make space for explicit IV, if used. */
4851 if( transform != NULL &&
4852 ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
4853 {
4854 ssl->out_msg = ssl->out_iv + transform->ivlen - transform->fixed_ivlen;
4855 }
4856 else
4857 ssl->out_msg = ssl->out_iv;
4858}
4859
4860/* Once ssl->in_hdr as the address of the beginning of the
4861 * next incoming record is set, deduce the other pointers.
4862 *
4863 * Note: For TLS, we save the implicit record sequence number
4864 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4865 * and the caller has to make sure there's space for this.
4866 */
4867
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004868void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004869{
Hanno Becker79594fd2019-05-08 09:38:41 +01004870 /* This function sets the pointers to match the case
4871 * of unprotected TLS/DTLS records, with both ssl->in_iv
4872 * and ssl->in_msg pointing to the beginning of the record
4873 * content.
4874 *
4875 * When decrypting a protected record, ssl->in_msg
4876 * will be shifted to point to the beginning of the
4877 * record plaintext.
4878 */
4879
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004880#if defined(MBEDTLS_SSL_PROTO_DTLS)
4881 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4882 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004883 /* This sets the header pointers to match records
4884 * without CID. When we receive a record containing
4885 * a CID, the fields are shifted accordingly in
4886 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004887 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004888#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004889 ssl->in_cid = ssl->in_ctr + 8;
4890 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004891#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004892 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004893#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004894 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004895 }
4896 else
4897#endif
4898 {
4899 ssl->in_ctr = ssl->in_hdr - 8;
4900 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004901#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004902 ssl->in_cid = ssl->in_len;
4903#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004904 ssl->in_iv = ssl->in_hdr + 5;
4905 }
4906
Hanno Becker79594fd2019-05-08 09:38:41 +01004907 /* This will be adjusted at record decryption time. */
4908 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004909}
4910
Paul Bakker5121ce52009-01-03 21:22:43 +00004911/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004912 * Setup an SSL context
4913 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004914
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004915void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004916{
4917 /* Set the incoming and outgoing record pointers. */
4918#if defined(MBEDTLS_SSL_PROTO_DTLS)
4919 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4920 {
4921 ssl->out_hdr = ssl->out_buf;
4922 ssl->in_hdr = ssl->in_buf;
4923 }
4924 else
4925#endif /* MBEDTLS_SSL_PROTO_DTLS */
4926 {
4927 ssl->out_hdr = ssl->out_buf + 8;
4928 ssl->in_hdr = ssl->in_buf + 8;
4929 }
4930
4931 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004932 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4933 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004934}
4935
Paul Bakker5121ce52009-01-03 21:22:43 +00004936/*
4937 * SSL get accessors
4938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004939size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004940{
4941 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4942}
4943
Hanno Becker8b170a02017-10-10 11:51:19 +01004944int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4945{
4946 /*
4947 * Case A: We're currently holding back
4948 * a message for further processing.
4949 */
4950
4951 if( ssl->keep_current_message == 1 )
4952 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004953 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004954 return( 1 );
4955 }
4956
4957 /*
4958 * Case B: Further records are pending in the current datagram.
4959 */
4960
4961#if defined(MBEDTLS_SSL_PROTO_DTLS)
4962 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4963 ssl->in_left > ssl->next_record_offset )
4964 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004965 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004966 return( 1 );
4967 }
4968#endif /* MBEDTLS_SSL_PROTO_DTLS */
4969
4970 /*
4971 * Case C: A handshake message is being processed.
4972 */
4973
Hanno Becker8b170a02017-10-10 11:51:19 +01004974 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
4975 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004976 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004977 return( 1 );
4978 }
4979
4980 /*
4981 * Case D: An application data message is being processed
4982 */
4983 if( ssl->in_offt != NULL )
4984 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01004985 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01004986 return( 1 );
4987 }
4988
4989 /*
4990 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01004991 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01004992 * we implement support for multiple alerts in single records.
4993 */
4994
4995 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
4996 return( 0 );
4997}
4998
Paul Bakker43ca69c2011-01-15 17:35:19 +00004999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005000int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005001{
Hanno Becker3136ede2018-08-17 15:28:19 +01005002 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005003 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005004 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005005
Hanno Becker5903de42019-05-03 14:46:38 +01005006 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5007
Hanno Becker78640902018-08-13 16:35:15 +01005008 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005009 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005011#if defined(MBEDTLS_ZLIB_SUPPORT)
5012 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5013 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005014#endif
5015
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005016 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005017 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018 case MBEDTLS_MODE_GCM:
5019 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005020 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005022 transform_expansion = transform->minlen;
5023 break;
5024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005025 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005026
5027 block_size = mbedtls_cipher_get_block_size(
5028 &transform->cipher_ctx_enc );
5029
Hanno Becker3136ede2018-08-17 15:28:19 +01005030 /* Expansion due to the addition of the MAC. */
5031 transform_expansion += transform->maclen;
5032
5033 /* Expansion due to the addition of CBC padding;
5034 * Theoretically up to 256 bytes, but we never use
5035 * more than the block size of the underlying cipher. */
5036 transform_expansion += block_size;
5037
5038 /* For TLS 1.1 or higher, an explicit IV is added
5039 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005040#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5041 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005042 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005043#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005044
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005045 break;
5046
5047 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005049 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005050 }
5051
Hanno Beckera0e20d02019-05-15 14:03:01 +01005052#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005053 if( transform->out_cid_len != 0 )
5054 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005055#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005056
Hanno Becker5903de42019-05-03 14:46:38 +01005057 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005058}
5059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005061/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005062 * Check record counters and renegotiate if they're above the limit.
5063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005064static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005065{
Hanno Beckerdd772292020-02-05 10:38:31 +00005066 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005067 int in_ctr_cmp;
5068 int out_ctr_cmp;
5069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5071 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005072 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005073 {
5074 return( 0 );
5075 }
5076
Andres AG2196c7f2016-12-15 17:01:16 +00005077 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5078 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005079 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005080 ssl->conf->renego_period + ep_len, 8 - ep_len );
5081
5082 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005083 {
5084 return( 0 );
5085 }
5086
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005089}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005090#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005091
5092/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005093 * Receive application data decrypted from the SSL layer
5094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005095int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005096{
Janos Follath865b3eb2019-12-16 11:46:15 +00005097 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005098 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005099
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005100 if( ssl == NULL || ssl->conf == NULL )
5101 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005104
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005108 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005109 return( ret );
5110
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005111 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005112 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005113 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005114 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005115 return( ret );
5116 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005117 }
5118#endif
5119
Hanno Becker4a810fb2017-05-24 16:27:30 +01005120 /*
5121 * Check if renegotiation is necessary and/or handshake is
5122 * in process. If yes, perform/continue, and fall through
5123 * if an unexpected packet is received while the client
5124 * is waiting for the ServerHello.
5125 *
5126 * (There is no equivalent to the last condition on
5127 * the server-side as it is not treated as within
5128 * a handshake while waiting for the ClientHello
5129 * after a renegotiation request.)
5130 */
5131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005133 ret = ssl_check_ctr_renegotiate( ssl );
5134 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5135 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005136 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005138 return( ret );
5139 }
5140#endif
5141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005142 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005143 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005144 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005145 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5146 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005147 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005148 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005149 return( ret );
5150 }
5151 }
5152
Hanno Beckere41158b2017-10-23 13:30:32 +01005153 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005154 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005155 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005156 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005157 if( ssl->f_get_timer != NULL &&
5158 ssl->f_get_timer( ssl->p_timer ) == -1 )
5159 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005160 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005161 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005162
Hanno Becker327c93b2018-08-15 13:56:18 +01005163 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005164 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005165 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5166 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005167
Hanno Becker4a810fb2017-05-24 16:27:30 +01005168 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5169 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005170 }
5171
5172 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005173 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005174 {
5175 /*
5176 * OpenSSL sends empty messages to randomize the IV
5177 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005178 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005180 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005181 return( 0 );
5182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005183 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005184 return( ret );
5185 }
5186 }
5187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005188 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005189 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005191
Hanno Becker4a810fb2017-05-24 16:27:30 +01005192 /*
5193 * - For client-side, expect SERVER_HELLO_REQUEST.
5194 * - For server-side, expect CLIENT_HELLO.
5195 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5196 */
5197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005198#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005199 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005200 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005201 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005202 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005203 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005204
5205 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005206#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005207 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005208 {
5209 continue;
5210 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005211#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005213 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005214#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005215
Hanno Becker4a810fb2017-05-24 16:27:30 +01005216#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005217 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005218 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005219 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005221
5222 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005223#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005224 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005225 {
5226 continue;
5227 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005228#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005230 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005231#endif /* MBEDTLS_SSL_SRV_C */
5232
Hanno Becker21df7f92017-10-17 11:03:26 +01005233#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005234 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005235 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5236 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5237 ssl->conf->allow_legacy_renegotiation ==
5238 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5239 {
5240 /*
5241 * Accept renegotiation request
5242 */
Paul Bakker48916f92012-09-16 19:57:18 +00005243
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005244 /* DTLS clients need to know renego is server-initiated */
5245#if defined(MBEDTLS_SSL_PROTO_DTLS)
5246 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5247 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5248 {
5249 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5250 }
5251#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005252 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005253 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5254 ret != 0 )
5255 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005256 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5257 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005258 return( ret );
5259 }
5260 }
5261 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005262#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005263 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005264 /*
5265 * Refuse renegotiation
5266 */
5267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005268 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005270#if defined(MBEDTLS_SSL_PROTO_SSL3)
5271 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005272 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005273 /* SSLv3 does not have a "no_renegotiation" warning, so
5274 we send a fatal alert and abort the connection. */
5275 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5276 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5277 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005278 }
5279 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005280#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5281#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5282 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5283 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005285 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5286 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5287 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005288 {
5289 return( ret );
5290 }
Paul Bakker48916f92012-09-16 19:57:18 +00005291 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005292 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5294 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005295 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005296 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5297 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005298 }
Paul Bakker48916f92012-09-16 19:57:18 +00005299 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005300
Hanno Becker90333da2017-10-10 11:27:13 +01005301 /* At this point, we don't know whether the renegotiation has been
5302 * completed or not. The cases to consider are the following:
5303 * 1) The renegotiation is complete. In this case, no new record
5304 * has been read yet.
5305 * 2) The renegotiation is incomplete because the client received
5306 * an application data record while awaiting the ServerHello.
5307 * 3) The renegotiation is incomplete because the client received
5308 * a non-handshake, non-application data message while awaiting
5309 * the ServerHello.
5310 * In each of these case, looping will be the proper action:
5311 * - For 1), the next iteration will read a new record and check
5312 * if it's application data.
5313 * - For 2), the loop condition isn't satisfied as application data
5314 * is present, hence continue is the same as break
5315 * - For 3), the loop condition is satisfied and read_record
5316 * will re-deliver the message that was held back by the client
5317 * when expecting the ServerHello.
5318 */
5319 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005320 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005321#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005322 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005323 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005324 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005325 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005326 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005327 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005328 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005329 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005331 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005332 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005333 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005336 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5337 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005338 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005340 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005341 }
5342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005343 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5346 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005347 }
5348
5349 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005350
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005351 /* We're going to return something now, cancel timer,
5352 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005353 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005354 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005355
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005356#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005357 /* If we requested renego but received AppData, resend HelloRequest.
5358 * Do it now, after setting in_offt, to avoid taking this branch
5359 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005361 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005362 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005363 {
Hanno Becker786300f2020-02-05 10:46:40 +00005364 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005365 {
Hanno Becker786300f2020-02-05 10:46:40 +00005366 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5367 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005368 return( ret );
5369 }
5370 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005372#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005373 }
5374
5375 n = ( len < ssl->in_msglen )
5376 ? len : ssl->in_msglen;
5377
5378 memcpy( buf, ssl->in_offt, n );
5379 ssl->in_msglen -= n;
5380
5381 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005382 {
5383 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005384 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005385 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005386 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005387 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005388 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005389 /* more data available */
5390 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005394
Paul Bakker23986e52011-04-24 08:57:21 +00005395 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005396}
5397
5398/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005399 * Send application data to be encrypted by the SSL layer, taking care of max
5400 * fragment length and buffer size.
5401 *
5402 * According to RFC 5246 Section 6.2.1:
5403 *
5404 * Zero-length fragments of Application data MAY be sent as they are
5405 * potentially useful as a traffic analysis countermeasure.
5406 *
5407 * Therefore, it is possible that the input message length is 0 and the
5408 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005409 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005410static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005411 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005412{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005413 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5414 const size_t max_len = (size_t) ret;
5415
5416 if( ret < 0 )
5417 {
5418 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5419 return( ret );
5420 }
5421
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005422 if( len > max_len )
5423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005425 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005426 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005428 "maximum fragment length: %d > %d",
5429 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005431 }
5432 else
5433#endif
5434 len = max_len;
5435 }
Paul Bakker887bd502011-06-08 13:10:54 +00005436
Paul Bakker5121ce52009-01-03 21:22:43 +00005437 if( ssl->out_left != 0 )
5438 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005439 /*
5440 * The user has previously tried to send the data and
5441 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5442 * written. In this case, we expect the high-level write function
5443 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005445 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005446 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005447 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005448 return( ret );
5449 }
5450 }
Paul Bakker887bd502011-06-08 13:10:54 +00005451 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005452 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005453 /*
5454 * The user is trying to send a message the first time, so we need to
5455 * copy the data into the internal buffers and setup the data structure
5456 * to keep track of partial writes
5457 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005458 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005460 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005461
Hanno Becker67bc7c32018-08-06 11:33:50 +01005462 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005463 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005465 return( ret );
5466 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005467 }
5468
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005469 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005470}
5471
5472/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005473 * Write application data, doing 1/n-1 splitting if necessary.
5474 *
5475 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005476 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005477 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005480static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005481 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005482{
Janos Follath865b3eb2019-12-16 11:46:15 +00005483 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005484
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005485 if( ssl->conf->cbc_record_splitting ==
5486 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005487 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5489 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5490 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005491 {
5492 return( ssl_write_real( ssl, buf, len ) );
5493 }
5494
5495 if( ssl->split_done == 0 )
5496 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005497 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005498 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005499 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005500 }
5501
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005502 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5503 return( ret );
5504 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005505
5506 return( ret + 1 );
5507}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005509
5510/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005511 * Write application data (public-facing wrapper)
5512 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005513int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005514{
Janos Follath865b3eb2019-12-16 11:46:15 +00005515 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005516
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005517 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005518
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005519 if( ssl == NULL || ssl->conf == NULL )
5520 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5521
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005522#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005523 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5524 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005525 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005526 return( ret );
5527 }
5528#endif
5529
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005530 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005531 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005532 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005533 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005534 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005535 return( ret );
5536 }
5537 }
5538
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005539#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005540 ret = ssl_write_split( ssl, buf, len );
5541#else
5542 ret = ssl_write_real( ssl, buf, len );
5543#endif
5544
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005545 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005546
5547 return( ret );
5548}
5549
5550/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005551 * Notify the peer that the connection is being closed
5552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005553int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005554{
Janos Follath865b3eb2019-12-16 11:46:15 +00005555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005556
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005557 if( ssl == NULL || ssl->conf == NULL )
5558 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005561
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005562 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005563 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005565 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005566 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005567 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5568 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5569 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005570 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005571 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005572 return( ret );
5573 }
5574 }
5575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005576 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005577
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005578 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005579}
5580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005581void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005582{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005583 if( transform == NULL )
5584 return;
5585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005587 deflateEnd( &transform->ctx_deflate );
5588 inflateEnd( &transform->ctx_inflate );
5589#endif
5590
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005591 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5592 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005593
Hanno Beckerd56ed242018-01-03 15:32:51 +00005594#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005595 mbedtls_md_free( &transform->md_ctx_enc );
5596 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005597#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005598
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005599 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005600}
5601
Hanno Becker0271f962018-08-16 13:23:47 +01005602#if defined(MBEDTLS_SSL_PROTO_DTLS)
5603
Hanno Becker533ab5f2020-02-05 10:49:13 +00005604void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005605{
5606 unsigned offset;
5607 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5608
5609 if( hs == NULL )
5610 return;
5611
Hanno Becker283f5ef2018-08-24 09:34:47 +01005612 ssl_free_buffered_record( ssl );
5613
Hanno Becker0271f962018-08-16 13:23:47 +01005614 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005615 ssl_buffering_free_slot( ssl, offset );
5616}
5617
5618static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5619 uint8_t slot )
5620{
5621 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5622 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005623
5624 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5625 return;
5626
Hanno Beckere605b192018-08-21 15:59:07 +01005627 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005628 {
Hanno Beckere605b192018-08-21 15:59:07 +01005629 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005630 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005631 mbedtls_free( hs_buf->data );
5632 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005633 }
5634}
5635
5636#endif /* MBEDTLS_SSL_PROTO_DTLS */
5637
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005638/*
5639 * Convert version numbers to/from wire format
5640 * and, for DTLS, to/from TLS equivalent.
5641 *
5642 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005643 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005644 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5645 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005647void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005648 unsigned char ver[2] )
5649{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005650#if defined(MBEDTLS_SSL_PROTO_DTLS)
5651 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005653 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005654 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5655
5656 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5657 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5658 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005659 else
5660#else
5661 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005662#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005663 {
5664 ver[0] = (unsigned char) major;
5665 ver[1] = (unsigned char) minor;
5666 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005667}
5668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005669void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005670 const unsigned char ver[2] )
5671{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672#if defined(MBEDTLS_SSL_PROTO_DTLS)
5673 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005674 {
5675 *major = 255 - ver[0] + 2;
5676 *minor = 255 - ver[1] + 1;
5677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005678 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005679 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5680 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005681 else
5682#else
5683 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005684#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005685 {
5686 *major = ver[0];
5687 *minor = ver[1];
5688 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005689}
5690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005691#endif /* MBEDTLS_SSL_TLS_C */