blob: 32bbc97be8d4311e930de858503f88749cbfc419 [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 );
Darryl Greenb33cc762019-11-28 14:29:44 +0000182#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
183 size_t out_buf_len = ssl->out_buf_len;
184#else
185 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
186#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100187
Darryl Greenb33cc762019-11-28 14:29:44 +0000188 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100189 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100190
Darryl Greenb33cc762019-11-28 14:29:44 +0000191 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100192}
193
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
195{
Hanno Becker11682cc2018-08-22 14:41:02 +0100196 size_t const bytes_written = ssl->out_left;
197 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198
199 /* Double-check that the write-index hasn't gone
200 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100201 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100202 {
203 /* Should never happen... */
204 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
205 }
206
207 return( (int) ( mtu - bytes_written ) );
208}
209
210static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
211{
Janos Follath865b3eb2019-12-16 11:46:15 +0000212 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100213 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400214 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100215
216#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400217 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100218
219 if( max_len > mfl )
220 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100221
222 /* By the standard (RFC 6066 Sect. 4), the MFL extension
223 * only limits the maximum record payload size, so in theory
224 * we would be allowed to pack multiple records of payload size
225 * MFL into a single datagram. However, this would mean that there's
226 * no way to explicitly communicate MTU restrictions to the peer.
227 *
228 * The following reduction of max_len makes sure that we never
229 * write datagrams larger than MFL + Record Expansion Overhead.
230 */
231 if( max_len <= ssl->out_left )
232 return( 0 );
233
234 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100235#endif
236
237 ret = ssl_get_remaining_space_in_datagram( ssl );
238 if( ret < 0 )
239 return( ret );
240 remaining = (size_t) ret;
241
242 ret = mbedtls_ssl_get_record_expansion( ssl );
243 if( ret < 0 )
244 return( ret );
245 expansion = (size_t) ret;
246
247 if( remaining <= expansion )
248 return( 0 );
249
250 remaining -= expansion;
251 if( remaining >= max_len )
252 remaining = max_len;
253
254 return( (int) remaining );
255}
256
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200257/*
258 * Double the retransmit timeout value, within the allowed range,
259 * returning -1 if the maximum value has already been reached.
260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200262{
263 uint32_t new_timeout;
264
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200265 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200266 return( -1 );
267
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
269 * in the following way: after the initial transmission and a first
270 * retransmission, back off to a temporary estimated MTU of 508 bytes.
271 * This value is guaranteed to be deliverable (if not guaranteed to be
272 * delivered) of any compliant IPv4 (and IPv6) network, and should work
273 * on most non-IP stacks too. */
274 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400275 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200276 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
278 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200279
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200280 new_timeout = 2 * ssl->handshake->retransmit_timeout;
281
282 /* Avoid arithmetic overflow and range overflow */
283 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200284 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200286 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200287 }
288
289 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200291 ssl->handshake->retransmit_timeout ) );
292
293 return( 0 );
294}
295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200297{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200298 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200300 ssl->handshake->retransmit_timeout ) );
301}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
305int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200306 const unsigned char *key_enc, const unsigned char *key_dec,
307 size_t keylen,
308 const unsigned char *iv_enc, const unsigned char *iv_dec,
309 size_t ivlen,
310 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200311 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
313int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
314int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
315int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
316int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
317#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000318
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200319/* The function below is only used in the Lucky 13 counter-measure in
Hanno Beckerb2ca87d2018-10-18 15:43:13 +0100320 * mbedtls_ssl_decrypt_buf(). These are the defines that guard the call site. */
Hanno Becker52344c22018-01-03 15:24:20 +0000321#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC) && \
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +0200322 ( defined(MBEDTLS_SSL_PROTO_TLS1) || \
323 defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
324 defined(MBEDTLS_SSL_PROTO_TLS1_2) )
325/* This function makes sure every byte in the memory region is accessed
326 * (in ascending addresses order) */
327static void ssl_read_memory( unsigned char *p, size_t len )
328{
329 unsigned char acc = 0;
330 volatile unsigned char force;
331
332 for( ; len != 0; p++, len-- )
333 acc ^= *p;
334
335 force = acc;
336 (void) force;
337}
338#endif /* SSL_SOME_MODES_USE_MAC && ( TLS1 || TLS1_1 || TLS1_2 ) */
339
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100340/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000341 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200342 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000343
Hanno Beckerccc13d02020-05-04 12:30:04 +0100344#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
345 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100346
347static size_t ssl_compute_padding_length( size_t len,
348 size_t granularity )
349{
350 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
351}
352
Hanno Becker581bc1b2020-05-04 12:20:03 +0100353/* This functions transforms a (D)TLS plaintext fragment and a record content
354 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
355 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
356 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100357 *
358 * struct {
359 * opaque content[DTLSPlaintext.length];
360 * ContentType real_type;
361 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100362 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363 *
364 * Input:
365 * - `content`: The beginning of the buffer holding the
366 * plaintext to be wrapped.
367 * - `*content_size`: The length of the plaintext in Bytes.
368 * - `max_len`: The number of Bytes available starting from
369 * `content`. This must be `>= *content_size`.
370 * - `rec_type`: The desired record content type.
371 *
372 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100373 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
374 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100375 *
376 * Returns:
377 * - `0` on success.
378 * - A negative error code if `max_len` didn't offer enough space
379 * for the expansion.
380 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100381static int ssl_build_inner_plaintext( unsigned char *content,
382 size_t *content_size,
383 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100384 uint8_t rec_type,
385 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100386{
387 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100388
389 /* Write real content type */
390 if( remaining == 0 )
391 return( -1 );
392 content[ len ] = rec_type;
393 len++;
394 remaining--;
395
396 if( remaining < pad )
397 return( -1 );
398 memset( content + len, 0, pad );
399 len += pad;
400 remaining -= pad;
401
402 *content_size = len;
403 return( 0 );
404}
405
Hanno Becker581bc1b2020-05-04 12:20:03 +0100406/* This function parses a (D)TLSInnerPlaintext structure.
407 * See ssl_build_inner_plaintext() for details. */
408static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100409 size_t *content_size,
410 uint8_t *rec_type )
411{
412 size_t remaining = *content_size;
413
414 /* Determine length of padding by skipping zeroes from the back. */
415 do
416 {
417 if( remaining == 0 )
418 return( -1 );
419 remaining--;
420 } while( content[ remaining ] == 0 );
421
422 *content_size = remaining;
423 *rec_type = content[ remaining ];
424
425 return( 0 );
426}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100427#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
428 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100429
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100430/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100431 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000432static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100433 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100434 mbedtls_record *rec,
435 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000436{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100437 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100438 *
439 * additional_data = seq_num + TLSCompressed.type +
440 * TLSCompressed.version + TLSCompressed.length;
441 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100442 * For the CID extension, this is extended as follows
443 * (quoting draft-ietf-tls-dtls-connection-id-05,
444 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100445 *
446 * additional_data = seq_num + DTLSPlaintext.type +
447 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100448 * cid +
449 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100450 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 *
452 * For TLS 1.3, the record sequence number is dropped from the AAD
453 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100454 */
455
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100456 unsigned char *cur = add_data;
457
458#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
459 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
460#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
461 {
462 ((void) minor_ver);
463 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
464 cur += sizeof( rec->ctr );
465 }
466
467 *cur = rec->type;
468 cur++;
469
470 memcpy( cur, rec->ver, sizeof( rec->ver ) );
471 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100472
Hanno Beckera0e20d02019-05-15 14:03:01 +0100473#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100474 if( rec->cid_len != 0 )
475 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100476 memcpy( cur, rec->cid, rec->cid_len );
477 cur += rec->cid_len;
478
479 *cur = rec->cid_len;
480 cur++;
481
482 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
483 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
484 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100485 }
486 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100487#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100488 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100489 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
490 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
491 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100492 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100493
494 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000495}
496
Hanno Becker9d062f92020-02-07 10:26:36 +0000497#if defined(MBEDTLS_SSL_PROTO_SSL3)
498
499#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
500
501/*
502 * SSLv3.0 MAC functions
503 */
504static void ssl_mac( mbedtls_md_context_t *md_ctx,
505 const unsigned char *secret,
506 const unsigned char *buf, size_t len,
507 const unsigned char *ctr, int type,
508 unsigned char out[SSL3_MAC_MAX_BYTES] )
509{
510 unsigned char header[11];
511 unsigned char padding[48];
512 int padlen;
513 int md_size = mbedtls_md_get_size( md_ctx->md_info );
514 int md_type = mbedtls_md_get_type( md_ctx->md_info );
515
516 /* Only MD5 and SHA-1 supported */
517 if( md_type == MBEDTLS_MD_MD5 )
518 padlen = 48;
519 else
520 padlen = 40;
521
522 memcpy( header, ctr, 8 );
523 header[ 8] = (unsigned char) type;
524 header[ 9] = (unsigned char)( len >> 8 );
525 header[10] = (unsigned char)( len );
526
527 memset( padding, 0x36, padlen );
528 mbedtls_md_starts( md_ctx );
529 mbedtls_md_update( md_ctx, secret, md_size );
530 mbedtls_md_update( md_ctx, padding, padlen );
531 mbedtls_md_update( md_ctx, header, 11 );
532 mbedtls_md_update( md_ctx, buf, len );
533 mbedtls_md_finish( md_ctx, out );
534
535 memset( padding, 0x5C, padlen );
536 mbedtls_md_starts( md_ctx );
537 mbedtls_md_update( md_ctx, secret, md_size );
538 mbedtls_md_update( md_ctx, padding, padlen );
539 mbedtls_md_update( md_ctx, out, md_size );
540 mbedtls_md_finish( md_ctx, out );
541}
542#endif /* MBEDTLS_SSL_PROTO_SSL3 */
543
Hanno Becker67a37db2020-05-28 16:27:07 +0100544#if defined(MBEDTLS_GCM_C) || \
545 defined(MBEDTLS_CCM_C) || \
546 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100547static int ssl_transform_aead_dynamic_iv_is_explicit(
548 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100549{
Hanno Becker17263802020-05-28 07:05:48 +0100550 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100551}
552
Hanno Becker17263802020-05-28 07:05:48 +0100553/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
554 *
555 * Concretely, this occurs in two variants:
556 *
557 * a) Fixed and dynamic IV lengths add up to total IV length, giving
558 * IV = fixed_iv || dynamic_iv
559 *
Hanno Becker15952812020-06-04 13:31:46 +0100560 * This variant is used in TLS 1.2 when used with GCM or CCM.
561 *
Hanno Becker17263802020-05-28 07:05:48 +0100562 * b) Fixed IV lengths matches total IV length, giving
563 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100564 *
565 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
566 *
567 * See also the documentation of mbedtls_ssl_transform.
Hanno Becker17263802020-05-28 07:05:48 +0100568 */
569static void ssl_build_record_nonce( unsigned char *dst_iv,
570 size_t dst_iv_len,
571 unsigned char const *fixed_iv,
572 size_t fixed_iv_len,
573 unsigned char const *dynamic_iv,
574 size_t dynamic_iv_len )
575{
576 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100577
578 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100579 memset( dst_iv, 0, dst_iv_len );
580 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100581
Hanno Becker17263802020-05-28 07:05:48 +0100582 dst_iv += dst_iv_len - dynamic_iv_len;
583 for( i = 0; i < dynamic_iv_len; i++ )
584 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100585}
Hanno Becker67a37db2020-05-28 16:27:07 +0100586#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100587
Hanno Beckera18d1322018-01-03 14:27:32 +0000588int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
589 mbedtls_ssl_transform *transform,
590 mbedtls_record *rec,
591 int (*f_rng)(void *, unsigned char *, size_t),
592 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000593{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100595 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000596 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100597 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100598 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 size_t post_avail;
600
601 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000602#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200603 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000604 ((void) ssl);
605#endif
606
607 /* The PRNG is used for dynamic IV generation that's used
608 * for CBC transformations in TLS 1.1 and TLS 1.2. */
609#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
610 ( defined(MBEDTLS_AES_C) || \
611 defined(MBEDTLS_ARIA_C) || \
612 defined(MBEDTLS_CAMELLIA_C) ) && \
613 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
614 ((void) f_rng);
615 ((void) p_rng);
616#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000619
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000620 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100621 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000622 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
623 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
624 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100625 if( rec == NULL
626 || rec->buf == NULL
627 || rec->buf_len < rec->data_offset
628 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100629#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100630 || rec->cid_len != 0
631#endif
632 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000633 {
634 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100636 }
637
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000638 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100639 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000641 data, rec->data_len );
642
643 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
644
645 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
646 {
647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
648 (unsigned) rec->data_len,
649 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
650 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
651 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100652
Hanno Becker92313402020-05-20 13:58:58 +0100653 /* The following two code paths implement the (D)TLSInnerPlaintext
654 * structure present in TLS 1.3 and DTLS 1.2 + CID.
655 *
656 * See ssl_build_inner_plaintext() for more information.
657 *
658 * Note that this changes `rec->data_len`, and hence
659 * `post_avail` needs to be recalculated afterwards.
660 *
661 * Note also that the two code paths cannot occur simultaneously
662 * since they apply to different versions of the protocol. There
663 * is hence no risk of double-addition of the inner plaintext.
664 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100665#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
666 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
667 {
Hanno Becker13996922020-05-28 16:15:19 +0100668 size_t padding =
669 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100670 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100671 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100672 &rec->data_len,
673 post_avail,
674 rec->type,
675 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100676 {
677 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
678 }
679
680 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
681 }
682#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
683
Hanno Beckera0e20d02019-05-15 14:03:01 +0100684#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100685 /*
686 * Add CID information
687 */
688 rec->cid_len = transform->out_cid_len;
689 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
690 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100691
692 if( rec->cid_len != 0 )
693 {
Hanno Becker13996922020-05-28 16:15:19 +0100694 size_t padding =
695 ssl_compute_padding_length( rec->data_len,
696 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100697 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100698 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100699 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100700 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100701 * Note that this changes `rec->data_len`, and hence
702 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100703 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100704 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100705 &rec->data_len,
706 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100707 rec->type,
708 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100709 {
710 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
711 }
712
713 rec->type = MBEDTLS_SSL_MSG_CID;
714 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100715#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100716
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100717 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
718
Paul Bakker5121ce52009-01-03 21:22:43 +0000719 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100720 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000721 */
Hanno Becker52344c22018-01-03 15:24:20 +0000722#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200723 if( mode == MBEDTLS_MODE_STREAM ||
724 ( mode == MBEDTLS_MODE_CBC
725#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100727#endif
728 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000729 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000730 if( post_avail < transform->maclen )
731 {
732 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
733 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
734 }
735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000737 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200738 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000739 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000740 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
741 data, rec->data_len, rec->ctr, rec->type, mac );
742 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200743 }
744 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200745#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
747 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000748 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200749 {
Hanno Becker992b6872017-11-09 18:57:39 +0000750 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
751
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100752 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
753 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000754
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000755 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100756 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000757 mbedtls_md_hmac_update( &transform->md_ctx_enc,
758 data, rec->data_len );
759 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
760 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
761
762 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200763 }
764 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200765#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200766 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
768 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200769 }
770
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000771 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
772 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200773
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000774 rec->data_len += transform->maclen;
775 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100776 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200777 }
Hanno Becker52344c22018-01-03 15:24:20 +0000778#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000779
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200780 /*
781 * Encrypt
782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
784 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000785 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000786 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000787 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 "including %d bytes of padding",
790 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000791
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000792 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
793 transform->iv_enc, transform->ivlen,
794 data, rec->data_len,
795 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200798 return( ret );
799 }
800
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000801 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200802 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
804 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200805 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000806 }
Paul Bakker68884e32013-01-07 18:20:04 +0100807 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000809
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200810#if defined(MBEDTLS_GCM_C) || \
811 defined(MBEDTLS_CCM_C) || \
812 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200814 mode == MBEDTLS_MODE_CCM ||
815 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000816 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200818 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100819 unsigned char *dynamic_iv;
820 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100821 int dynamic_iv_is_explicit =
822 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000823
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100824 /* Check that there's space for the authentication tag. */
825 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000826 {
827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
828 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
829 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000830
Paul Bakker68884e32013-01-07 18:20:04 +0100831 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100832 * Build nonce for AEAD encryption.
833 *
834 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
835 * part of the IV is prepended to the ciphertext and
836 * can be chosen freely - in particular, it need not
837 * agree with the record sequence number.
838 * However, since ChaChaPoly as well as all AEAD modes
839 * in TLS 1.3 use the record sequence number as the
840 * dynamic part of the nonce, we uniformly use the
841 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100842 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100843 dynamic_iv = rec->ctr;
844 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845
Hanno Becker17263802020-05-28 07:05:48 +0100846 ssl_build_record_nonce( iv, sizeof( iv ),
847 transform->iv_enc,
848 transform->fixed_ivlen,
849 dynamic_iv,
850 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100851
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100852 /*
853 * Build additional data for AEAD encryption.
854 * This depends on the TLS version.
855 */
856 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
857 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100858
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200859 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100860 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200861 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100862 dynamic_iv,
863 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100865 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200867 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000868 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000869
Paul Bakker68884e32013-01-07 18:20:04 +0100870 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200871 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200872 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000873
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200874 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100876 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000877 data, rec->data_len, /* source */
878 data, &rec->data_len, /* destination */
879 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200880 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200882 return( ret );
883 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000884 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
885 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100886 /* Account for authentication tag. */
887 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000888 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100889
890 /*
891 * Prefix record content with dynamic IV in case it is explicit.
892 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100893 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100894 {
895 if( rec->data_offset < dynamic_iv_len )
896 {
897 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
898 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
899 }
900
901 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
902 rec->data_offset -= dynamic_iv_len;
903 rec->data_len += dynamic_iv_len;
904 }
905
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100906 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000907 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000908 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100909#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000911 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000913 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000915 size_t padlen, i;
916 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000917
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000918 /* Currently we're always using minimal padding
919 * (up to 255 bytes would be allowed). */
920 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
921 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000922 padlen = 0;
923
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000924 /* Check there's enough space in the buffer for the padding. */
925 if( post_avail < padlen + 1 )
926 {
927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
928 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
929 }
930
Paul Bakker5121ce52009-01-03 21:22:43 +0000931 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000933
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000934 rec->data_len += padlen + 1;
935 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000938 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000939 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
940 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000941 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000942 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000944 if( f_rng == NULL )
945 {
946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
947 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
948 }
949
950 if( rec->data_offset < transform->ivlen )
951 {
952 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
953 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
954 }
955
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000956 /*
957 * Generate IV
958 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000959 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000960 if( ret != 0 )
961 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 memcpy( data - transform->ivlen, transform->iv_enc,
964 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000965
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000966 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000970 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000971 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200972 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000973
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000974 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
975 transform->iv_enc,
976 transform->ivlen,
977 data, rec->data_len,
978 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200979 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200981 return( ret );
982 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200983
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000984 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200985 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
987 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200988 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000991 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200992 {
993 /*
994 * Save IV in SSL3 and TLS1
995 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000996 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
997 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000998 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000999 else
Paul Bakkercca5b812013-08-31 17:40:26 +02001000#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001001 {
1002 data -= transform->ivlen;
1003 rec->data_offset -= transform->ivlen;
1004 rec->data_len += transform->ivlen;
1005 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001008 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001009 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001010 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1011
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001012 /*
1013 * MAC(MAC_write_key, seq_num +
1014 * TLSCipherText.type +
1015 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001016 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001017 * IV + // except for TLS 1.0
1018 * ENC(content + padding + padding_length));
1019 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020
1021 if( post_avail < transform->maclen)
1022 {
1023 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1024 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1025 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001026
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001027 ssl_extract_add_data_from_record( add_data, &add_data_len,
1028 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001029
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001031 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001032 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001033
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001034 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001035 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001036 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1037 data, rec->data_len );
1038 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1039 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001040
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001041 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001042
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001043 rec->data_len += transform->maclen;
1044 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001045 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001046 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001048 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001049 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001051 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001052 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1054 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001055 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001056
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001057 /* Make extra sure authentication was performed, exactly once */
1058 if( auth_done != 1 )
1059 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1061 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001062 }
1063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001065
1066 return( 0 );
1067}
1068
Hanno Becker605949f2019-07-12 08:23:59 +01001069int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001070 mbedtls_ssl_transform *transform,
1071 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001072{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001073 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001075 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001076#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001077 size_t padlen = 0, correct = 1;
1078#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001079 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001080 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001081 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001082
Hanno Beckera18d1322018-01-03 14:27:32 +00001083#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001084 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001085 ((void) ssl);
1086#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001088 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001089 if( rec == NULL ||
1090 rec->buf == NULL ||
1091 rec->buf_len < rec->data_offset ||
1092 rec->buf_len - rec->data_offset < rec->data_len )
1093 {
1094 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001096 }
1097
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001098 data = rec->buf + rec->data_offset;
1099 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001100
Hanno Beckera0e20d02019-05-15 14:03:01 +01001101#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001102 /*
1103 * Match record's CID with incoming CID.
1104 */
Hanno Becker938489a2019-05-08 13:02:22 +01001105 if( rec->cid_len != transform->in_cid_len ||
1106 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1107 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001108 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001109 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001110#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1113 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001114 {
1115 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001116 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1117 transform->iv_dec,
1118 transform->ivlen,
1119 data, rec->data_len,
1120 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001121 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001123 return( ret );
1124 }
1125
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001126 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001127 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1129 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001130 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001131 }
Paul Bakker68884e32013-01-07 18:20:04 +01001132 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001134#if defined(MBEDTLS_GCM_C) || \
1135 defined(MBEDTLS_CCM_C) || \
1136 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001138 mode == MBEDTLS_MODE_CCM ||
1139 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001140 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001141 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001142 unsigned char *dynamic_iv;
1143 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001144
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001145 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001146 * Extract dynamic part of nonce for AEAD decryption.
1147 *
1148 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1149 * part of the IV is prepended to the ciphertext and
1150 * can be chosen freely - in particular, it need not
1151 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001152 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001153 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001154 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001155 {
1156 if( rec->data_len < dynamic_iv_len )
1157 {
1158 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1159 rec->data_len,
1160 dynamic_iv_len ) );
1161 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1162 }
1163 dynamic_iv = data;
1164
1165 data += dynamic_iv_len;
1166 rec->data_offset += dynamic_iv_len;
1167 rec->data_len -= dynamic_iv_len;
1168 }
Hanno Becker17263802020-05-28 07:05:48 +01001169 else
1170 {
1171 dynamic_iv = rec->ctr;
1172 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001173
1174 /* Check that there's space for the authentication tag. */
1175 if( rec->data_len < transform->taglen )
1176 {
1177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001179 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001180 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001181
Hanno Beckerdf8be222020-05-21 15:30:57 +01001182 /*
1183 * Prepare nonce from dynamic and static parts.
1184 */
Hanno Becker17263802020-05-28 07:05:48 +01001185 ssl_build_record_nonce( iv, sizeof( iv ),
1186 transform->iv_dec,
1187 transform->fixed_ivlen,
1188 dynamic_iv,
1189 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001190
Hanno Beckerdf8be222020-05-21 15:30:57 +01001191 /*
1192 * Build additional data for AEAD encryption.
1193 * This depends on the TLS version.
1194 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001195 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1196 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001197 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001198 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001199
Hanno Beckerd96a6522019-07-10 13:55:25 +01001200 /* Because of the check above, we know that there are
1201 * explicit_iv_len Bytes preceeding data, and taglen
1202 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001203 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001204 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001205
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001206 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001207 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001208 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001209
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001210 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001211 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001212 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001213 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1214 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001215 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 data, rec->data_len,
1217 data, &olen,
1218 data + rec->data_len,
1219 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001220 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001223 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1224 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001225
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001226 return( ret );
1227 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001228 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001229
Hanno Beckerd96a6522019-07-10 13:55:25 +01001230 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001231 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001232 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1234 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001235 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001236 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001237 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001238#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1239#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001240 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001241 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001242 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001243 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001244
Paul Bakker5121ce52009-01-03 21:22:43 +00001245 /*
Paul Bakker45829992013-01-03 14:52:21 +01001246 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001249 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1250 {
1251 /* The ciphertext is prefixed with the CBC IV. */
1252 minlen += transform->ivlen;
1253 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001254#endif
Paul Bakker45829992013-01-03 14:52:21 +01001255
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001256 /* Size considerations:
1257 *
1258 * - The CBC cipher text must not be empty and hence
1259 * at least of size transform->ivlen.
1260 *
1261 * Together with the potential IV-prefix, this explains
1262 * the first of the two checks below.
1263 *
1264 * - The record must contain a MAC, either in plain or
1265 * encrypted, depending on whether Encrypt-then-MAC
1266 * is used or not.
1267 * - If it is, the message contains the IV-prefix,
1268 * the CBC ciphertext, and the MAC.
1269 * - If it is not, the padded plaintext, and hence
1270 * the CBC ciphertext, has at least length maclen + 1
1271 * because there is at least the padding length byte.
1272 *
1273 * As the CBC ciphertext is not empty, both cases give the
1274 * lower bound minlen + maclen + 1 on the record size, which
1275 * we test for in the second check below.
1276 */
1277 if( rec->data_len < minlen + transform->ivlen ||
1278 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001279 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001281 "+ 1 ) ( + expl IV )", rec->data_len,
1282 transform->ivlen,
1283 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001285 }
1286
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001287 /*
1288 * Authenticate before decrypt if enabled
1289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001291 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001292 {
Hanno Becker992b6872017-11-09 18:57:39 +00001293 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001296
Hanno Beckerd96a6522019-07-10 13:55:25 +01001297 /* Update data_len in tandem with add_data.
1298 *
1299 * The subtraction is safe because of the previous check
1300 * data_len >= minlen + maclen + 1.
1301 *
1302 * Afterwards, we know that data + data_len is followed by at
1303 * least maclen Bytes, which justifies the call to
1304 * mbedtls_ssl_safer_memcmp() below.
1305 *
1306 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001307 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001308 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1309 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001310
Hanno Beckerd96a6522019-07-10 13:55:25 +01001311 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001312 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1313 add_data_len );
1314 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1315 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001316 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1317 data, rec->data_len );
1318 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1319 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001320
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001321 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1322 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001323 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001325
Hanno Beckerd96a6522019-07-10 13:55:25 +01001326 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1328 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001332 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001333 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001334 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001336
1337 /*
1338 * Check length sanity
1339 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001340
1341 /* We know from above that data_len > minlen >= 0,
1342 * so the following check in particular implies that
1343 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001344 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001347 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001349 }
1350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001351#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001352 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001353 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001354 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001355 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001356 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001357 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001358 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001359
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001360 data += transform->ivlen;
1361 rec->data_offset += transform->ivlen;
1362 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001363 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001365
Hanno Beckerd96a6522019-07-10 13:55:25 +01001366 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1367
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001368 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1369 transform->iv_dec, transform->ivlen,
1370 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001371 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001373 return( ret );
1374 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001375
Hanno Beckerd96a6522019-07-10 13:55:25 +01001376 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001377 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001378 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1380 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001381 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001384 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001385 {
1386 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001387 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1388 * records is equivalent to CBC decryption of the concatenation
1389 * of the records; in other words, IVs are maintained across
1390 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001391 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001392 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1393 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001394 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001395#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001396
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397 /* Safe since data_len >= minlen + maclen + 1, so after having
1398 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001399 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1400 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001401 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001402
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001403 if( auth_done == 1 )
1404 {
1405 correct *= ( rec->data_len >= padlen + 1 );
1406 padlen *= ( rec->data_len >= padlen + 1 );
1407 }
1408 else
Paul Bakker45829992013-01-03 14:52:21 +01001409 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001411 if( rec->data_len < transform->maclen + padlen + 1 )
1412 {
1413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1414 rec->data_len,
1415 transform->maclen,
1416 padlen + 1 ) );
1417 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001418#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001419
1420 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1421 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001422 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001423
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 padlen++;
1425
1426 /* Regardless of the validity of the padding,
1427 * we have data_len >= padlen here. */
1428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001429#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001431 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001432 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#if defined(MBEDTLS_SSL_DEBUG_ALL)
1435 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436 "should be no more than %d",
1437 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001438#endif
Paul Bakker45829992013-01-03 14:52:21 +01001439 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001440 }
1441 }
1442 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001443#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1444#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1445 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001446 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001447 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001448 /* The padding check involves a series of up to 256
1449 * consecutive memory reads at the end of the record
1450 * plaintext buffer. In order to hide the length and
1451 * validity of the padding, always perform exactly
1452 * `min(256,plaintext_len)` reads (but take into account
1453 * only the last `padlen` bytes for the padding check). */
1454 size_t pad_count = 0;
1455 size_t real_count = 0;
1456 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001457
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001458 /* Index of first padding byte; it has been ensured above
1459 * that the subtraction is safe. */
1460 size_t const padding_idx = rec->data_len - padlen;
1461 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1462 size_t const start_idx = rec->data_len - num_checks;
1463 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001464
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001465 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001466 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001467 real_count |= ( idx >= padding_idx );
1468 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001469 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001470 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001471
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001472#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001473 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001475#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001476 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001477 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001478 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1480 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001481 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1483 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001484 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001485
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001486 /* If the padding was found to be invalid, padlen == 0
1487 * and the subtraction is safe. If the padding was found valid,
1488 * padlen hasn't been changed and the previous assertion
1489 * data_len >= padlen still holds. */
1490 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001491 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001492 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001494 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001495 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1497 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001498 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001499
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001500#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001503#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001504
1505 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001506 * Authenticate if not done yet.
1507 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001508 */
Hanno Becker52344c22018-01-03 15:24:20 +00001509#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001510 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001511 {
Hanno Becker992b6872017-11-09 18:57:39 +00001512 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001513
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001514 /* If the initial value of padlen was such that
1515 * data_len < maclen + padlen + 1, then padlen
1516 * got reset to 1, and the initial check
1517 * data_len >= minlen + maclen + 1
1518 * guarantees that at this point we still
1519 * have at least data_len >= maclen.
1520 *
1521 * If the initial value of padlen was such that
1522 * data_len >= maclen + padlen + 1, then we have
1523 * subtracted either padlen + 1 (if the padding was correct)
1524 * or 0 (if the padding was incorrect) since then,
1525 * hence data_len >= maclen in any case.
1526 */
1527 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001528 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1529 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001532 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001533 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001534 ssl_mac( &transform->md_ctx_dec,
1535 transform->mac_dec,
1536 data, rec->data_len,
1537 rec->ctr, rec->type,
1538 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001539 }
1540 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1542#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1543 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001544 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001545 {
1546 /*
1547 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001548 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001549 *
1550 * Known timing attacks:
1551 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1552 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001553 * To compensate for different timings for the MAC calculation
1554 * depending on how much padding was removed (which is determined
1555 * by padlen), process extra_run more blocks through the hash
1556 * function.
1557 *
1558 * The formula in the paper is
1559 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1560 * where L1 is the size of the header plus the decrypted message
1561 * plus CBC padding and L2 is the size of the header plus the
1562 * decrypted message. This is for an underlying hash function
1563 * with 64-byte blocks.
1564 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1565 * correctly. We round down instead of up, so -56 is the correct
1566 * value for our calculations instead of -55.
1567 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001568 * Repeat the formula rather than defining a block_size variable.
1569 * This avoids requiring division by a variable at runtime
1570 * (which would be marginally less efficient and would require
1571 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001572 */
1573 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001574 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001575
1576 /*
1577 * The next two sizes are the minimum and maximum values of
1578 * in_msglen over all padlen values.
1579 *
1580 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001581 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001582 *
1583 * Note that max_len + maclen is never more than the buffer
1584 * length, as we previously did in_msglen -= maclen too.
1585 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001586 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001587 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1588
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001589 memset( tmp, 0, sizeof( tmp ) );
1590
1591 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001592 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001593#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1594 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001595 case MBEDTLS_MD_MD5:
1596 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001597 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001598 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001599 extra_run =
1600 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1601 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001602 break;
1603#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001604#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001605 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001606 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001607 extra_run =
1608 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1609 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001610 break;
1611#endif
1612 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1615 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001616
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001617 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001618
Hanno Beckercab87e62019-04-29 13:52:53 +01001619 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1620 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001621 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1622 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001623 /* Make sure we access everything even when padlen > 0. This
1624 * makes the synchronisation requirements for just-in-time
1625 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001626 ssl_read_memory( data + rec->data_len, padlen );
1627 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001628
1629 /* Call mbedtls_md_process at least once due to cache attacks
1630 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001631 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001632 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001633
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001634 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001635
1636 /* Make sure we access all the memory that could contain the MAC,
1637 * before we check it in the next code block. This makes the
1638 * synchronisation requirements for just-in-time Prime+Probe
1639 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001640 ssl_read_memory( data + min_len,
1641 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001642 }
1643 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1645 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1648 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001649 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001650
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001651#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001652 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1653 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001654#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001655
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001656 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1657 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659#if defined(MBEDTLS_SSL_DEBUG_ALL)
1660 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001661#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001662 correct = 0;
1663 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001664 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001665 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001666
1667 /*
1668 * Finally check the correct flag
1669 */
1670 if( correct == 0 )
1671 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001672#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001673
1674 /* Make extra sure authentication was performed, exactly once */
1675 if( auth_done != 1 )
1676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1678 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001679 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001680
Hanno Beckerccc13d02020-05-04 12:30:04 +01001681#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1682 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1683 {
1684 /* Remove inner padding and infer true content type. */
1685 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1686 &rec->type );
1687
1688 if( ret != 0 )
1689 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1690 }
1691#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1692
Hanno Beckera0e20d02019-05-15 14:03:01 +01001693#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001694 if( rec->cid_len != 0 )
1695 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001696 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1697 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001698 if( ret != 0 )
1699 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1700 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001701#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001704
1705 return( 0 );
1706}
1707
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001708#undef MAC_NONE
1709#undef MAC_PLAINTEXT
1710#undef MAC_CIPHERTEXT
1711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001713/*
1714 * Compression/decompression functions
1715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001717{
Janos Follath865b3eb2019-12-16 11:46:15 +00001718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001719 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001720 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001721 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001722 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001723#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1724 size_t out_buf_len = ssl->out_buf_len;
1725#else
1726 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1727#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001730
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001731 if( len_pre == 0 )
1732 return( 0 );
1733
Paul Bakker2770fbd2012-07-03 13:30:23 +00001734 memcpy( msg_pre, ssl->out_msg, len_pre );
1735
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001737 ssl->out_msglen ) );
1738
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001739 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001740 ssl->out_msg, ssl->out_msglen );
1741
Paul Bakker48916f92012-09-16 19:57:18 +00001742 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1743 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1744 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001745 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001746
Paul Bakker48916f92012-09-16 19:57:18 +00001747 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001748 if( ret != Z_OK )
1749 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1751 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001752 }
1753
Darryl Greenb33cc762019-11-28 14:29:44 +00001754 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001755 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001758 ssl->out_msglen ) );
1759
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001761 ssl->out_msg, ssl->out_msglen );
1762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001764
1765 return( 0 );
1766}
1767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001769{
Janos Follath865b3eb2019-12-16 11:46:15 +00001770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001771 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001772 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001773 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001774 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001775#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1776 size_t in_buf_len = ssl->in_buf_len;
1777#else
1778 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1779#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001781 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001782
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001783 if( len_pre == 0 )
1784 return( 0 );
1785
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786 memcpy( msg_pre, ssl->in_msg, len_pre );
1787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001789 ssl->in_msglen ) );
1790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001792 ssl->in_msg, ssl->in_msglen );
1793
Paul Bakker48916f92012-09-16 19:57:18 +00001794 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1795 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1796 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001797 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798
Paul Bakker48916f92012-09-16 19:57:18 +00001799 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001800 if( ret != Z_OK )
1801 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1803 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001804 }
1805
Darryl Greenb33cc762019-11-28 14:29:44 +00001806 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001807 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001810 ssl->in_msglen ) );
1811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001813 ssl->in_msg, ssl->in_msglen );
1814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001816
1817 return( 0 );
1818}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001820
Paul Bakker5121ce52009-01-03 21:22:43 +00001821/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001822 * Fill the input message buffer by appending data to it.
1823 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001824 *
1825 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1826 * available (from this read and/or a previous one). Otherwise, an error code
1827 * is returned (possibly EOF or WANT_READ).
1828 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001829 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1830 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1831 * since we always read a whole datagram at once.
1832 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001833 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001834 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001837{
Janos Follath865b3eb2019-12-16 11:46:15 +00001838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001839 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001840#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1841 size_t in_buf_len = ssl->in_buf_len;
1842#else
1843 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1844#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001847
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001848 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1849 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001850 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001851 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001853 }
1854
Darryl Greenb33cc762019-11-28 14:29:44 +00001855 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001856 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1858 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001859 }
1860
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001862 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001863 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001864 uint32_t timeout;
1865
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001866 /* Just to be sure */
1867 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1868 {
1869 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1870 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1871 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1872 }
1873
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001874 /*
1875 * The point is, we need to always read a full datagram at once, so we
1876 * sometimes read more then requested, and handle the additional data.
1877 * It could be the rest of the current record (while fetching the
1878 * header) and/or some other records in the same datagram.
1879 */
1880
1881 /*
1882 * Move to the next record in the already read datagram if applicable
1883 */
1884 if( ssl->next_record_offset != 0 )
1885 {
1886 if( ssl->in_left < ssl->next_record_offset )
1887 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1889 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001890 }
1891
1892 ssl->in_left -= ssl->next_record_offset;
1893
1894 if( ssl->in_left != 0 )
1895 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001897 ssl->next_record_offset ) );
1898 memmove( ssl->in_hdr,
1899 ssl->in_hdr + ssl->next_record_offset,
1900 ssl->in_left );
1901 }
1902
1903 ssl->next_record_offset = 0;
1904 }
1905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001907 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001908
1909 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001910 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001911 */
1912 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001913 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001915 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001916 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001917
1918 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001919 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001920 * are not at the beginning of a new record, the caller did something
1921 * wrong.
1922 */
1923 if( ssl->in_left != 0 )
1924 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1926 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001927 }
1928
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001929 /*
1930 * Don't even try to read if time's out already.
1931 * This avoids by-passing the timer when repeatedly receiving messages
1932 * that will end up being dropped.
1933 */
Hanno Becker7876d122020-02-05 10:39:31 +00001934 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001935 {
1936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001937 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001938 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001939 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001940 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001941 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001944 timeout = ssl->handshake->retransmit_timeout;
1945 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001946 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001949
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001950 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001951 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1952 timeout );
1953 else
1954 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001957
1958 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001960 }
1961
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001962 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001965 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001968 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001969 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001972 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001973 }
1974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001976 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001978 return( ret );
1979 }
1980
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001981 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001982 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001984 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001986 {
Hanno Becker786300f2020-02-05 10:46:40 +00001987 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001988 {
Hanno Becker786300f2020-02-05 10:46:40 +00001989 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1990 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001991 return( ret );
1992 }
1993
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001994 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001995 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001997 }
1998
Paul Bakker5121ce52009-01-03 21:22:43 +00001999 if( ret < 0 )
2000 return( ret );
2001
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002002 ssl->in_left = ret;
2003 }
2004 else
2005#endif
2006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002008 ssl->in_left, nb_want ) );
2009
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002010 while( ssl->in_left < nb_want )
2011 {
2012 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002013
Hanno Becker7876d122020-02-05 10:39:31 +00002014 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002015 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2016 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002017 {
2018 if( ssl->f_recv_timeout != NULL )
2019 {
2020 ret = ssl->f_recv_timeout( ssl->p_bio,
2021 ssl->in_hdr + ssl->in_left, len,
2022 ssl->conf->read_timeout );
2023 }
2024 else
2025 {
2026 ret = ssl->f_recv( ssl->p_bio,
2027 ssl->in_hdr + ssl->in_left, len );
2028 }
2029 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002032 ssl->in_left, nb_want ) );
2033 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002034
2035 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002037
2038 if( ret < 0 )
2039 return( ret );
2040
mohammad160352aecb92018-03-28 23:41:40 -07002041 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002042 {
Darryl Green11999bb2018-03-13 15:22:58 +00002043 MBEDTLS_SSL_DEBUG_MSG( 1,
2044 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002045 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002046 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2047 }
2048
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002049 ssl->in_left += ret;
2050 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002051 }
2052
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002054
2055 return( 0 );
2056}
2057
2058/*
2059 * Flush any data not yet written
2060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002062{
Janos Follath865b3eb2019-12-16 11:46:15 +00002063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002064 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002068 if( ssl->f_send == NULL )
2069 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002071 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002073 }
2074
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002075 /* Avoid incrementing counter if data is flushed */
2076 if( ssl->out_left == 0 )
2077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002079 return( 0 );
2080 }
2081
Paul Bakker5121ce52009-01-03 21:22:43 +00002082 while( ssl->out_left > 0 )
2083 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002085 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002086
Hanno Becker2b1e3542018-08-06 11:19:13 +01002087 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002088 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002090 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002091
2092 if( ret <= 0 )
2093 return( ret );
2094
mohammad160352aecb92018-03-28 23:41:40 -07002095 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002096 {
Darryl Green11999bb2018-03-13 15:22:58 +00002097 MBEDTLS_SSL_DEBUG_MSG( 1,
2098 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002099 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002100 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2101 }
2102
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 ssl->out_left -= ret;
2104 }
2105
Hanno Becker2b1e3542018-08-06 11:19:13 +01002106#if defined(MBEDTLS_SSL_PROTO_DTLS)
2107 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002108 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002109 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002110 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002111 else
2112#endif
2113 {
2114 ssl->out_hdr = ssl->out_buf + 8;
2115 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002116 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002117
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002119
2120 return( 0 );
2121}
2122
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002123/*
2124 * Functions to handle the DTLS retransmission state machine
2125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002127/*
2128 * Append current handshake message to current outgoing flight
2129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002131{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002133 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2134 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2135 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002136
2137 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002138 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002139 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002140 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002142 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002143 }
2144
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002145 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002149 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150 }
2151
2152 /* Copy current handshake message with headers */
2153 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2154 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002155 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156 msg->next = NULL;
2157
2158 /* Append to the current flight */
2159 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002160 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002161 else
2162 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002164 while( cur->next != NULL )
2165 cur = cur->next;
2166 cur->next = msg;
2167 }
2168
Hanno Becker3b235902018-08-06 09:54:53 +01002169 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002170 return( 0 );
2171}
2172
2173/*
2174 * Free the current flight of handshake messages
2175 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002176void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002177{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178 mbedtls_ssl_flight_item *cur = flight;
2179 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002180
2181 while( cur != NULL )
2182 {
2183 next = cur->next;
2184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 mbedtls_free( cur->p );
2186 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187
2188 cur = next;
2189 }
2190}
2191
2192/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002193 * Swap transform_out and out_ctr with the alternative ones
2194 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002195static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002196{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002198 unsigned char tmp_out_ctr[8];
2199
2200 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2201 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002203 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002204 }
2205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002207
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002208 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209 tmp_transform = ssl->transform_out;
2210 ssl->transform_out = ssl->handshake->alt_transform_out;
2211 ssl->handshake->alt_transform_out = tmp_transform;
2212
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002213 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002214 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2215 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002216 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002217
2218 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002219 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002220
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2222 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002223 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002224 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2225 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002226 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2228 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002229 }
2230 }
2231#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002232
2233 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002234}
2235
2236/*
2237 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002238 */
2239int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2240{
2241 int ret = 0;
2242
2243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2244
2245 ret = mbedtls_ssl_flight_transmit( ssl );
2246
2247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2248
2249 return( ret );
2250}
2251
2252/*
2253 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254 *
2255 * Need to remember the current message in case flush_output returns
2256 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002257 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002258 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002259int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260{
Janos Follath865b3eb2019-12-16 11:46:15 +00002261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002262 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002266 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002267
2268 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002269 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002270 ret = ssl_swap_epochs( ssl );
2271 if( ret != 0 )
2272 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002273
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002275 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276
2277 while( ssl->handshake->cur_msg != NULL )
2278 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002279 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002280 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002281
Hanno Beckere1dcb032018-08-17 16:47:58 +01002282 int const is_finished =
2283 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2284 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2285
Hanno Becker04da1892018-08-14 13:22:10 +01002286 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2287 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2288
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002289 /* Swap epochs before sending Finished: we can't do it after
2290 * sending ChangeCipherSpec, in case write returns WANT_READ.
2291 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002292 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002293 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002294 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002295 ret = ssl_swap_epochs( ssl );
2296 if( ret != 0 )
2297 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002298 }
2299
Hanno Becker67bc7c32018-08-06 11:33:50 +01002300 ret = ssl_get_remaining_payload_in_datagram( ssl );
2301 if( ret < 0 )
2302 return( ret );
2303 max_frag_len = (size_t) ret;
2304
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002305 /* CCS is copied as is, while HS messages may need fragmentation */
2306 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2307 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002308 if( max_frag_len == 0 )
2309 {
2310 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2311 return( ret );
2312
2313 continue;
2314 }
2315
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002316 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002318 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002319
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002320 /* Update position inside current message */
2321 ssl->handshake->cur_msg_p += cur->len;
2322 }
2323 else
2324 {
2325 const unsigned char * const p = ssl->handshake->cur_msg_p;
2326 const size_t hs_len = cur->len - 12;
2327 const size_t frag_off = p - ( cur->p + 12 );
2328 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002329 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002330
Hanno Beckere1dcb032018-08-17 16:47:58 +01002331 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002332 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002333 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002334 {
2335 ret = ssl_swap_epochs( ssl );
2336 if( ret != 0 )
2337 return( ret );
2338 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002339
Hanno Becker67bc7c32018-08-06 11:33:50 +01002340 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2341 return( ret );
2342
2343 continue;
2344 }
2345 max_hs_frag_len = max_frag_len - 12;
2346
2347 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2348 max_hs_frag_len : rem_len;
2349
2350 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002351 {
2352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002353 (unsigned) cur_hs_frag_len,
2354 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002355 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002356
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002357 /* Messages are stored with handshake headers as if not fragmented,
2358 * copy beginning of headers then fill fragmentation fields.
2359 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2360 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002361
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002362 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2363 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2364 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2365
Hanno Becker67bc7c32018-08-06 11:33:50 +01002366 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2367 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2368 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002369
2370 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2371
Hanno Becker3f7b9732018-08-28 09:53:25 +01002372 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002373 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2374 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002375 ssl->out_msgtype = cur->type;
2376
2377 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002378 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379 }
2380
2381 /* If done with the current message move to the next one if any */
2382 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2383 {
2384 if( cur->next != NULL )
2385 {
2386 ssl->handshake->cur_msg = cur->next;
2387 ssl->handshake->cur_msg_p = cur->next->p + 12;
2388 }
2389 else
2390 {
2391 ssl->handshake->cur_msg = NULL;
2392 ssl->handshake->cur_msg_p = NULL;
2393 }
2394 }
2395
2396 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002397 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002398 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400 return( ret );
2401 }
2402 }
2403
Hanno Becker67bc7c32018-08-06 11:33:50 +01002404 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2405 return( ret );
2406
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002407 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2409 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002410 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002411 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002413 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002414 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002415
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002416 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002417
2418 return( 0 );
2419}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002420
2421/*
2422 * To be called when the last message of an incoming flight is received.
2423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002425{
2426 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002427 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002428 ssl->handshake->flight = NULL;
2429 ssl->handshake->cur_msg = NULL;
2430
2431 /* The next incoming flight will start with this msg_seq */
2432 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2433
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002434 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002435 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002436
Hanno Becker0271f962018-08-16 13:23:47 +01002437 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002438 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002439
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002440 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002441 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2444 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002445 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002447 }
2448 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002450}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002451
2452/*
2453 * To be called when the last message of an outgoing flight is send.
2454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002456{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002457 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002458 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2461 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002462 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002464 }
2465 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002467}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002469
Paul Bakker5121ce52009-01-03 21:22:43 +00002470/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002471 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002472 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002473
2474/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002475 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002476 *
2477 * - fill in handshake headers
2478 * - update handshake checksum
2479 * - DTLS: save message for resending
2480 * - then pass to the record layer
2481 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002482 * DTLS: except for HelloRequest, messages are only queued, and will only be
2483 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002484 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002485 * Inputs:
2486 * - ssl->out_msglen: 4 + actual handshake message len
2487 * (4 is the size of handshake headers for TLS)
2488 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2489 * - ssl->out_msg + 4: the handshake message body
2490 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002491 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002492 * - ssl->out_msglen: the length of the record contents
2493 * (including handshake headers but excluding record headers)
2494 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002495 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002496int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002497{
Janos Follath865b3eb2019-12-16 11:46:15 +00002498 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002499 const size_t hs_len = ssl->out_msglen - 4;
2500 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002501
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002502 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2503
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002504 /*
2505 * Sanity checks
2506 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002507 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002508 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2509 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002510 /* In SSLv3, the client might send a NoCertificate alert. */
2511#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2512 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2513 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2514 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2515#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2516 {
2517 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2518 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2519 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002521
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002522 /* Whenever we send anything different from a
2523 * HelloRequest we should be in a handshake - double check. */
2524 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2525 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002526 ssl->handshake == NULL )
2527 {
2528 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2529 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2530 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002531
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002533 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002534 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002536 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2538 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002539 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002540#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002541
Hanno Beckerb50a2532018-08-06 11:52:54 +01002542 /* Double-check that we did not exceed the bounds
2543 * of the outgoing record buffer.
2544 * This should never fail as the various message
2545 * writing functions must obey the bounds of the
2546 * outgoing record buffer, but better be safe.
2547 *
2548 * Note: We deliberately do not check for the MTU or MFL here.
2549 */
2550 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2551 {
2552 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2553 "size %u, maximum %u",
2554 (unsigned) ssl->out_msglen,
2555 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2556 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2557 }
2558
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002559 /*
2560 * Fill handshake headers
2561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002563 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002564 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2565 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2566 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002567
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002568 /*
2569 * DTLS has additional fields in the Handshake layer,
2570 * between the length field and the actual payload:
2571 * uint16 message_seq;
2572 * uint24 fragment_offset;
2573 * uint24 fragment_length;
2574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002576 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002577 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002578 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002579 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002580 {
2581 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2582 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002583 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002584 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002585 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2586 }
2587
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002588 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002589 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002590
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002591 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002592 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002593 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002594 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2595 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2596 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002597 }
2598 else
2599 {
2600 ssl->out_msg[4] = 0;
2601 ssl->out_msg[5] = 0;
2602 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002603
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002604 /* Handshake hashes are computed without fragmentation,
2605 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002606 memset( ssl->out_msg + 6, 0x00, 3 );
2607 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002608 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002610
Hanno Becker0207e532018-08-28 10:28:28 +01002611 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002612 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2613 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002614 }
2615
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002616 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002618 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002619 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2620 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002621 {
2622 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2623 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002625 return( ret );
2626 }
2627 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002628 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002629#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002630 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002631 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002632 {
2633 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2634 return( ret );
2635 }
2636 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002637
2638 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2639
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002640 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002641}
2642
2643/*
2644 * Record layer functions
2645 */
2646
2647/*
2648 * Write current record.
2649 *
2650 * Uses:
2651 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2652 * - ssl->out_msglen: length of the record content (excl headers)
2653 * - ssl->out_msg: record content
2654 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002655int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002656{
2657 int ret, done = 0;
2658 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002659 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002660
2661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002664 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002666 {
2667 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2668 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002670 return( ret );
2671 }
2672
2673 len = ssl->out_msglen;
2674 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2678 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002679 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002681
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 ret = mbedtls_ssl_hw_record_write( ssl );
2683 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2686 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002687 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002688
2689 if( ret == 0 )
2690 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002691 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002693 if( !done )
2694 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002695 unsigned i;
2696 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002697#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2698 size_t out_buf_len = ssl->out_buf_len;
2699#else
2700 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2701#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002702 /* Skip writing the record content type to after the encryption,
2703 * as it may change when using the CID extension. */
2704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002706 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002707
Hanno Becker19859472018-08-06 09:40:20 +01002708 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002709 ssl->out_len[0] = (unsigned char)( len >> 8 );
2710 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002711
Paul Bakker48916f92012-09-16 19:57:18 +00002712 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002713 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002714 mbedtls_record rec;
2715
2716 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002717 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002718 rec.data_len = ssl->out_msglen;
2719 rec.data_offset = ssl->out_msg - rec.buf;
2720
2721 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2722 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2723 ssl->conf->transport, rec.ver );
2724 rec.type = ssl->out_msgtype;
2725
Hanno Beckera0e20d02019-05-15 14:03:01 +01002726#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002727 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002728 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002729#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002730
Hanno Beckera18d1322018-01-03 14:27:32 +00002731 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002732 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002733 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002735 return( ret );
2736 }
2737
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002738 if( rec.data_offset != 0 )
2739 {
2740 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2741 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2742 }
2743
Hanno Becker6430faf2019-05-08 11:57:13 +01002744 /* Update the record content type and CID. */
2745 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002746#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002747 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002748#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002749 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002750 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2751 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002752 }
2753
Hanno Becker5903de42019-05-03 14:46:38 +01002754 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002755
2756#if defined(MBEDTLS_SSL_PROTO_DTLS)
2757 /* In case of DTLS, double-check that we don't exceed
2758 * the remaining space in the datagram. */
2759 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2760 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002761 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002762 if( ret < 0 )
2763 return( ret );
2764
2765 if( protected_record_size > (size_t) ret )
2766 {
2767 /* Should never happen */
2768 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2769 }
2770 }
2771#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002772
Hanno Becker6430faf2019-05-08 11:57:13 +01002773 /* Now write the potentially updated record content type. */
2774 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002777 "version = [%d:%d], msglen = %d",
2778 ssl->out_hdr[0], ssl->out_hdr[1],
2779 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002780
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002782 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002783
2784 ssl->out_left += protected_record_size;
2785 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002786 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002787
Hanno Beckerdd772292020-02-05 10:38:31 +00002788 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002789 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2790 break;
2791
2792 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002793 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002794 {
2795 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2796 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2797 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002798 }
2799
Hanno Becker67bc7c32018-08-06 11:33:50 +01002800#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002801 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2802 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002803 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002804 size_t remaining;
2805 ret = ssl_get_remaining_payload_in_datagram( ssl );
2806 if( ret < 0 )
2807 {
2808 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2809 ret );
2810 return( ret );
2811 }
2812
2813 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002814 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002815 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002816 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002817 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002818 else
2819 {
Hanno Becker513815a2018-08-20 11:56:09 +01002820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002821 }
2822 }
2823#endif /* MBEDTLS_SSL_PROTO_DTLS */
2824
2825 if( ( flush == SSL_FORCE_FLUSH ) &&
2826 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002827 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002829 return( ret );
2830 }
2831
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002833
2834 return( 0 );
2835}
2836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002838
2839static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2840{
2841 if( ssl->in_msglen < ssl->in_hslen ||
2842 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2843 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2844 {
2845 return( 1 );
2846 }
2847 return( 0 );
2848}
Hanno Becker44650b72018-08-16 12:51:11 +01002849
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002850static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002851{
2852 return( ( ssl->in_msg[9] << 16 ) |
2853 ( ssl->in_msg[10] << 8 ) |
2854 ssl->in_msg[11] );
2855}
2856
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002857static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002858{
2859 return( ( ssl->in_msg[6] << 16 ) |
2860 ( ssl->in_msg[7] << 8 ) |
2861 ssl->in_msg[8] );
2862}
2863
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002864static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002865{
2866 uint32_t msg_len, frag_off, frag_len;
2867
2868 msg_len = ssl_get_hs_total_len( ssl );
2869 frag_off = ssl_get_hs_frag_off( ssl );
2870 frag_len = ssl_get_hs_frag_len( ssl );
2871
2872 if( frag_off > msg_len )
2873 return( -1 );
2874
2875 if( frag_len > msg_len - frag_off )
2876 return( -1 );
2877
2878 if( frag_len + 12 > ssl->in_msglen )
2879 return( -1 );
2880
2881 return( 0 );
2882}
2883
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002884/*
2885 * Mark bits in bitmask (used for DTLS HS reassembly)
2886 */
2887static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2888{
2889 unsigned int start_bits, end_bits;
2890
2891 start_bits = 8 - ( offset % 8 );
2892 if( start_bits != 8 )
2893 {
2894 size_t first_byte_idx = offset / 8;
2895
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002896 /* Special case */
2897 if( len <= start_bits )
2898 {
2899 for( ; len != 0; len-- )
2900 mask[first_byte_idx] |= 1 << ( start_bits - len );
2901
2902 /* Avoid potential issues with offset or len becoming invalid */
2903 return;
2904 }
2905
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002906 offset += start_bits; /* Now offset % 8 == 0 */
2907 len -= start_bits;
2908
2909 for( ; start_bits != 0; start_bits-- )
2910 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2911 }
2912
2913 end_bits = len % 8;
2914 if( end_bits != 0 )
2915 {
2916 size_t last_byte_idx = ( offset + len ) / 8;
2917
2918 len -= end_bits; /* Now len % 8 == 0 */
2919
2920 for( ; end_bits != 0; end_bits-- )
2921 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2922 }
2923
2924 memset( mask + offset / 8, 0xFF, len / 8 );
2925}
2926
2927/*
2928 * Check that bitmask is full
2929 */
2930static int ssl_bitmask_check( unsigned char *mask, size_t len )
2931{
2932 size_t i;
2933
2934 for( i = 0; i < len / 8; i++ )
2935 if( mask[i] != 0xFF )
2936 return( -1 );
2937
2938 for( i = 0; i < len % 8; i++ )
2939 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2940 return( -1 );
2941
2942 return( 0 );
2943}
2944
Hanno Becker56e205e2018-08-16 09:06:12 +01002945/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002946static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002947 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002948{
Hanno Becker56e205e2018-08-16 09:06:12 +01002949 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002950
Hanno Becker56e205e2018-08-16 09:06:12 +01002951 alloc_len = 12; /* Handshake header */
2952 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002953
Hanno Beckerd07df862018-08-16 09:14:58 +01002954 if( add_bitmap )
2955 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002956
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002957 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002958}
Hanno Becker56e205e2018-08-16 09:06:12 +01002959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002961
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002962static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002963{
2964 return( ( ssl->in_msg[1] << 16 ) |
2965 ( ssl->in_msg[2] << 8 ) |
2966 ssl->in_msg[3] );
2967}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002968
Simon Butcher99000142016-10-13 17:21:01 +01002969int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002970{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002972 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002974 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002976 }
2977
Hanno Becker12555c62018-08-16 12:47:53 +01002978 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002979
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002981 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002982 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002985 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002986 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002987 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002988 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002989
Hanno Becker44650b72018-08-16 12:51:11 +01002990 if( ssl_check_hs_header( ssl ) != 0 )
2991 {
2992 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2993 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2994 }
2995
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002996 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002997 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2998 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2999 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3000 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003001 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003002 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3003 {
3004 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3005 recv_msg_seq,
3006 ssl->handshake->in_msg_seq ) );
3007 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3008 }
3009
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003010 /* Retransmit only on last message from previous flight, to avoid
3011 * too many retransmissions.
3012 * Besides, No sane server ever retransmits HelloVerifyRequest */
3013 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003015 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003017 "message_seq = %d, start_of_flight = %d",
3018 recv_msg_seq,
3019 ssl->handshake->in_flight_start_seq ) );
3020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003024 return( ret );
3025 }
3026 }
3027 else
3028 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003030 "message_seq = %d, expected = %d",
3031 recv_msg_seq,
3032 ssl->handshake->in_msg_seq ) );
3033 }
3034
Hanno Becker90333da2017-10-10 11:27:13 +01003035 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003036 }
3037 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003038
Hanno Becker6d97ef52018-08-16 13:09:04 +01003039 /* Message reassembly is handled alongside buffering of future
3040 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003041 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003042 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003043 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003044 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003046 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003047 }
3048 }
3049 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003051 /* With TLS we don't handle fragmentation (for now) */
3052 if( ssl->in_msglen < ssl->in_hslen )
3053 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3055 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003056 }
3057
Simon Butcher99000142016-10-13 17:21:01 +01003058 return( 0 );
3059}
3060
3061void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3062{
Hanno Becker0271f962018-08-16 13:23:47 +01003063 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003064
Hanno Becker0271f962018-08-16 13:23:47 +01003065 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003066 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003067 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003068 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003069
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003070 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003072 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003073 ssl->handshake != NULL )
3074 {
Hanno Becker0271f962018-08-16 13:23:47 +01003075 unsigned offset;
3076 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003077
Hanno Becker0271f962018-08-16 13:23:47 +01003078 /* Increment handshake sequence number */
3079 hs->in_msg_seq++;
3080
3081 /*
3082 * Clear up handshake buffering and reassembly structure.
3083 */
3084
3085 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003086 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003087
3088 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003089 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3090 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003091 offset++, hs_buf++ )
3092 {
3093 *hs_buf = *(hs_buf + 1);
3094 }
3095
3096 /* Create a fresh last entry */
3097 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003098 }
3099#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003100}
3101
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003102/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003103 * DTLS anti-replay: RFC 6347 4.1.2.6
3104 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003105 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3106 * Bit n is set iff record number in_window_top - n has been seen.
3107 *
3108 * Usually, in_window_top is the last record number seen and the lsb of
3109 * in_window is set. The only exception is the initial state (record number 0
3110 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003111 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003113void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003114{
3115 ssl->in_window_top = 0;
3116 ssl->in_window = 0;
3117}
3118
3119static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3120{
3121 return( ( (uint64_t) buf[0] << 40 ) |
3122 ( (uint64_t) buf[1] << 32 ) |
3123 ( (uint64_t) buf[2] << 24 ) |
3124 ( (uint64_t) buf[3] << 16 ) |
3125 ( (uint64_t) buf[4] << 8 ) |
3126 ( (uint64_t) buf[5] ) );
3127}
3128
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003129static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3130{
Janos Follath865b3eb2019-12-16 11:46:15 +00003131 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003132 unsigned char *original_in_ctr;
3133
3134 // save original in_ctr
3135 original_in_ctr = ssl->in_ctr;
3136
3137 // use counter from record
3138 ssl->in_ctr = record_in_ctr;
3139
3140 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3141
3142 // restore the counter
3143 ssl->in_ctr = original_in_ctr;
3144
3145 return ret;
3146}
3147
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003148/*
3149 * Return 0 if sequence number is acceptable, -1 otherwise
3150 */
Hanno Becker0183d692019-07-12 08:50:37 +01003151int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003152{
3153 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3154 uint64_t bit;
3155
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003156 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003157 return( 0 );
3158
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003159 if( rec_seqnum > ssl->in_window_top )
3160 return( 0 );
3161
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003162 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003163
3164 if( bit >= 64 )
3165 return( -1 );
3166
3167 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3168 return( -1 );
3169
3170 return( 0 );
3171}
3172
3173/*
3174 * Update replay window on new validated record
3175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003177{
3178 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3179
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003180 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003181 return;
3182
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003183 if( rec_seqnum > ssl->in_window_top )
3184 {
3185 /* Update window_top and the contents of the window */
3186 uint64_t shift = rec_seqnum - ssl->in_window_top;
3187
3188 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003189 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003190 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003191 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003192 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003193 ssl->in_window |= 1;
3194 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003195
3196 ssl->in_window_top = rec_seqnum;
3197 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003198 else
3199 {
3200 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003201 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003202
3203 if( bit < 64 ) /* Always true, but be extra sure */
3204 ssl->in_window |= (uint64_t) 1 << bit;
3205 }
3206}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003208
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003209#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003210/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003211 * Without any SSL context, check if a datagram looks like a ClientHello with
3212 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003213 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003214 *
3215 * - if cookie is valid, return 0
3216 * - if ClientHello looks superficially valid but cookie is not,
3217 * fill obuf and set olen, then
3218 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3219 * - otherwise return a specific error code
3220 */
3221static int ssl_check_dtls_clihlo_cookie(
3222 mbedtls_ssl_cookie_write_t *f_cookie_write,
3223 mbedtls_ssl_cookie_check_t *f_cookie_check,
3224 void *p_cookie,
3225 const unsigned char *cli_id, size_t cli_id_len,
3226 const unsigned char *in, size_t in_len,
3227 unsigned char *obuf, size_t buf_len, size_t *olen )
3228{
3229 size_t sid_len, cookie_len;
3230 unsigned char *p;
3231
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003232 /*
3233 * Structure of ClientHello with record and handshake headers,
3234 * and expected values. We don't need to check a lot, more checks will be
3235 * done when actually parsing the ClientHello - skipping those checks
3236 * avoids code duplication and does not make cookie forging any easier.
3237 *
3238 * 0-0 ContentType type; copied, must be handshake
3239 * 1-2 ProtocolVersion version; copied
3240 * 3-4 uint16 epoch; copied, must be 0
3241 * 5-10 uint48 sequence_number; copied
3242 * 11-12 uint16 length; (ignored)
3243 *
3244 * 13-13 HandshakeType msg_type; (ignored)
3245 * 14-16 uint24 length; (ignored)
3246 * 17-18 uint16 message_seq; copied
3247 * 19-21 uint24 fragment_offset; copied, must be 0
3248 * 22-24 uint24 fragment_length; (ignored)
3249 *
3250 * 25-26 ProtocolVersion client_version; (ignored)
3251 * 27-58 Random random; (ignored)
3252 * 59-xx SessionID session_id; 1 byte len + sid_len content
3253 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3254 * ...
3255 *
3256 * Minimum length is 61 bytes.
3257 */
3258 if( in_len < 61 ||
3259 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3260 in[3] != 0 || in[4] != 0 ||
3261 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3262 {
3263 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3264 }
3265
3266 sid_len = in[59];
3267 if( sid_len > in_len - 61 )
3268 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3269
3270 cookie_len = in[60 + sid_len];
3271 if( cookie_len > in_len - 60 )
3272 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3273
3274 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3275 cli_id, cli_id_len ) == 0 )
3276 {
3277 /* Valid cookie */
3278 return( 0 );
3279 }
3280
3281 /*
3282 * If we get here, we've got an invalid cookie, let's prepare HVR.
3283 *
3284 * 0-0 ContentType type; copied
3285 * 1-2 ProtocolVersion version; copied
3286 * 3-4 uint16 epoch; copied
3287 * 5-10 uint48 sequence_number; copied
3288 * 11-12 uint16 length; olen - 13
3289 *
3290 * 13-13 HandshakeType msg_type; hello_verify_request
3291 * 14-16 uint24 length; olen - 25
3292 * 17-18 uint16 message_seq; copied
3293 * 19-21 uint24 fragment_offset; copied
3294 * 22-24 uint24 fragment_length; olen - 25
3295 *
3296 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3297 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3298 *
3299 * Minimum length is 28.
3300 */
3301 if( buf_len < 28 )
3302 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3303
3304 /* Copy most fields and adapt others */
3305 memcpy( obuf, in, 25 );
3306 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3307 obuf[25] = 0xfe;
3308 obuf[26] = 0xff;
3309
3310 /* Generate and write actual cookie */
3311 p = obuf + 28;
3312 if( f_cookie_write( p_cookie,
3313 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3314 {
3315 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3316 }
3317
3318 *olen = p - obuf;
3319
3320 /* Go back and fill length fields */
3321 obuf[27] = (unsigned char)( *olen - 28 );
3322
3323 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3324 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3325 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3326
3327 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3328 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3329
3330 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3331}
3332
3333/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003334 * Handle possible client reconnect with the same UDP quadruplet
3335 * (RFC 6347 Section 4.2.8).
3336 *
3337 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3338 * that looks like a ClientHello.
3339 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003340 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003341 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003342 * - if the input looks like a ClientHello with a valid cookie,
3343 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003344 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003345 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003346 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003347 * This function is called (through ssl_check_client_reconnect()) when an
3348 * unexpected record is found in ssl_get_next_record(), which will discard the
3349 * record if we return 0, and bubble up the return value otherwise (this
3350 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3351 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003352 */
3353static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3354{
Janos Follath865b3eb2019-12-16 11:46:15 +00003355 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003356 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003357
Hanno Becker2fddd372019-07-10 14:37:41 +01003358 if( ssl->conf->f_cookie_write == NULL ||
3359 ssl->conf->f_cookie_check == NULL )
3360 {
3361 /* If we can't use cookies to verify reachability of the peer,
3362 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003363 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3364 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003365 return( 0 );
3366 }
3367
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003368 ret = ssl_check_dtls_clihlo_cookie(
3369 ssl->conf->f_cookie_write,
3370 ssl->conf->f_cookie_check,
3371 ssl->conf->p_cookie,
3372 ssl->cli_id, ssl->cli_id_len,
3373 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003374 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003375
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003376 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3377
3378 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003379 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003380 int send_ret;
3381 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3382 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3383 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003384 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003385 * If the error is permanent we'll catch it later,
3386 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003387 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3388 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3389 (void) send_ret;
3390
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003391 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003392 }
3393
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003394 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003395 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003397 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003398 {
3399 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3400 return( ret );
3401 }
3402
3403 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003404 }
3405
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003406 return( ret );
3407}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003408#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003409
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003410static int ssl_check_record_type( uint8_t record_type )
3411{
3412 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3413 record_type != MBEDTLS_SSL_MSG_ALERT &&
3414 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3415 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3416 {
3417 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3418 }
3419
3420 return( 0 );
3421}
3422
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003423/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003424 * ContentType type;
3425 * ProtocolVersion version;
3426 * uint16 epoch; // DTLS only
3427 * uint48 sequence_number; // DTLS only
3428 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003429 *
3430 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003431 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003432 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3433 *
3434 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003435 * 1. proceed with the record if this function returns 0
3436 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3437 * 3. return CLIENT_RECONNECT if this function return that value
3438 * 4. drop the whole datagram if this function returns anything else.
3439 * Point 2 is needed when the peer is resending, and we have already received
3440 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003441 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003442static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003443 unsigned char *buf,
3444 size_t len,
3445 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003446{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003447 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003448
Hanno Beckere5e7e782019-07-11 12:29:35 +01003449 size_t const rec_hdr_type_offset = 0;
3450 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003451
Hanno Beckere5e7e782019-07-11 12:29:35 +01003452 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3453 rec_hdr_type_len;
3454 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003455
Hanno Beckere5e7e782019-07-11 12:29:35 +01003456 size_t const rec_hdr_ctr_len = 8;
3457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003458 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003459 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3460 rec_hdr_version_len;
3461
Hanno Beckera0e20d02019-05-15 14:03:01 +01003462#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003463 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3464 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003465 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003466#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3467#endif /* MBEDTLS_SSL_PROTO_DTLS */
3468
3469 size_t rec_hdr_len_offset; /* To be determined */
3470 size_t const rec_hdr_len_len = 2;
3471
3472 /*
3473 * Check minimum lengths for record header.
3474 */
3475
3476#if defined(MBEDTLS_SSL_PROTO_DTLS)
3477 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3478 {
3479 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3480 }
3481 else
3482#endif /* MBEDTLS_SSL_PROTO_DTLS */
3483 {
3484 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3485 }
3486
3487 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3488 {
3489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3490 (unsigned) len,
3491 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3492 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3493 }
3494
3495 /*
3496 * Parse and validate record content type
3497 */
3498
3499 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003500
3501 /* Check record content type */
3502#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3503 rec->cid_len = 0;
3504
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003505 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003506 ssl->conf->cid_len != 0 &&
3507 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003508 {
3509 /* Shift pointers to account for record header including CID
3510 * struct {
3511 * ContentType special_type = tls12_cid;
3512 * ProtocolVersion version;
3513 * uint16 epoch;
3514 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003515 * opaque cid[cid_length]; // Additional field compared to
3516 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003517 * uint16 length;
3518 * opaque enc_content[DTLSCiphertext.length];
3519 * } DTLSCiphertext;
3520 */
3521
3522 /* So far, we only support static CID lengths
3523 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524 rec_hdr_cid_len = ssl->conf->cid_len;
3525 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003526
Hanno Beckere5e7e782019-07-11 12:29:35 +01003527 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003528 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003529 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3530 (unsigned) len,
3531 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003532 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003533 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003534
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003535 /* configured CID len is guaranteed at most 255, see
3536 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3537 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003538 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003539 }
3540 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003541#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003542 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003543 if( ssl_check_record_type( rec->type ) )
3544 {
Hanno Becker54229812019-07-12 14:40:00 +01003545 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3546 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003547 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3548 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003549 }
3550
Hanno Beckere5e7e782019-07-11 12:29:35 +01003551 /*
3552 * Parse and validate record version
3553 */
3554
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003555 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3556 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003557 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3558 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003559 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003560
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003561 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3564 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003565 }
3566
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003567 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003568 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3570 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003571 }
3572
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 /*
3574 * Parse/Copy record sequence number.
3575 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003576
Hanno Beckere5e7e782019-07-11 12:29:35 +01003577#if defined(MBEDTLS_SSL_PROTO_DTLS)
3578 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003579 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580 /* Copy explicit record sequence number from input buffer. */
3581 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3582 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003583 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003584 else
3585#endif /* MBEDTLS_SSL_PROTO_DTLS */
3586 {
3587 /* Copy implicit record sequence number from SSL context structure. */
3588 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3589 }
Paul Bakker40e46942009-01-03 21:51:57 +00003590
Hanno Beckere5e7e782019-07-11 12:29:35 +01003591 /*
3592 * Parse record length.
3593 */
3594
Hanno Beckere5e7e782019-07-11 12:29:35 +01003595 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003596 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3597 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003598 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003599
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003600 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003601 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003602 rec->type,
3603 major_ver, minor_ver, rec->data_len ) );
3604
3605 rec->buf = buf;
3606 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003607
Hanno Beckerd417cc92019-07-26 08:20:27 +01003608 if( rec->data_len == 0 )
3609 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003610
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003611 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003612 * DTLS-related tests.
3613 * Check epoch before checking length constraint because
3614 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3615 * message gets duplicated before the corresponding Finished message,
3616 * the second ChangeCipherSpec should be discarded because it belongs
3617 * to an old epoch, but not because its length is shorter than
3618 * the minimum record length for packets using the new record transform.
3619 * Note that these two kinds of failures are handled differently,
3620 * as an unexpected record is silently skipped but an invalid
3621 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003622 */
3623#if defined(MBEDTLS_SSL_PROTO_DTLS)
3624 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3625 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003626 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003627
Hanno Becker955a5c92019-07-10 17:12:07 +01003628 /* Check that the datagram is large enough to contain a record
3629 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003630 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003631 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003632 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3633 (unsigned) len,
3634 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003635 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3636 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003637
Hanno Becker37cfe732019-07-10 17:20:01 +01003638 /* Records from other, non-matching epochs are silently discarded.
3639 * (The case of same-port Client reconnects must be considered in
3640 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003641 if( rec_epoch != ssl->in_epoch )
3642 {
3643 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3644 "expected %d, received %d",
3645 ssl->in_epoch, rec_epoch ) );
3646
Hanno Becker552f7472019-07-19 10:59:12 +01003647 /* Records from the next epoch are considered for buffering
3648 * (concretely: early Finished messages). */
3649 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003650 {
Hanno Becker552f7472019-07-19 10:59:12 +01003651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3652 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003653 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003654
Hanno Becker2fddd372019-07-10 14:37:41 +01003655 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003656 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003657#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003658 /* For records from the correct epoch, check whether their
3659 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003660 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3661 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003662 {
3663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3664 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3665 }
3666#endif
3667 }
3668#endif /* MBEDTLS_SSL_PROTO_DTLS */
3669
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003670 return( 0 );
3671}
Paul Bakker5121ce52009-01-03 21:22:43 +00003672
Paul Bakker5121ce52009-01-03 21:22:43 +00003673
Hanno Becker2fddd372019-07-10 14:37:41 +01003674#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3675static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3676{
3677 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3678
3679 /*
3680 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3681 * access the first byte of record content (handshake type), as we
3682 * have an active transform (possibly iv_len != 0), so use the
3683 * fact that the record header len is 13 instead.
3684 */
3685 if( rec_epoch == 0 &&
3686 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3687 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3688 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3689 ssl->in_left > 13 &&
3690 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3691 {
3692 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3693 "from the same port" ) );
3694 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003695 }
3696
3697 return( 0 );
3698}
Hanno Becker2fddd372019-07-10 14:37:41 +01003699#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003700
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003701/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003702 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003703 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003704static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3705 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003706{
3707 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003710 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003711
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3713 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003714 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003715 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003717 ret = mbedtls_ssl_hw_record_read( ssl );
3718 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003719 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003720 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3721 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003722 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003723
3724 if( ret == 0 )
3725 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003726 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003728 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003729 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003730 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003731
Hanno Beckera18d1322018-01-03 14:27:32 +00003732 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003733 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003734 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003735 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003736
Hanno Beckera0e20d02019-05-15 14:03:01 +01003737#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003738 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3739 ssl->conf->ignore_unexpected_cid
3740 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3741 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003742 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003743 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003744 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003745#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003746
Paul Bakker5121ce52009-01-03 21:22:43 +00003747 return( ret );
3748 }
3749
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003750 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003751 {
3752 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003753 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003754 }
3755
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003756 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003757 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003758
Hanno Beckera0e20d02019-05-15 14:03:01 +01003759#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003760 /* We have already checked the record content type
3761 * in ssl_parse_record_header(), failing or silently
3762 * dropping the record in the case of an unknown type.
3763 *
3764 * Since with the use of CIDs, the record content type
3765 * might change during decryption, re-check the record
3766 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003767 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003768 {
3769 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3770 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3771 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003772#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003773
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003774 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003775 {
3776#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3777 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003778 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003779 {
3780 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3782 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3783 }
3784#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3785
3786 ssl->nb_zero++;
3787
3788 /*
3789 * Three or more empty messages may be a DoS attack
3790 * (excessive CPU consumption).
3791 */
3792 if( ssl->nb_zero > 3 )
3793 {
3794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003795 "messages, possible DoS attack" ) );
3796 /* Treat the records as if they were not properly authenticated,
3797 * thereby failing the connection if we see more than allowed
3798 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003799 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3800 }
3801 }
3802 else
3803 ssl->nb_zero = 0;
3804
3805#if defined(MBEDTLS_SSL_PROTO_DTLS)
3806 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3807 {
3808 ; /* in_ctr read from peer, not maintained internally */
3809 }
3810 else
3811#endif
3812 {
3813 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003814 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003815 if( ++ssl->in_ctr[i - 1] != 0 )
3816 break;
3817
3818 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003819 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003820 {
3821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3822 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3823 }
3824 }
3825
Paul Bakker5121ce52009-01-03 21:22:43 +00003826 }
3827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003828#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003829 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003831 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003832 }
3833#endif
3834
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003835 /* Check actual (decrypted) record content length against
3836 * configured maximum. */
3837 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3838 {
3839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3840 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3841 }
3842
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003843 return( 0 );
3844}
3845
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003846/*
3847 * Read a record.
3848 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003849 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3850 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3851 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003852 */
Hanno Becker1097b342018-08-15 14:09:41 +01003853
3854/* Helper functions for mbedtls_ssl_read_record(). */
3855static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003856static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3857static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003858
Hanno Becker327c93b2018-08-15 13:56:18 +01003859int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003860 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003861{
Janos Follath865b3eb2019-12-16 11:46:15 +00003862 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003863
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003864 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003865
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003866 if( ssl->keep_current_message == 0 )
3867 {
3868 do {
Simon Butcher99000142016-10-13 17:21:01 +01003869
Hanno Becker26994592018-08-15 14:14:59 +01003870 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003871 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003872 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003873
Hanno Beckere74d5562018-08-15 14:26:08 +01003874 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003875 {
Hanno Becker40f50842018-08-15 14:48:01 +01003876#if defined(MBEDTLS_SSL_PROTO_DTLS)
3877 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003878
Hanno Becker40f50842018-08-15 14:48:01 +01003879 /* We only check for buffered messages if the
3880 * current datagram is fully consumed. */
3881 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003882 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003883 {
Hanno Becker40f50842018-08-15 14:48:01 +01003884 if( ssl_load_buffered_message( ssl ) == 0 )
3885 have_buffered = 1;
3886 }
3887
3888 if( have_buffered == 0 )
3889#endif /* MBEDTLS_SSL_PROTO_DTLS */
3890 {
3891 ret = ssl_get_next_record( ssl );
3892 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3893 continue;
3894
3895 if( ret != 0 )
3896 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003897 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003898 return( ret );
3899 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003900 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003901 }
3902
3903 ret = mbedtls_ssl_handle_message_type( ssl );
3904
Hanno Becker40f50842018-08-15 14:48:01 +01003905#if defined(MBEDTLS_SSL_PROTO_DTLS)
3906 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3907 {
3908 /* Buffer future message */
3909 ret = ssl_buffer_message( ssl );
3910 if( ret != 0 )
3911 return( ret );
3912
3913 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3914 }
3915#endif /* MBEDTLS_SSL_PROTO_DTLS */
3916
Hanno Becker90333da2017-10-10 11:27:13 +01003917 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3918 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003919
3920 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003921 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003922 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003923 return( ret );
3924 }
3925
Hanno Becker327c93b2018-08-15 13:56:18 +01003926 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003927 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003928 {
3929 mbedtls_ssl_update_handshake_status( ssl );
3930 }
Simon Butcher99000142016-10-13 17:21:01 +01003931 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003932 else
Simon Butcher99000142016-10-13 17:21:01 +01003933 {
Hanno Becker02f59072018-08-15 14:00:24 +01003934 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003935 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003936 }
3937
3938 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3939
3940 return( 0 );
3941}
3942
Hanno Becker40f50842018-08-15 14:48:01 +01003943#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003944static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003945{
Hanno Becker40f50842018-08-15 14:48:01 +01003946 if( ssl->in_left > ssl->next_record_offset )
3947 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003948
Hanno Becker40f50842018-08-15 14:48:01 +01003949 return( 0 );
3950}
3951
3952static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3953{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003954 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003955 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003956 int ret = 0;
3957
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003958 if( hs == NULL )
3959 return( -1 );
3960
Hanno Beckere00ae372018-08-20 09:39:42 +01003961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3962
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003963 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3964 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3965 {
3966 /* Check if we have seen a ChangeCipherSpec before.
3967 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003968 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003969 {
3970 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3971 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003972 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003973 }
3974
Hanno Becker39b8bc92018-08-28 17:17:13 +01003975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003976 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3977 ssl->in_msglen = 1;
3978 ssl->in_msg[0] = 1;
3979
3980 /* As long as they are equal, the exact value doesn't matter. */
3981 ssl->in_left = 0;
3982 ssl->next_record_offset = 0;
3983
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003984 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003985 goto exit;
3986 }
Hanno Becker37f95322018-08-16 13:55:32 +01003987
Hanno Beckerb8f50142018-08-28 10:01:34 +01003988#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003989 /* Debug only */
3990 {
3991 unsigned offset;
3992 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3993 {
3994 hs_buf = &hs->buffering.hs[offset];
3995 if( hs_buf->is_valid == 1 )
3996 {
3997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3998 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003999 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004000 }
4001 }
4002 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004003#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004004
4005 /* Check if we have buffered and/or fully reassembled the
4006 * next handshake message. */
4007 hs_buf = &hs->buffering.hs[0];
4008 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4009 {
4010 /* Synthesize a record containing the buffered HS message. */
4011 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4012 ( hs_buf->data[2] << 8 ) |
4013 hs_buf->data[3];
4014
4015 /* Double-check that we haven't accidentally buffered
4016 * a message that doesn't fit into the input buffer. */
4017 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4018 {
4019 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4020 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4021 }
4022
4023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4024 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4025 hs_buf->data, msg_len + 12 );
4026
4027 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4028 ssl->in_hslen = msg_len + 12;
4029 ssl->in_msglen = msg_len + 12;
4030 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4031
4032 ret = 0;
4033 goto exit;
4034 }
4035 else
4036 {
4037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4038 hs->in_msg_seq ) );
4039 }
4040
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004041 ret = -1;
4042
4043exit:
4044
4045 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4046 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004047}
4048
Hanno Beckera02b0b42018-08-21 17:20:27 +01004049static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4050 size_t desired )
4051{
4052 int offset;
4053 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4055 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004056
Hanno Becker01315ea2018-08-21 17:22:17 +01004057 /* Get rid of future records epoch first, if such exist. */
4058 ssl_free_buffered_record( ssl );
4059
4060 /* Check if we have enough space available now. */
4061 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4062 hs->buffering.total_bytes_buffered ) )
4063 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004065 return( 0 );
4066 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004067
Hanno Becker4f432ad2018-08-28 10:02:32 +01004068 /* We don't have enough space to buffer the next expected handshake
4069 * message. Remove buffers used for future messages to gain space,
4070 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004071 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4072 offset >= 0; offset-- )
4073 {
4074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4075 offset ) );
4076
Hanno Beckerb309b922018-08-23 13:18:05 +01004077 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004078
4079 /* Check if we have enough space available now. */
4080 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4081 hs->buffering.total_bytes_buffered ) )
4082 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004083 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004084 return( 0 );
4085 }
4086 }
4087
4088 return( -1 );
4089}
4090
Hanno Becker40f50842018-08-15 14:48:01 +01004091static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4092{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004093 int ret = 0;
4094 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4095
4096 if( hs == NULL )
4097 return( 0 );
4098
4099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4100
4101 switch( ssl->in_msgtype )
4102 {
4103 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4104 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004105
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004106 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004107 break;
4108
4109 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004110 {
4111 unsigned recv_msg_seq_offset;
4112 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4113 mbedtls_ssl_hs_buffer *hs_buf;
4114 size_t msg_len = ssl->in_hslen - 12;
4115
4116 /* We should never receive an old handshake
4117 * message - double-check nonetheless. */
4118 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4119 {
4120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4121 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4122 }
4123
4124 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4125 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4126 {
4127 /* Silently ignore -- message too far in the future */
4128 MBEDTLS_SSL_DEBUG_MSG( 2,
4129 ( "Ignore future HS message with sequence number %u, "
4130 "buffering window %u - %u",
4131 recv_msg_seq, ssl->handshake->in_msg_seq,
4132 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4133
4134 goto exit;
4135 }
4136
4137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4138 recv_msg_seq, recv_msg_seq_offset ) );
4139
4140 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4141
4142 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004143 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004144 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004145 size_t reassembly_buf_sz;
4146
Hanno Becker37f95322018-08-16 13:55:32 +01004147 hs_buf->is_fragmented =
4148 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4149
4150 /* We copy the message back into the input buffer
4151 * after reassembly, so check that it's not too large.
4152 * This is an implementation-specific limitation
4153 * and not one from the standard, hence it is not
4154 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004155 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004156 {
4157 /* Ignore message */
4158 goto exit;
4159 }
4160
Hanno Beckere0b150f2018-08-21 15:51:03 +01004161 /* Check if we have enough space to buffer the message. */
4162 if( hs->buffering.total_bytes_buffered >
4163 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4164 {
4165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4166 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4167 }
4168
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004169 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4170 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004171
4172 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4173 hs->buffering.total_bytes_buffered ) )
4174 {
4175 if( recv_msg_seq_offset > 0 )
4176 {
4177 /* If we can't buffer a future message because
4178 * of space limitations -- ignore. */
4179 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",
4180 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4181 (unsigned) hs->buffering.total_bytes_buffered ) );
4182 goto exit;
4183 }
Hanno Beckere1801392018-08-21 16:51:05 +01004184 else
4185 {
4186 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",
4187 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4188 (unsigned) hs->buffering.total_bytes_buffered ) );
4189 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004190
Hanno Beckera02b0b42018-08-21 17:20:27 +01004191 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004192 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004193 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",
4194 (unsigned) msg_len,
4195 (unsigned) reassembly_buf_sz,
4196 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004197 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004198 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4199 goto exit;
4200 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004201 }
4202
4203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4204 msg_len ) );
4205
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004206 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4207 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004208 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004209 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004210 goto exit;
4211 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004212 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004213
4214 /* Prepare final header: copy msg_type, length and message_seq,
4215 * then add standardised fragment_offset and fragment_length */
4216 memcpy( hs_buf->data, ssl->in_msg, 6 );
4217 memset( hs_buf->data + 6, 0, 3 );
4218 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4219
4220 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004221
4222 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004223 }
4224 else
4225 {
4226 /* Make sure msg_type and length are consistent */
4227 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4228 {
4229 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4230 /* Ignore */
4231 goto exit;
4232 }
4233 }
4234
Hanno Becker4422bbb2018-08-20 09:40:19 +01004235 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004236 {
4237 size_t frag_len, frag_off;
4238 unsigned char * const msg = hs_buf->data + 12;
4239
4240 /*
4241 * Check and copy current fragment
4242 */
4243
4244 /* Validation of header fields already done in
4245 * mbedtls_ssl_prepare_handshake_record(). */
4246 frag_off = ssl_get_hs_frag_off( ssl );
4247 frag_len = ssl_get_hs_frag_len( ssl );
4248
4249 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4250 frag_off, frag_len ) );
4251 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4252
4253 if( hs_buf->is_fragmented )
4254 {
4255 unsigned char * const bitmask = msg + msg_len;
4256 ssl_bitmask_set( bitmask, frag_off, frag_len );
4257 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4258 msg_len ) == 0 );
4259 }
4260 else
4261 {
4262 hs_buf->is_complete = 1;
4263 }
4264
4265 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4266 hs_buf->is_complete ? "" : "not yet " ) );
4267 }
4268
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004269 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004270 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004271
4272 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004273 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004274 break;
4275 }
4276
4277exit:
4278
4279 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4280 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004281}
4282#endif /* MBEDTLS_SSL_PROTO_DTLS */
4283
Hanno Becker1097b342018-08-15 14:09:41 +01004284static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004285{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004286 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004287 * Consume last content-layer message and potentially
4288 * update in_msglen which keeps track of the contents'
4289 * consumption state.
4290 *
4291 * (1) Handshake messages:
4292 * Remove last handshake message, move content
4293 * and adapt in_msglen.
4294 *
4295 * (2) Alert messages:
4296 * Consume whole record content, in_msglen = 0.
4297 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004298 * (3) Change cipher spec:
4299 * Consume whole record content, in_msglen = 0.
4300 *
4301 * (4) Application data:
4302 * Don't do anything - the record layer provides
4303 * the application data as a stream transport
4304 * and consumes through mbedtls_ssl_read only.
4305 *
4306 */
4307
4308 /* Case (1): Handshake messages */
4309 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004310 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004311 /* Hard assertion to be sure that no application data
4312 * is in flight, as corrupting ssl->in_msglen during
4313 * ssl->in_offt != NULL is fatal. */
4314 if( ssl->in_offt != NULL )
4315 {
4316 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4317 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4318 }
4319
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004320 /*
4321 * Get next Handshake message in the current record
4322 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004323
Hanno Becker4a810fb2017-05-24 16:27:30 +01004324 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004325 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004326 * current handshake content: If DTLS handshake
4327 * fragmentation is used, that's the fragment
4328 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004329 * size here is faulty and should be changed at
4330 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004331 * (2) While it doesn't seem to cause problems, one
4332 * has to be very careful not to assume that in_hslen
4333 * is always <= in_msglen in a sensible communication.
4334 * Again, it's wrong for DTLS handshake fragmentation.
4335 * The following check is therefore mandatory, and
4336 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004337 * Additionally, ssl->in_hslen might be arbitrarily out of
4338 * bounds after handling a DTLS message with an unexpected
4339 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004340 */
4341 if( ssl->in_hslen < ssl->in_msglen )
4342 {
4343 ssl->in_msglen -= ssl->in_hslen;
4344 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4345 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004346
Hanno Becker4a810fb2017-05-24 16:27:30 +01004347 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4348 ssl->in_msg, ssl->in_msglen );
4349 }
4350 else
4351 {
4352 ssl->in_msglen = 0;
4353 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004354
Hanno Becker4a810fb2017-05-24 16:27:30 +01004355 ssl->in_hslen = 0;
4356 }
4357 /* Case (4): Application data */
4358 else if( ssl->in_offt != NULL )
4359 {
4360 return( 0 );
4361 }
4362 /* Everything else (CCS & Alerts) */
4363 else
4364 {
4365 ssl->in_msglen = 0;
4366 }
4367
Hanno Becker1097b342018-08-15 14:09:41 +01004368 return( 0 );
4369}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004370
Hanno Beckere74d5562018-08-15 14:26:08 +01004371static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4372{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004373 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004374 return( 1 );
4375
4376 return( 0 );
4377}
4378
Hanno Becker5f066e72018-08-16 14:56:31 +01004379#if defined(MBEDTLS_SSL_PROTO_DTLS)
4380
4381static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4382{
4383 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4384 if( hs == NULL )
4385 return;
4386
Hanno Becker01315ea2018-08-21 17:22:17 +01004387 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004388 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004389 hs->buffering.total_bytes_buffered -=
4390 hs->buffering.future_record.len;
4391
4392 mbedtls_free( hs->buffering.future_record.data );
4393 hs->buffering.future_record.data = NULL;
4394 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004395}
4396
4397static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4398{
4399 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4400 unsigned char * rec;
4401 size_t rec_len;
4402 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004403#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4404 size_t in_buf_len = ssl->in_buf_len;
4405#else
4406 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4407#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004408 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4409 return( 0 );
4410
4411 if( hs == NULL )
4412 return( 0 );
4413
Hanno Becker5f066e72018-08-16 14:56:31 +01004414 rec = hs->buffering.future_record.data;
4415 rec_len = hs->buffering.future_record.len;
4416 rec_epoch = hs->buffering.future_record.epoch;
4417
4418 if( rec == NULL )
4419 return( 0 );
4420
Hanno Becker4cb782d2018-08-20 11:19:05 +01004421 /* Only consider loading future records if the
4422 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004423 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004424 return( 0 );
4425
Hanno Becker5f066e72018-08-16 14:56:31 +01004426 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4427
4428 if( rec_epoch != ssl->in_epoch )
4429 {
4430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4431 goto exit;
4432 }
4433
4434 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4435
4436 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004437 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004438 {
4439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4440 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4441 }
4442
4443 memcpy( ssl->in_hdr, rec, rec_len );
4444 ssl->in_left = rec_len;
4445 ssl->next_record_offset = 0;
4446
4447 ssl_free_buffered_record( ssl );
4448
4449exit:
4450 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4451 return( 0 );
4452}
4453
Hanno Becker519f15d2019-07-11 12:43:20 +01004454static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4455 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004456{
4457 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004458
4459 /* Don't buffer future records outside handshakes. */
4460 if( hs == NULL )
4461 return( 0 );
4462
4463 /* Only buffer handshake records (we are only interested
4464 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004465 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004466 return( 0 );
4467
4468 /* Don't buffer more than one future epoch record. */
4469 if( hs->buffering.future_record.data != NULL )
4470 return( 0 );
4471
Hanno Becker01315ea2018-08-21 17:22:17 +01004472 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004473 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004474 hs->buffering.total_bytes_buffered ) )
4475 {
4476 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 +01004477 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004478 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004479 return( 0 );
4480 }
4481
Hanno Becker5f066e72018-08-16 14:56:31 +01004482 /* Buffer record */
4483 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4484 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004485 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004486
4487 /* ssl_parse_record_header() only considers records
4488 * of the next epoch as candidates for buffering. */
4489 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004490 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004491
4492 hs->buffering.future_record.data =
4493 mbedtls_calloc( 1, hs->buffering.future_record.len );
4494 if( hs->buffering.future_record.data == NULL )
4495 {
4496 /* If we run out of RAM trying to buffer a
4497 * record from the next epoch, just ignore. */
4498 return( 0 );
4499 }
4500
Hanno Becker519f15d2019-07-11 12:43:20 +01004501 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004502
Hanno Becker519f15d2019-07-11 12:43:20 +01004503 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004504 return( 0 );
4505}
4506
4507#endif /* MBEDTLS_SSL_PROTO_DTLS */
4508
Hanno Beckere74d5562018-08-15 14:26:08 +01004509static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004510{
Janos Follath865b3eb2019-12-16 11:46:15 +00004511 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004512 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004513
Hanno Becker5f066e72018-08-16 14:56:31 +01004514#if defined(MBEDTLS_SSL_PROTO_DTLS)
4515 /* We might have buffered a future record; if so,
4516 * and if the epoch matches now, load it.
4517 * On success, this call will set ssl->in_left to
4518 * the length of the buffered record, so that
4519 * the calls to ssl_fetch_input() below will
4520 * essentially be no-ops. */
4521 ret = ssl_load_buffered_record( ssl );
4522 if( ret != 0 )
4523 return( ret );
4524#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004525
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004526 /* Ensure that we have enough space available for the default form
4527 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4528 * with no space for CIDs counted in). */
4529 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4530 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004533 return( ret );
4534 }
4535
Hanno Beckere5e7e782019-07-11 12:29:35 +01004536 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4537 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004538 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004539#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004540 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004541 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004542 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4543 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004544 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004545 if( ret != 0 )
4546 return( ret );
4547
4548 /* Fall through to handling of unexpected records */
4549 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4550 }
4551
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004552 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4553 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004554#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004555 /* Reset in pointers to default state for TLS/DTLS records,
4556 * assuming no CID and no offset between record content and
4557 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004558 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004559
Hanno Becker7ae20e02019-07-12 08:33:49 +01004560 /* Setup internal message pointers from record structure. */
4561 ssl->in_msgtype = rec.type;
4562#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4563 ssl->in_len = ssl->in_cid + rec.cid_len;
4564#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4565 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4566 ssl->in_msglen = rec.data_len;
4567
Hanno Becker2fddd372019-07-10 14:37:41 +01004568 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004569 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004570 if( ret != 0 )
4571 return( ret );
4572#endif
4573
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004574 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004575 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004576
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4578 "(header)" ) );
4579 }
4580 else
4581 {
4582 /* Skip invalid record and the rest of the datagram */
4583 ssl->next_record_offset = 0;
4584 ssl->in_left = 0;
4585
4586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4587 "(header)" ) );
4588 }
4589
4590 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004591 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004592 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004593 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004594#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004595 {
4596 return( ret );
4597 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004598 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004600#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004601 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004602 {
Hanno Beckera8814792019-07-10 15:01:45 +01004603 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004604 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004605 if( ssl->next_record_offset < ssl->in_left )
4606 {
4607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4608 }
4609 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004610 else
4611#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004612 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004613 /*
4614 * Fetch record contents from underlying transport.
4615 */
Hanno Beckera3175662019-07-11 12:50:29 +01004616 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004617 if( ret != 0 )
4618 {
4619 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4620 return( ret );
4621 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004622
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004623 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004624 }
4625
4626 /*
4627 * Decrypt record contents.
4628 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004629
Hanno Beckerfdf66042019-07-11 13:07:45 +01004630 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004631 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004633 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004634 {
4635 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004636 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004637 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004638 /* Except when waiting for Finished as a bad mac here
4639 * probably means something went wrong in the handshake
4640 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4641 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4642 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4643 {
4644#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4645 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4646 {
4647 mbedtls_ssl_send_alert_message( ssl,
4648 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4649 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4650 }
4651#endif
4652 return( ret );
4653 }
4654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004655#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004656 if( ssl->conf->badmac_limit != 0 &&
4657 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004658 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4660 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004661 }
4662#endif
4663
Hanno Becker4a810fb2017-05-24 16:27:30 +01004664 /* As above, invalid records cause
4665 * dismissal of the whole datagram. */
4666
4667 ssl->next_record_offset = 0;
4668 ssl->in_left = 0;
4669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004671 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004672 }
4673
4674 return( ret );
4675 }
4676 else
4677#endif
4678 {
4679 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4681 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004682 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004683 mbedtls_ssl_send_alert_message( ssl,
4684 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4685 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004686 }
4687#endif
4688 return( ret );
4689 }
4690 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004691
Hanno Becker44d89b22019-07-12 09:40:44 +01004692
4693 /* Reset in pointers to default state for TLS/DTLS records,
4694 * assuming no CID and no offset between record content and
4695 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004696 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004697#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4698 ssl->in_len = ssl->in_cid + rec.cid_len;
4699#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004700 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004701
Hanno Becker8685c822019-07-12 09:37:30 +01004702 /* The record content type may change during decryption,
4703 * so re-read it. */
4704 ssl->in_msgtype = rec.type;
4705 /* Also update the input buffer, because unfortunately
4706 * the server-side ssl_parse_client_hello() reparses the
4707 * record header when receiving a ClientHello initiating
4708 * a renegotiation. */
4709 ssl->in_hdr[0] = rec.type;
4710 ssl->in_msg = rec.buf + rec.data_offset;
4711 ssl->in_msglen = rec.data_len;
4712 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4713 ssl->in_len[1] = (unsigned char)( rec.data_len );
4714
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004715#if defined(MBEDTLS_ZLIB_SUPPORT)
4716 if( ssl->transform_in != NULL &&
4717 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4718 {
4719 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4720 {
4721 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4722 return( ret );
4723 }
4724
4725 /* Check actual (decompress) record content length against
4726 * configured maximum. */
4727 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4728 {
4729 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4730 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4731 }
4732 }
4733#endif /* MBEDTLS_ZLIB_SUPPORT */
4734
Simon Butcher99000142016-10-13 17:21:01 +01004735 return( 0 );
4736}
4737
4738int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4739{
Janos Follath865b3eb2019-12-16 11:46:15 +00004740 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004741
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004742 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004743 * Handle particular types of records
4744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004746 {
Simon Butcher99000142016-10-13 17:21:01 +01004747 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4748 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004749 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004750 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004751 }
4752
Hanno Beckere678eaa2018-08-21 14:57:46 +01004753 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004754 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004755 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004756 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4758 ssl->in_msglen ) );
4759 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004760 }
4761
Hanno Beckere678eaa2018-08-21 14:57:46 +01004762 if( ssl->in_msg[0] != 1 )
4763 {
4764 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4765 ssl->in_msg[0] ) );
4766 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4767 }
4768
4769#if defined(MBEDTLS_SSL_PROTO_DTLS)
4770 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4771 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4772 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4773 {
4774 if( ssl->handshake == NULL )
4775 {
4776 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4777 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4778 }
4779
4780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4781 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4782 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004783#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004784 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004787 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004788 if( ssl->in_msglen != 2 )
4789 {
4790 /* Note: Standard allows for more than one 2 byte alert
4791 to be packed in a single message, but Mbed TLS doesn't
4792 currently support this. */
4793 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4794 ssl->in_msglen ) );
4795 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4796 }
4797
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004799 ssl->in_msg[0], ssl->in_msg[1] ) );
4800
4801 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004802 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004807 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004808 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004809 }
4810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4812 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004813 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4815 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004816 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004817
4818#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4819 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4820 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4821 {
Hanno Becker90333da2017-10-10 11:27:13 +01004822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004823 /* Will be handled when trying to parse ServerHello */
4824 return( 0 );
4825 }
4826#endif
4827
4828#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4829 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4830 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4831 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4832 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4833 {
4834 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4835 /* Will be handled in mbedtls_ssl_parse_certificate() */
4836 return( 0 );
4837 }
4838#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4839
4840 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004841 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004842 }
4843
Hanno Beckerc76c6192017-06-06 10:03:17 +01004844#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004845 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004846 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004847 /* Drop unexpected ApplicationData records,
4848 * except at the beginning of renegotiations */
4849 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4850 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4851#if defined(MBEDTLS_SSL_RENEGOTIATION)
4852 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4853 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004854#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004855 )
4856 {
4857 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4858 return( MBEDTLS_ERR_SSL_NON_FATAL );
4859 }
4860
4861 if( ssl->handshake != NULL &&
4862 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4863 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004864 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004865 }
4866 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004867#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004868
Paul Bakker5121ce52009-01-03 21:22:43 +00004869 return( 0 );
4870}
4871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004873{
irwir6c0da642019-09-26 21:07:41 +03004874 return( mbedtls_ssl_send_alert_message( ssl,
4875 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4876 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004877}
4878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004879int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004880 unsigned char level,
4881 unsigned char message )
4882{
Janos Follath865b3eb2019-12-16 11:46:15 +00004883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004884
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004885 if( ssl == NULL || ssl->conf == NULL )
4886 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004889 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004891 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004892 ssl->out_msglen = 2;
4893 ssl->out_msg[0] = level;
4894 ssl->out_msg[1] = message;
4895
Hanno Becker67bc7c32018-08-06 11:33:50 +01004896 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004897 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004898 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004899 return( ret );
4900 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004901 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004902
4903 return( 0 );
4904}
4905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004906int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004907{
Janos Follath865b3eb2019-12-16 11:46:15 +00004908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004909
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004910 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004912 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004913 ssl->out_msglen = 1;
4914 ssl->out_msg[0] = 1;
4915
Paul Bakker5121ce52009-01-03 21:22:43 +00004916 ssl->state++;
4917
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004918 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004919 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004920 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004921 return( ret );
4922 }
4923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004925
4926 return( 0 );
4927}
4928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004929int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004930{
Janos Follath865b3eb2019-12-16 11:46:15 +00004931 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004933 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004934
Hanno Becker327c93b2018-08-15 13:56:18 +01004935 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004938 return( ret );
4939 }
4940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004941 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004942 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004943 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004944 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4945 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004946 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004947 }
4948
Hanno Beckere678eaa2018-08-21 14:57:46 +01004949 /* CCS records are only accepted if they have length 1 and content '1',
4950 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004951
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004952 /*
4953 * Switch to our negotiated transform and session parameters for inbound
4954 * data.
4955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004956 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004957 ssl->transform_in = ssl->transform_negotiate;
4958 ssl->session_in = ssl->session_negotiate;
4959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004961 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004962 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004964 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004965#endif
4966
4967 /* Increment epoch */
4968 if( ++ssl->in_epoch == 0 )
4969 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004971 /* This is highly unlikely to happen for legitimate reasons, so
4972 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004973 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004974 }
4975 }
4976 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004977#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004978 memset( ssl->in_ctr, 0, 8 );
4979
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004980 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4983 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004986 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004987 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004988 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4989 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004990 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004991 }
4992 }
4993#endif
4994
Paul Bakker5121ce52009-01-03 21:22:43 +00004995 ssl->state++;
4996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004998
4999 return( 0 );
5000}
5001
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005002/* Once ssl->out_hdr as the address of the beginning of the
5003 * next outgoing record is set, deduce the other pointers.
5004 *
5005 * Note: For TLS, we save the implicit record sequence number
5006 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5007 * and the caller has to make sure there's space for this.
5008 */
5009
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005010static size_t ssl_transform_get_explicit_iv_len(
5011 mbedtls_ssl_transform const *transform )
5012{
5013 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5014 return( 0 );
5015
5016 return( transform->ivlen - transform->fixed_ivlen );
5017}
5018
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005019void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5020 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005021{
5022#if defined(MBEDTLS_SSL_PROTO_DTLS)
5023 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5024 {
5025 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005026#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005027 ssl->out_cid = ssl->out_ctr + 8;
5028 ssl->out_len = ssl->out_cid;
5029 if( transform != NULL )
5030 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005031#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005032 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005033#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005034 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005035 }
5036 else
5037#endif
5038 {
5039 ssl->out_ctr = ssl->out_hdr - 8;
5040 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005041#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005042 ssl->out_cid = ssl->out_len;
5043#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005044 ssl->out_iv = ssl->out_hdr + 5;
5045 }
5046
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005047 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005048 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005049 if( transform != NULL )
5050 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005051}
5052
5053/* Once ssl->in_hdr as the address of the beginning of the
5054 * next incoming record is set, deduce the other pointers.
5055 *
5056 * Note: For TLS, we save the implicit record sequence number
5057 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5058 * and the caller has to make sure there's space for this.
5059 */
5060
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005061void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005062{
Hanno Becker79594fd2019-05-08 09:38:41 +01005063 /* This function sets the pointers to match the case
5064 * of unprotected TLS/DTLS records, with both ssl->in_iv
5065 * and ssl->in_msg pointing to the beginning of the record
5066 * content.
5067 *
5068 * When decrypting a protected record, ssl->in_msg
5069 * will be shifted to point to the beginning of the
5070 * record plaintext.
5071 */
5072
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005073#if defined(MBEDTLS_SSL_PROTO_DTLS)
5074 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5075 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005076 /* This sets the header pointers to match records
5077 * without CID. When we receive a record containing
5078 * a CID, the fields are shifted accordingly in
5079 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005080 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005081#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005082 ssl->in_cid = ssl->in_ctr + 8;
5083 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005084#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005085 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005086#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005087 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005088 }
5089 else
5090#endif
5091 {
5092 ssl->in_ctr = ssl->in_hdr - 8;
5093 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005094#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005095 ssl->in_cid = ssl->in_len;
5096#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005097 ssl->in_iv = ssl->in_hdr + 5;
5098 }
5099
Hanno Becker79594fd2019-05-08 09:38:41 +01005100 /* This will be adjusted at record decryption time. */
5101 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005102}
5103
Paul Bakker5121ce52009-01-03 21:22:43 +00005104/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005105 * Setup an SSL context
5106 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005107
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005108void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005109{
5110 /* Set the incoming and outgoing record pointers. */
5111#if defined(MBEDTLS_SSL_PROTO_DTLS)
5112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5113 {
5114 ssl->out_hdr = ssl->out_buf;
5115 ssl->in_hdr = ssl->in_buf;
5116 }
5117 else
5118#endif /* MBEDTLS_SSL_PROTO_DTLS */
5119 {
5120 ssl->out_hdr = ssl->out_buf + 8;
5121 ssl->in_hdr = ssl->in_buf + 8;
5122 }
5123
5124 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005125 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5126 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005127}
5128
Paul Bakker5121ce52009-01-03 21:22:43 +00005129/*
5130 * SSL get accessors
5131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005132size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005133{
5134 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5135}
5136
Hanno Becker8b170a02017-10-10 11:51:19 +01005137int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5138{
5139 /*
5140 * Case A: We're currently holding back
5141 * a message for further processing.
5142 */
5143
5144 if( ssl->keep_current_message == 1 )
5145 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005146 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005147 return( 1 );
5148 }
5149
5150 /*
5151 * Case B: Further records are pending in the current datagram.
5152 */
5153
5154#if defined(MBEDTLS_SSL_PROTO_DTLS)
5155 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5156 ssl->in_left > ssl->next_record_offset )
5157 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005158 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005159 return( 1 );
5160 }
5161#endif /* MBEDTLS_SSL_PROTO_DTLS */
5162
5163 /*
5164 * Case C: A handshake message is being processed.
5165 */
5166
Hanno Becker8b170a02017-10-10 11:51:19 +01005167 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5168 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005169 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005170 return( 1 );
5171 }
5172
5173 /*
5174 * Case D: An application data message is being processed
5175 */
5176 if( ssl->in_offt != NULL )
5177 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005178 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005179 return( 1 );
5180 }
5181
5182 /*
5183 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005184 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005185 * we implement support for multiple alerts in single records.
5186 */
5187
5188 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5189 return( 0 );
5190}
5191
Paul Bakker43ca69c2011-01-15 17:35:19 +00005192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005194{
Hanno Becker3136ede2018-08-17 15:28:19 +01005195 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005197 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005198
Hanno Becker5903de42019-05-03 14:46:38 +01005199 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5200
Hanno Becker78640902018-08-13 16:35:15 +01005201 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005202 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005204#if defined(MBEDTLS_ZLIB_SUPPORT)
5205 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5206 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005207#endif
5208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005209 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005210 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005211 case MBEDTLS_MODE_GCM:
5212 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005213 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005214 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005215 transform_expansion = transform->minlen;
5216 break;
5217
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005218 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005219
5220 block_size = mbedtls_cipher_get_block_size(
5221 &transform->cipher_ctx_enc );
5222
Hanno Becker3136ede2018-08-17 15:28:19 +01005223 /* Expansion due to the addition of the MAC. */
5224 transform_expansion += transform->maclen;
5225
5226 /* Expansion due to the addition of CBC padding;
5227 * Theoretically up to 256 bytes, but we never use
5228 * more than the block size of the underlying cipher. */
5229 transform_expansion += block_size;
5230
5231 /* For TLS 1.1 or higher, an explicit IV is added
5232 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005233#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5234 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005235 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005236#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005237
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005238 break;
5239
5240 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005242 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005243 }
5244
Hanno Beckera0e20d02019-05-15 14:03:01 +01005245#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005246 if( transform->out_cid_len != 0 )
5247 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005248#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005249
Hanno Becker5903de42019-05-03 14:46:38 +01005250 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005251}
5252
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005253#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005254/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005255 * Check record counters and renegotiate if they're above the limit.
5256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005257static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005258{
Hanno Beckerdd772292020-02-05 10:38:31 +00005259 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005260 int in_ctr_cmp;
5261 int out_ctr_cmp;
5262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5264 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005265 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005266 {
5267 return( 0 );
5268 }
5269
Andres AG2196c7f2016-12-15 17:01:16 +00005270 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5271 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005272 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005273 ssl->conf->renego_period + ep_len, 8 - ep_len );
5274
5275 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005276 {
5277 return( 0 );
5278 }
5279
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005280 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005281 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005282}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005283#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005284
5285/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005286 * Receive application data decrypted from the SSL layer
5287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005288int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005289{
Janos Follath865b3eb2019-12-16 11:46:15 +00005290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005291 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005292
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005293 if( ssl == NULL || ssl->conf == NULL )
5294 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005296 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005298#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005299 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005300 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005301 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005302 return( ret );
5303
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005304 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005305 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005306 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005307 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005308 return( ret );
5309 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005310 }
5311#endif
5312
Hanno Becker4a810fb2017-05-24 16:27:30 +01005313 /*
5314 * Check if renegotiation is necessary and/or handshake is
5315 * in process. If yes, perform/continue, and fall through
5316 * if an unexpected packet is received while the client
5317 * is waiting for the ServerHello.
5318 *
5319 * (There is no equivalent to the last condition on
5320 * the server-side as it is not treated as within
5321 * a handshake while waiting for the ClientHello
5322 * after a renegotiation request.)
5323 */
5324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005325#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005326 ret = ssl_check_ctr_renegotiate( ssl );
5327 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5328 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005329 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005330 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005331 return( ret );
5332 }
5333#endif
5334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005336 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005337 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005338 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5339 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005340 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005341 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005342 return( ret );
5343 }
5344 }
5345
Hanno Beckere41158b2017-10-23 13:30:32 +01005346 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005347 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005348 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005349 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005350 if( ssl->f_get_timer != NULL &&
5351 ssl->f_get_timer( ssl->p_timer ) == -1 )
5352 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005353 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005354 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005355
Hanno Becker327c93b2018-08-15 13:56:18 +01005356 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005357 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005358 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5359 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005360
Hanno Becker4a810fb2017-05-24 16:27:30 +01005361 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5362 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005363 }
5364
5365 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005367 {
5368 /*
5369 * OpenSSL sends empty messages to randomize the IV
5370 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005371 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005372 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005373 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005374 return( 0 );
5375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005377 return( ret );
5378 }
5379 }
5380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005381 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005382 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005384
Hanno Becker4a810fb2017-05-24 16:27:30 +01005385 /*
5386 * - For client-side, expect SERVER_HELLO_REQUEST.
5387 * - For server-side, expect CLIENT_HELLO.
5388 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5389 */
5390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005392 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005394 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005395 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005397
5398 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005400 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005401 {
5402 continue;
5403 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005404#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005405 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005406 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005407#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005408
Hanno Becker4a810fb2017-05-24 16:27:30 +01005409#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005410 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005412 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005414
5415 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005417 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005418 {
5419 continue;
5420 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005421#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005422 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005423 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005424#endif /* MBEDTLS_SSL_SRV_C */
5425
Hanno Becker21df7f92017-10-17 11:03:26 +01005426#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005427 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005428 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5429 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5430 ssl->conf->allow_legacy_renegotiation ==
5431 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5432 {
5433 /*
5434 * Accept renegotiation request
5435 */
Paul Bakker48916f92012-09-16 19:57:18 +00005436
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005437 /* DTLS clients need to know renego is server-initiated */
5438#if defined(MBEDTLS_SSL_PROTO_DTLS)
5439 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5440 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5441 {
5442 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5443 }
5444#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005445 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005446 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5447 ret != 0 )
5448 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005449 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5450 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005451 return( ret );
5452 }
5453 }
5454 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005455#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005456 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005457 /*
5458 * Refuse renegotiation
5459 */
5460
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005461 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463#if defined(MBEDTLS_SSL_PROTO_SSL3)
5464 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005465 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005466 /* SSLv3 does not have a "no_renegotiation" warning, so
5467 we send a fatal alert and abort the connection. */
5468 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5469 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5470 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005471 }
5472 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5474#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5475 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5476 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005477 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5479 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5480 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005481 {
5482 return( ret );
5483 }
Paul Bakker48916f92012-09-16 19:57:18 +00005484 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005485 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005486#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5487 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005488 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005489 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5490 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005491 }
Paul Bakker48916f92012-09-16 19:57:18 +00005492 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005493
Hanno Becker90333da2017-10-10 11:27:13 +01005494 /* At this point, we don't know whether the renegotiation has been
5495 * completed or not. The cases to consider are the following:
5496 * 1) The renegotiation is complete. In this case, no new record
5497 * has been read yet.
5498 * 2) The renegotiation is incomplete because the client received
5499 * an application data record while awaiting the ServerHello.
5500 * 3) The renegotiation is incomplete because the client received
5501 * a non-handshake, non-application data message while awaiting
5502 * the ServerHello.
5503 * In each of these case, looping will be the proper action:
5504 * - For 1), the next iteration will read a new record and check
5505 * if it's application data.
5506 * - For 2), the loop condition isn't satisfied as application data
5507 * is present, hence continue is the same as break
5508 * - For 3), the loop condition is satisfied and read_record
5509 * will re-deliver the message that was held back by the client
5510 * when expecting the ServerHello.
5511 */
5512 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005513 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005514#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005516 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005517 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005518 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005519 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005520 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005522 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005523 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005524 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005525 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005526 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005527#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005529 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5530 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005533 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005534 }
5535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005536 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005537 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5539 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005540 }
5541
5542 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005543
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005544 /* We're going to return something now, cancel timer,
5545 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005546 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005547 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005548
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005549#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005550 /* If we requested renego but received AppData, resend HelloRequest.
5551 * Do it now, after setting in_offt, to avoid taking this branch
5552 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005553#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005554 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005555 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005556 {
Hanno Becker786300f2020-02-05 10:46:40 +00005557 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005558 {
Hanno Becker786300f2020-02-05 10:46:40 +00005559 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5560 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005561 return( ret );
5562 }
5563 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005564#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005565#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005566 }
5567
5568 n = ( len < ssl->in_msglen )
5569 ? len : ssl->in_msglen;
5570
5571 memcpy( buf, ssl->in_offt, n );
5572 ssl->in_msglen -= n;
5573
5574 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005575 {
5576 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005577 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005578 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005579 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005580 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005581 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005582 /* more data available */
5583 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005584 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005585
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005587
Paul Bakker23986e52011-04-24 08:57:21 +00005588 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005589}
5590
5591/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005592 * Send application data to be encrypted by the SSL layer, taking care of max
5593 * fragment length and buffer size.
5594 *
5595 * According to RFC 5246 Section 6.2.1:
5596 *
5597 * Zero-length fragments of Application data MAY be sent as they are
5598 * potentially useful as a traffic analysis countermeasure.
5599 *
5600 * Therefore, it is possible that the input message length is 0 and the
5601 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005602 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005603static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005604 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005605{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005606 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5607 const size_t max_len = (size_t) ret;
5608
5609 if( ret < 0 )
5610 {
5611 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5612 return( ret );
5613 }
5614
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005615 if( len > max_len )
5616 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005617#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005618 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005619 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005621 "maximum fragment length: %d > %d",
5622 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005623 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005624 }
5625 else
5626#endif
5627 len = max_len;
5628 }
Paul Bakker887bd502011-06-08 13:10:54 +00005629
Paul Bakker5121ce52009-01-03 21:22:43 +00005630 if( ssl->out_left != 0 )
5631 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005632 /*
5633 * The user has previously tried to send the data and
5634 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5635 * written. In this case, we expect the high-level write function
5636 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5637 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005638 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005639 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005641 return( ret );
5642 }
5643 }
Paul Bakker887bd502011-06-08 13:10:54 +00005644 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005645 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005646 /*
5647 * The user is trying to send a message the first time, so we need to
5648 * copy the data into the internal buffers and setup the data structure
5649 * to keep track of partial writes
5650 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005651 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005652 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005653 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005654
Hanno Becker67bc7c32018-08-06 11:33:50 +01005655 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005656 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005657 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005658 return( ret );
5659 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005660 }
5661
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005662 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005663}
5664
5665/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005666 * Write application data, doing 1/n-1 splitting if necessary.
5667 *
5668 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005669 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005670 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005673static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005674 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005675{
Janos Follath865b3eb2019-12-16 11:46:15 +00005676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005677
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005678 if( ssl->conf->cbc_record_splitting ==
5679 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005680 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005681 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5682 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5683 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005684 {
5685 return( ssl_write_real( ssl, buf, len ) );
5686 }
5687
5688 if( ssl->split_done == 0 )
5689 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005690 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005691 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005692 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005693 }
5694
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005695 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5696 return( ret );
5697 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005698
5699 return( ret + 1 );
5700}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005702
5703/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005704 * Write application data (public-facing wrapper)
5705 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005706int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005707{
Janos Follath865b3eb2019-12-16 11:46:15 +00005708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005709
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005710 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005711
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005712 if( ssl == NULL || ssl->conf == NULL )
5713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5714
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005715#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005716 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5717 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005718 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005719 return( ret );
5720 }
5721#endif
5722
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005723 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005724 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005725 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005726 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005727 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005728 return( ret );
5729 }
5730 }
5731
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005732#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005733 ret = ssl_write_split( ssl, buf, len );
5734#else
5735 ret = ssl_write_real( ssl, buf, len );
5736#endif
5737
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005739
5740 return( ret );
5741}
5742
5743/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005744 * Notify the peer that the connection is being closed
5745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005747{
Janos Follath865b3eb2019-12-16 11:46:15 +00005748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005749
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005750 if( ssl == NULL || ssl->conf == NULL )
5751 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005754
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005755 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005757
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005758 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5761 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5762 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005763 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005764 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005765 return( ret );
5766 }
5767 }
5768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005769 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005770
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005771 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005772}
5773
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005774void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005775{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005776 if( transform == NULL )
5777 return;
5778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005779#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005780 deflateEnd( &transform->ctx_deflate );
5781 inflateEnd( &transform->ctx_inflate );
5782#endif
5783
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5785 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005786
Hanno Beckerd56ed242018-01-03 15:32:51 +00005787#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 mbedtls_md_free( &transform->md_ctx_enc );
5789 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005790#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005791
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005792 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005793}
5794
Hanno Becker0271f962018-08-16 13:23:47 +01005795#if defined(MBEDTLS_SSL_PROTO_DTLS)
5796
Hanno Becker533ab5f2020-02-05 10:49:13 +00005797void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005798{
5799 unsigned offset;
5800 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5801
5802 if( hs == NULL )
5803 return;
5804
Hanno Becker283f5ef2018-08-24 09:34:47 +01005805 ssl_free_buffered_record( ssl );
5806
Hanno Becker0271f962018-08-16 13:23:47 +01005807 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005808 ssl_buffering_free_slot( ssl, offset );
5809}
5810
5811static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5812 uint8_t slot )
5813{
5814 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5815 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005816
5817 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5818 return;
5819
Hanno Beckere605b192018-08-21 15:59:07 +01005820 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005821 {
Hanno Beckere605b192018-08-21 15:59:07 +01005822 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005823 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005824 mbedtls_free( hs_buf->data );
5825 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005826 }
5827}
5828
5829#endif /* MBEDTLS_SSL_PROTO_DTLS */
5830
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005831/*
5832 * Convert version numbers to/from wire format
5833 * and, for DTLS, to/from TLS equivalent.
5834 *
5835 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005836 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005837 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5838 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5839 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005840void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005841 unsigned char ver[2] )
5842{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005843#if defined(MBEDTLS_SSL_PROTO_DTLS)
5844 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005845 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005846 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005847 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5848
5849 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5850 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5851 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005852 else
5853#else
5854 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005855#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005856 {
5857 ver[0] = (unsigned char) major;
5858 ver[1] = (unsigned char) minor;
5859 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005860}
5861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005862void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005863 const unsigned char ver[2] )
5864{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005865#if defined(MBEDTLS_SSL_PROTO_DTLS)
5866 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005867 {
5868 *major = 255 - ver[0] + 2;
5869 *minor = 255 - ver[1] + 1;
5870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005871 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005872 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5873 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005874 else
5875#else
5876 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005877#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005878 {
5879 *major = ver[0];
5880 *minor = ver[1];
5881 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005882}
5883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005884#endif /* MBEDTLS_SSL_TLS_C */