blob: 0d1619248ee73f37a7a0ee6279db7ee1ae3b6a5a [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 *
560 * b) Fixed IV lengths matches total IV length, giving
561 * IV = fixed_iv XOR ( 0 || dynamic_iv )
562 */
563static void ssl_build_record_nonce( unsigned char *dst_iv,
564 size_t dst_iv_len,
565 unsigned char const *fixed_iv,
566 size_t fixed_iv_len,
567 unsigned char const *dynamic_iv,
568 size_t dynamic_iv_len )
569{
570 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100571
572 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100573 memset( dst_iv, 0, dst_iv_len );
574 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100575
Hanno Becker17263802020-05-28 07:05:48 +0100576 dst_iv += dst_iv_len - dynamic_iv_len;
577 for( i = 0; i < dynamic_iv_len; i++ )
578 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100579}
Hanno Becker67a37db2020-05-28 16:27:07 +0100580#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100581
Hanno Beckera18d1322018-01-03 14:27:32 +0000582int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
583 mbedtls_ssl_transform *transform,
584 mbedtls_record *rec,
585 int (*f_rng)(void *, unsigned char *, size_t),
586 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000587{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100589 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000590 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100591 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100592 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000593 size_t post_avail;
594
595 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000596#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200597 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000598 ((void) ssl);
599#endif
600
601 /* The PRNG is used for dynamic IV generation that's used
602 * for CBC transformations in TLS 1.1 and TLS 1.2. */
603#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
604 ( defined(MBEDTLS_AES_C) || \
605 defined(MBEDTLS_ARIA_C) || \
606 defined(MBEDTLS_CAMELLIA_C) ) && \
607 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
608 ((void) f_rng);
609 ((void) p_rng);
610#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000613
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000614 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100615 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
617 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
618 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100619 if( rec == NULL
620 || rec->buf == NULL
621 || rec->buf_len < rec->data_offset
622 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100623#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100624 || rec->cid_len != 0
625#endif
626 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000627 {
628 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100630 }
631
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000632 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100633 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000635 data, rec->data_len );
636
637 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
638
639 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
640 {
641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
642 (unsigned) rec->data_len,
643 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
644 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
645 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100646
Hanno Becker92313402020-05-20 13:58:58 +0100647 /* The following two code paths implement the (D)TLSInnerPlaintext
648 * structure present in TLS 1.3 and DTLS 1.2 + CID.
649 *
650 * See ssl_build_inner_plaintext() for more information.
651 *
652 * Note that this changes `rec->data_len`, and hence
653 * `post_avail` needs to be recalculated afterwards.
654 *
655 * Note also that the two code paths cannot occur simultaneously
656 * since they apply to different versions of the protocol. There
657 * is hence no risk of double-addition of the inner plaintext.
658 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100659#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
660 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
661 {
Hanno Becker13996922020-05-28 16:15:19 +0100662 size_t padding =
663 ssl_compute_padding_length( rec->data_len,
664 MBEDTLS_SSL_TLS13_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100665 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100666 &rec->data_len,
667 post_avail,
668 rec->type,
669 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100670 {
671 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
672 }
673
674 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
675 }
676#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
677
Hanno Beckera0e20d02019-05-15 14:03:01 +0100678#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100679 /*
680 * Add CID information
681 */
682 rec->cid_len = transform->out_cid_len;
683 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
684 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100685
686 if( rec->cid_len != 0 )
687 {
Hanno Becker13996922020-05-28 16:15:19 +0100688 size_t padding =
689 ssl_compute_padding_length( rec->data_len,
690 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100691 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100692 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100693 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100694 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100695 * Note that this changes `rec->data_len`, and hence
696 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100697 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100698 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100699 &rec->data_len,
700 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100701 rec->type,
702 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100703 {
704 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
705 }
706
707 rec->type = MBEDTLS_SSL_MSG_CID;
708 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100709#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100710
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100711 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
712
Paul Bakker5121ce52009-01-03 21:22:43 +0000713 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100714 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000715 */
Hanno Becker52344c22018-01-03 15:24:20 +0000716#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 if( mode == MBEDTLS_MODE_STREAM ||
718 ( mode == MBEDTLS_MODE_CBC
719#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000720 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100721#endif
722 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000723 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000724 if( post_avail < transform->maclen )
725 {
726 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
727 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
728 }
729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200730#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000731 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200732 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000733 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000734 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
735 data, rec->data_len, rec->ctr, rec->type, mac );
736 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200737 }
738 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200739#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
741 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000742 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200743 {
Hanno Becker992b6872017-11-09 18:57:39 +0000744 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
745
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100746 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
747 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000748
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100750 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000751 mbedtls_md_hmac_update( &transform->md_ctx_enc,
752 data, rec->data_len );
753 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
754 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
755
756 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200757 }
758 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200759#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200760 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
762 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200763 }
764
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
766 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200767
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 rec->data_len += transform->maclen;
769 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100770 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200771 }
Hanno Becker52344c22018-01-03 15:24:20 +0000772#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000773
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200774 /*
775 * Encrypt
776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
778 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000779 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000781 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000783 "including %d bytes of padding",
784 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000785
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000786 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
787 transform->iv_enc, transform->ivlen,
788 data, rec->data_len,
789 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200790 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200792 return( ret );
793 }
794
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000795 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200796 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
798 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200799 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000800 }
Paul Bakker68884e32013-01-07 18:20:04 +0100801 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000803
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200804#if defined(MBEDTLS_GCM_C) || \
805 defined(MBEDTLS_CCM_C) || \
806 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200808 mode == MBEDTLS_MODE_CCM ||
809 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000810 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200812 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100813 unsigned char *dynamic_iv;
814 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100815 int dynamic_iv_is_explicit =
816 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000817
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100818 /* Check that there's space for the authentication tag. */
819 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000820 {
821 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
822 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
823 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000824
Paul Bakker68884e32013-01-07 18:20:04 +0100825 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100826 * Build nonce for AEAD encryption.
827 *
828 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
829 * part of the IV is prepended to the ciphertext and
830 * can be chosen freely - in particular, it need not
831 * agree with the record sequence number.
832 * However, since ChaChaPoly as well as all AEAD modes
833 * in TLS 1.3 use the record sequence number as the
834 * dynamic part of the nonce, we uniformly use the
835 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100836 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100837 dynamic_iv = rec->ctr;
838 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200839
Hanno Becker17263802020-05-28 07:05:48 +0100840 ssl_build_record_nonce( iv, sizeof( iv ),
841 transform->iv_enc,
842 transform->fixed_ivlen,
843 dynamic_iv,
844 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100845
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100846 /*
847 * Build additional data for AEAD encryption.
848 * This depends on the TLS version.
849 */
850 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
851 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100852
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200853 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
854 iv, transform->ivlen );
855 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Beckerdf8be222020-05-21 15:30:57 +0100856 data - dynamic_iv_len * dynamic_iv_is_explicit,
857 dynamic_iv_len * dynamic_iv_is_explicit );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000858 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100859 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200861 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000862 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000863
Paul Bakker68884e32013-01-07 18:20:04 +0100864 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200865 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200866 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200868 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000869 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100870 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000871 data, rec->data_len, /* source */
872 data, &rec->data_len, /* destination */
873 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200876 return( ret );
877 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000878 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
879 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100880 /* Account for authentication tag. */
881 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000882 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100883
884 /*
885 * Prefix record content with dynamic IV in case it is explicit.
886 */
Hanno Becker17263802020-05-28 07:05:48 +0100887 if( dynamic_iv_is_explicit )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100888 {
889 if( rec->data_offset < dynamic_iv_len )
890 {
891 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
892 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
893 }
894
895 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
896 rec->data_offset -= dynamic_iv_len;
897 rec->data_len += dynamic_iv_len;
898 }
899
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100900 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000901 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000902 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100903#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000905 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000907 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 size_t padlen, i;
910 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 /* Currently we're always using minimal padding
913 * (up to 255 bytes would be allowed). */
914 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
915 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 padlen = 0;
917
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000918 /* Check there's enough space in the buffer for the padding. */
919 if( post_avail < padlen + 1 )
920 {
921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
922 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
923 }
924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000926 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000927
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000928 rec->data_len += padlen + 1;
929 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000932 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000933 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
934 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000935 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000936 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000937 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 if( f_rng == NULL )
939 {
940 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
941 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
942 }
943
944 if( rec->data_offset < transform->ivlen )
945 {
946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
947 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
948 }
949
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000950 /*
951 * Generate IV
952 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000954 if( ret != 0 )
955 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000956
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000957 memcpy( data - transform->ivlen, transform->iv_enc,
958 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000959
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000960 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000964 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000965 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200966 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000967
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000968 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
969 transform->iv_enc,
970 transform->ivlen,
971 data, rec->data_len,
972 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200973 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200975 return( ret );
976 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200977
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000978 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200979 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
981 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200982 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000985 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200986 {
987 /*
988 * Save IV in SSL3 and TLS1
989 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000990 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
991 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000992 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000993 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200994#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000995 {
996 data -= transform->ivlen;
997 rec->data_offset -= transform->ivlen;
998 rec->data_len += transform->ivlen;
999 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001002 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001003 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001004 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1005
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001006 /*
1007 * MAC(MAC_write_key, seq_num +
1008 * TLSCipherText.type +
1009 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001010 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001011 * IV + // except for TLS 1.0
1012 * ENC(content + padding + padding_length));
1013 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001014
1015 if( post_avail < transform->maclen)
1016 {
1017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1018 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1019 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001020
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001021 ssl_extract_add_data_from_record( add_data, &add_data_len,
1022 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001025 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001026 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001027
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001028 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001029 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001030 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1031 data, rec->data_len );
1032 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1033 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001034
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001035 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001036
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001037 rec->data_len += transform->maclen;
1038 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001039 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001040 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001042 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001043 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001045 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001046 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1048 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001049 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001050
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001051 /* Make extra sure authentication was performed, exactly once */
1052 if( auth_done != 1 )
1053 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1055 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001056 }
1057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001059
1060 return( 0 );
1061}
1062
Hanno Becker605949f2019-07-12 08:23:59 +01001063int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001064 mbedtls_ssl_transform *transform,
1065 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001066{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001067 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001069 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001070#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001071 size_t padlen = 0, correct = 1;
1072#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001073 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001074 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001075 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001076
Hanno Beckera18d1322018-01-03 14:27:32 +00001077#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001078 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001079 ((void) ssl);
1080#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001083 if( rec == NULL ||
1084 rec->buf == NULL ||
1085 rec->buf_len < rec->data_offset ||
1086 rec->buf_len - rec->data_offset < rec->data_len )
1087 {
1088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001090 }
1091
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001092 data = rec->buf + rec->data_offset;
1093 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001094
Hanno Beckera0e20d02019-05-15 14:03:01 +01001095#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001096 /*
1097 * Match record's CID with incoming CID.
1098 */
Hanno Becker938489a2019-05-08 13:02:22 +01001099 if( rec->cid_len != transform->in_cid_len ||
1100 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1101 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001102 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001103 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001104#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1107 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001108 {
1109 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001110 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1111 transform->iv_dec,
1112 transform->ivlen,
1113 data, rec->data_len,
1114 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001115 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001117 return( ret );
1118 }
1119
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001120 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001121 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1123 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001124 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001125 }
Paul Bakker68884e32013-01-07 18:20:04 +01001126 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001128#if defined(MBEDTLS_GCM_C) || \
1129 defined(MBEDTLS_CCM_C) || \
1130 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001132 mode == MBEDTLS_MODE_CCM ||
1133 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001134 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001135 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001136 unsigned char *dynamic_iv;
1137 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001138
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001139 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001140 * Extract dynamic part of nonce for AEAD decryption.
1141 *
1142 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1143 * part of the IV is prepended to the ciphertext and
1144 * can be chosen freely - in particular, it need not
1145 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001146 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001147 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001148 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001149 {
1150 if( rec->data_len < dynamic_iv_len )
1151 {
1152 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1153 rec->data_len,
1154 dynamic_iv_len ) );
1155 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1156 }
1157 dynamic_iv = data;
1158
1159 data += dynamic_iv_len;
1160 rec->data_offset += dynamic_iv_len;
1161 rec->data_len -= dynamic_iv_len;
1162 }
Hanno Becker17263802020-05-28 07:05:48 +01001163 else
1164 {
1165 dynamic_iv = rec->ctr;
1166 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001167
1168 /* Check that there's space for the authentication tag. */
1169 if( rec->data_len < transform->taglen )
1170 {
1171 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001173 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001174 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001175
Hanno Beckerdf8be222020-05-21 15:30:57 +01001176 /*
1177 * Prepare nonce from dynamic and static parts.
1178 */
Hanno Becker17263802020-05-28 07:05:48 +01001179 ssl_build_record_nonce( iv, sizeof( iv ),
1180 transform->iv_dec,
1181 transform->fixed_ivlen,
1182 dynamic_iv,
1183 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001184
Hanno Beckerdf8be222020-05-21 15:30:57 +01001185 /*
1186 * Build additional data for AEAD encryption.
1187 * This depends on the TLS version.
1188 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001189 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1190 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001191 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001192 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001193
Hanno Beckerd96a6522019-07-10 13:55:25 +01001194 /* Because of the check above, we know that there are
1195 * explicit_iv_len Bytes preceeding data, and taglen
1196 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001197 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001198 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001199
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001200 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001201 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001202 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001203
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001204 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001205 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001206 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001207 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1208 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001209 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001210 data, rec->data_len,
1211 data, &olen,
1212 data + rec->data_len,
1213 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001214 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001217 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1218 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001219
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001220 return( ret );
1221 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001222 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001223
Hanno Beckerd96a6522019-07-10 13:55:25 +01001224 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001225 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001226 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1228 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001229 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001230 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001231 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001232#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1233#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001234 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001235 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001236 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001237 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001238
Paul Bakker5121ce52009-01-03 21:22:43 +00001239 /*
Paul Bakker45829992013-01-03 14:52:21 +01001240 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1244 {
1245 /* The ciphertext is prefixed with the CBC IV. */
1246 minlen += transform->ivlen;
1247 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001248#endif
Paul Bakker45829992013-01-03 14:52:21 +01001249
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001250 /* Size considerations:
1251 *
1252 * - The CBC cipher text must not be empty and hence
1253 * at least of size transform->ivlen.
1254 *
1255 * Together with the potential IV-prefix, this explains
1256 * the first of the two checks below.
1257 *
1258 * - The record must contain a MAC, either in plain or
1259 * encrypted, depending on whether Encrypt-then-MAC
1260 * is used or not.
1261 * - If it is, the message contains the IV-prefix,
1262 * the CBC ciphertext, and the MAC.
1263 * - If it is not, the padded plaintext, and hence
1264 * the CBC ciphertext, has at least length maclen + 1
1265 * because there is at least the padding length byte.
1266 *
1267 * As the CBC ciphertext is not empty, both cases give the
1268 * lower bound minlen + maclen + 1 on the record size, which
1269 * we test for in the second check below.
1270 */
1271 if( rec->data_len < minlen + transform->ivlen ||
1272 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001273 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 "+ 1 ) ( + expl IV )", rec->data_len,
1276 transform->ivlen,
1277 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001279 }
1280
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001281 /*
1282 * Authenticate before decrypt if enabled
1283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001286 {
Hanno Becker992b6872017-11-09 18:57:39 +00001287 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001290
Hanno Beckerd96a6522019-07-10 13:55:25 +01001291 /* Update data_len in tandem with add_data.
1292 *
1293 * The subtraction is safe because of the previous check
1294 * data_len >= minlen + maclen + 1.
1295 *
1296 * Afterwards, we know that data + data_len is followed by at
1297 * least maclen Bytes, which justifies the call to
1298 * mbedtls_ssl_safer_memcmp() below.
1299 *
1300 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001301 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001302 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1303 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001304
Hanno Beckerd96a6522019-07-10 13:55:25 +01001305 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001306 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1307 add_data_len );
1308 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1309 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001310 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1311 data, rec->data_len );
1312 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1313 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001314
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001315 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1316 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001317 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001318 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001319
Hanno Beckerd96a6522019-07-10 13:55:25 +01001320 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001321 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1322 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001326 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001327 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001328 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001330
1331 /*
1332 * Check length sanity
1333 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001334
1335 /* We know from above that data_len > minlen >= 0,
1336 * so the following check in particular implies that
1337 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001339 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001342 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001343 }
1344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001346 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001347 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001348 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001349 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001350 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001351 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001352 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001353
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001354 data += transform->ivlen;
1355 rec->data_offset += transform->ivlen;
1356 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001357 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001359
Hanno Beckerd96a6522019-07-10 13:55:25 +01001360 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1361
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001362 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1363 transform->iv_dec, transform->ivlen,
1364 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001365 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001366 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001367 return( ret );
1368 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001369
Hanno Beckerd96a6522019-07-10 13:55:25 +01001370 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001371 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001372 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1374 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001375 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001378 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001379 {
1380 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001381 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1382 * records is equivalent to CBC decryption of the concatenation
1383 * of the records; in other words, IVs are maintained across
1384 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001385 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001386 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1387 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001389#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001390
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001391 /* Safe since data_len >= minlen + maclen + 1, so after having
1392 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001393 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1394 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001395 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001396
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397 if( auth_done == 1 )
1398 {
1399 correct *= ( rec->data_len >= padlen + 1 );
1400 padlen *= ( rec->data_len >= padlen + 1 );
1401 }
1402 else
Paul Bakker45829992013-01-03 14:52:21 +01001403 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001405 if( rec->data_len < transform->maclen + padlen + 1 )
1406 {
1407 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1408 rec->data_len,
1409 transform->maclen,
1410 padlen + 1 ) );
1411 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001412#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001413
1414 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1415 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001416 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001417
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001418 padlen++;
1419
1420 /* Regardless of the validity of the padding,
1421 * we have data_len >= padlen here. */
1422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001425 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001427 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#if defined(MBEDTLS_SSL_DEBUG_ALL)
1429 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001430 "should be no more than %d",
1431 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001432#endif
Paul Bakker45829992013-01-03 14:52:21 +01001433 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001434 }
1435 }
1436 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1438#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1439 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001440 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001441 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 /* The padding check involves a series of up to 256
1443 * consecutive memory reads at the end of the record
1444 * plaintext buffer. In order to hide the length and
1445 * validity of the padding, always perform exactly
1446 * `min(256,plaintext_len)` reads (but take into account
1447 * only the last `padlen` bytes for the padding check). */
1448 size_t pad_count = 0;
1449 size_t real_count = 0;
1450 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001451
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001452 /* Index of first padding byte; it has been ensured above
1453 * that the subtraction is safe. */
1454 size_t const padding_idx = rec->data_len - padlen;
1455 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1456 size_t const start_idx = rec->data_len - num_checks;
1457 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001458
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001460 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 real_count |= ( idx >= padding_idx );
1462 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001463 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001464 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001467 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001469#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001470 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001472 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1474 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001475 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1477 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001478 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001479
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001480 /* If the padding was found to be invalid, padlen == 0
1481 * and the subtraction is safe. If the padding was found valid,
1482 * padlen hasn't been changed and the previous assertion
1483 * data_len >= padlen still holds. */
1484 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001485 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001486 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001488 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001489 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1491 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001492 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001493
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001494#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001496 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001497#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001498
1499 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001500 * Authenticate if not done yet.
1501 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001502 */
Hanno Becker52344c22018-01-03 15:24:20 +00001503#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001504 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001505 {
Hanno Becker992b6872017-11-09 18:57:39 +00001506 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001507
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001508 /* If the initial value of padlen was such that
1509 * data_len < maclen + padlen + 1, then padlen
1510 * got reset to 1, and the initial check
1511 * data_len >= minlen + maclen + 1
1512 * guarantees that at this point we still
1513 * have at least data_len >= maclen.
1514 *
1515 * If the initial value of padlen was such that
1516 * data_len >= maclen + padlen + 1, then we have
1517 * subtracted either padlen + 1 (if the padding was correct)
1518 * or 0 (if the padding was incorrect) since then,
1519 * hence data_len >= maclen in any case.
1520 */
1521 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001522 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1523 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001526 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001527 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 ssl_mac( &transform->md_ctx_dec,
1529 transform->mac_dec,
1530 data, rec->data_len,
1531 rec->ctr, rec->type,
1532 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001533 }
1534 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1536#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1537 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001538 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001539 {
1540 /*
1541 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001542 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001543 *
1544 * Known timing attacks:
1545 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1546 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001547 * To compensate for different timings for the MAC calculation
1548 * depending on how much padding was removed (which is determined
1549 * by padlen), process extra_run more blocks through the hash
1550 * function.
1551 *
1552 * The formula in the paper is
1553 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1554 * where L1 is the size of the header plus the decrypted message
1555 * plus CBC padding and L2 is the size of the header plus the
1556 * decrypted message. This is for an underlying hash function
1557 * with 64-byte blocks.
1558 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1559 * correctly. We round down instead of up, so -56 is the correct
1560 * value for our calculations instead of -55.
1561 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001562 * Repeat the formula rather than defining a block_size variable.
1563 * This avoids requiring division by a variable at runtime
1564 * (which would be marginally less efficient and would require
1565 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001566 */
1567 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001568 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001569
1570 /*
1571 * The next two sizes are the minimum and maximum values of
1572 * in_msglen over all padlen values.
1573 *
1574 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001575 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001576 *
1577 * Note that max_len + maclen is never more than the buffer
1578 * length, as we previously did in_msglen -= maclen too.
1579 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001580 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001581 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1582
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001583 memset( tmp, 0, sizeof( tmp ) );
1584
1585 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001586 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001587#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1588 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001589 case MBEDTLS_MD_MD5:
1590 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001591 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001592 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001593 extra_run =
1594 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1595 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001596 break;
1597#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001598#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001599 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001600 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001601 extra_run =
1602 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1603 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001604 break;
1605#endif
1606 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001608 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1609 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001610
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001611 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001612
Hanno Beckercab87e62019-04-29 13:52:53 +01001613 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1614 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001615 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1616 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001617 /* Make sure we access everything even when padlen > 0. This
1618 * makes the synchronisation requirements for just-in-time
1619 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001620 ssl_read_memory( data + rec->data_len, padlen );
1621 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001622
1623 /* Call mbedtls_md_process at least once due to cache attacks
1624 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001625 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001626 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001627
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001628 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001629
1630 /* Make sure we access all the memory that could contain the MAC,
1631 * before we check it in the next code block. This makes the
1632 * synchronisation requirements for just-in-time Prime+Probe
1633 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001634 ssl_read_memory( data + min_len,
1635 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 }
1637 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1639 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001640 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1642 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001643 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001644
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001645#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001646 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1647 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001648#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001649
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001650 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1651 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653#if defined(MBEDTLS_SSL_DEBUG_ALL)
1654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001655#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001656 correct = 0;
1657 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001658 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001659 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001660
1661 /*
1662 * Finally check the correct flag
1663 */
1664 if( correct == 0 )
1665 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001666#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001667
1668 /* Make extra sure authentication was performed, exactly once */
1669 if( auth_done != 1 )
1670 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1672 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001673 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
Hanno Beckerccc13d02020-05-04 12:30:04 +01001675#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1676 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1677 {
1678 /* Remove inner padding and infer true content type. */
1679 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1680 &rec->type );
1681
1682 if( ret != 0 )
1683 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1684 }
1685#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1686
Hanno Beckera0e20d02019-05-15 14:03:01 +01001687#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001688 if( rec->cid_len != 0 )
1689 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001690 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1691 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001692 if( ret != 0 )
1693 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1694 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001695#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001696
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001698
1699 return( 0 );
1700}
1701
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001702#undef MAC_NONE
1703#undef MAC_PLAINTEXT
1704#undef MAC_CIPHERTEXT
1705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001707/*
1708 * Compression/decompression functions
1709 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001711{
Janos Follath865b3eb2019-12-16 11:46:15 +00001712 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001713 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001714 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001715 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001716 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001717#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1718 size_t out_buf_len = ssl->out_buf_len;
1719#else
1720 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1721#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001724
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001725 if( len_pre == 0 )
1726 return( 0 );
1727
Paul Bakker2770fbd2012-07-03 13:30:23 +00001728 memcpy( msg_pre, ssl->out_msg, len_pre );
1729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001731 ssl->out_msglen ) );
1732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001734 ssl->out_msg, ssl->out_msglen );
1735
Paul Bakker48916f92012-09-16 19:57:18 +00001736 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1737 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1738 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001739 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001740
Paul Bakker48916f92012-09-16 19:57:18 +00001741 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001742 if( ret != Z_OK )
1743 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1745 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001746 }
1747
Darryl Greenb33cc762019-11-28 14:29:44 +00001748 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001749 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001752 ssl->out_msglen ) );
1753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001755 ssl->out_msg, ssl->out_msglen );
1756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001758
1759 return( 0 );
1760}
1761
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001763{
Janos Follath865b3eb2019-12-16 11:46:15 +00001764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001765 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001766 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001767 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001768 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001769#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1770 size_t in_buf_len = ssl->in_buf_len;
1771#else
1772 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1773#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001776
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001777 if( len_pre == 0 )
1778 return( 0 );
1779
Paul Bakker2770fbd2012-07-03 13:30:23 +00001780 memcpy( msg_pre, ssl->in_msg, len_pre );
1781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783 ssl->in_msglen ) );
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786 ssl->in_msg, ssl->in_msglen );
1787
Paul Bakker48916f92012-09-16 19:57:18 +00001788 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1789 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1790 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001791 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001792
Paul Bakker48916f92012-09-16 19:57:18 +00001793 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794 if( ret != Z_OK )
1795 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1797 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798 }
1799
Darryl Greenb33cc762019-11-28 14:29:44 +00001800 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001801 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001804 ssl->in_msglen ) );
1805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001807 ssl->in_msg, ssl->in_msglen );
1808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001810
1811 return( 0 );
1812}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814
Paul Bakker5121ce52009-01-03 21:22:43 +00001815/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001816 * Fill the input message buffer by appending data to it.
1817 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001818 *
1819 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1820 * available (from this read and/or a previous one). Otherwise, an error code
1821 * is returned (possibly EOF or WANT_READ).
1822 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001823 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1824 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1825 * since we always read a whole datagram at once.
1826 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001827 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001828 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001831{
Janos Follath865b3eb2019-12-16 11:46:15 +00001832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001833 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001834#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1835 size_t in_buf_len = ssl->in_buf_len;
1836#else
1837 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1838#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001841
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001842 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1843 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001845 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001847 }
1848
Darryl Greenb33cc762019-11-28 14:29:44 +00001849 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001850 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1852 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001853 }
1854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001855#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001856 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001857 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001858 uint32_t timeout;
1859
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001860 /* Just to be sure */
1861 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1862 {
1863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1864 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1865 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1866 }
1867
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001868 /*
1869 * The point is, we need to always read a full datagram at once, so we
1870 * sometimes read more then requested, and handle the additional data.
1871 * It could be the rest of the current record (while fetching the
1872 * header) and/or some other records in the same datagram.
1873 */
1874
1875 /*
1876 * Move to the next record in the already read datagram if applicable
1877 */
1878 if( ssl->next_record_offset != 0 )
1879 {
1880 if( ssl->in_left < ssl->next_record_offset )
1881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1883 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001884 }
1885
1886 ssl->in_left -= ssl->next_record_offset;
1887
1888 if( ssl->in_left != 0 )
1889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001891 ssl->next_record_offset ) );
1892 memmove( ssl->in_hdr,
1893 ssl->in_hdr + ssl->next_record_offset,
1894 ssl->in_left );
1895 }
1896
1897 ssl->next_record_offset = 0;
1898 }
1899
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001901 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001902
1903 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001904 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001905 */
1906 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001909 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001910 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001911
1912 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001913 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001914 * are not at the beginning of a new record, the caller did something
1915 * wrong.
1916 */
1917 if( ssl->in_left != 0 )
1918 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1920 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001921 }
1922
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001923 /*
1924 * Don't even try to read if time's out already.
1925 * This avoids by-passing the timer when repeatedly receiving messages
1926 * that will end up being dropped.
1927 */
Hanno Becker7876d122020-02-05 10:39:31 +00001928 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001929 {
1930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001931 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001932 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001933 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001934 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001935 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001938 timeout = ssl->handshake->retransmit_timeout;
1939 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001940 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001943
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001944 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001945 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1946 timeout );
1947 else
1948 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001951
1952 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001954 }
1955
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001956 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001959 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001962 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001963 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001966 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001967 }
1968
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001970 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001972 return( ret );
1973 }
1974
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001975 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001976 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001978 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001980 {
Hanno Becker786300f2020-02-05 10:46:40 +00001981 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001982 {
Hanno Becker786300f2020-02-05 10:46:40 +00001983 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1984 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001985 return( ret );
1986 }
1987
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001988 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001989 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001991 }
1992
Paul Bakker5121ce52009-01-03 21:22:43 +00001993 if( ret < 0 )
1994 return( ret );
1995
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001996 ssl->in_left = ret;
1997 }
1998 else
1999#endif
2000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002002 ssl->in_left, nb_want ) );
2003
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002004 while( ssl->in_left < nb_want )
2005 {
2006 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002007
Hanno Becker7876d122020-02-05 10:39:31 +00002008 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002009 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2010 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002011 {
2012 if( ssl->f_recv_timeout != NULL )
2013 {
2014 ret = ssl->f_recv_timeout( ssl->p_bio,
2015 ssl->in_hdr + ssl->in_left, len,
2016 ssl->conf->read_timeout );
2017 }
2018 else
2019 {
2020 ret = ssl->f_recv( ssl->p_bio,
2021 ssl->in_hdr + ssl->in_left, len );
2022 }
2023 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002026 ssl->in_left, nb_want ) );
2027 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002028
2029 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002031
2032 if( ret < 0 )
2033 return( ret );
2034
mohammad160352aecb92018-03-28 23:41:40 -07002035 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002036 {
Darryl Green11999bb2018-03-13 15:22:58 +00002037 MBEDTLS_SSL_DEBUG_MSG( 1,
2038 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002039 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002040 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2041 }
2042
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002043 ssl->in_left += ret;
2044 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002045 }
2046
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002048
2049 return( 0 );
2050}
2051
2052/*
2053 * Flush any data not yet written
2054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002056{
Janos Follath865b3eb2019-12-16 11:46:15 +00002057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002058 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002062 if( ssl->f_send == NULL )
2063 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002064 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002065 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002067 }
2068
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002069 /* Avoid incrementing counter if data is flushed */
2070 if( ssl->out_left == 0 )
2071 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002073 return( 0 );
2074 }
2075
Paul Bakker5121ce52009-01-03 21:22:43 +00002076 while( ssl->out_left > 0 )
2077 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002079 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002080
Hanno Becker2b1e3542018-08-06 11:19:13 +01002081 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002082 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002085
2086 if( ret <= 0 )
2087 return( ret );
2088
mohammad160352aecb92018-03-28 23:41:40 -07002089 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002090 {
Darryl Green11999bb2018-03-13 15:22:58 +00002091 MBEDTLS_SSL_DEBUG_MSG( 1,
2092 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002093 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002094 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2095 }
2096
Paul Bakker5121ce52009-01-03 21:22:43 +00002097 ssl->out_left -= ret;
2098 }
2099
Hanno Becker2b1e3542018-08-06 11:19:13 +01002100#if defined(MBEDTLS_SSL_PROTO_DTLS)
2101 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002102 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002103 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002104 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002105 else
2106#endif
2107 {
2108 ssl->out_hdr = ssl->out_buf + 8;
2109 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002110 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002113
2114 return( 0 );
2115}
2116
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002117/*
2118 * Functions to handle the DTLS retransmission state machine
2119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121/*
2122 * Append current handshake message to current outgoing flight
2123 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002125{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2128 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2129 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002130
2131 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002132 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002133 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002134 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002136 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002137 }
2138
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002139 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002140 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002141 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002143 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144 }
2145
2146 /* Copy current handshake message with headers */
2147 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2148 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002149 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150 msg->next = NULL;
2151
2152 /* Append to the current flight */
2153 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002154 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002155 else
2156 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002158 while( cur->next != NULL )
2159 cur = cur->next;
2160 cur->next = msg;
2161 }
2162
Hanno Becker3b235902018-08-06 09:54:53 +01002163 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002164 return( 0 );
2165}
2166
2167/*
2168 * Free the current flight of handshake messages
2169 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002170void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002171{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172 mbedtls_ssl_flight_item *cur = flight;
2173 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002174
2175 while( cur != NULL )
2176 {
2177 next = cur->next;
2178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 mbedtls_free( cur->p );
2180 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181
2182 cur = next;
2183 }
2184}
2185
2186/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002187 * Swap transform_out and out_ctr with the alternative ones
2188 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002189static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002190{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002192 unsigned char tmp_out_ctr[8];
2193
2194 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2195 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002197 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002198 }
2199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002201
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002202 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002203 tmp_transform = ssl->transform_out;
2204 ssl->transform_out = ssl->handshake->alt_transform_out;
2205 ssl->handshake->alt_transform_out = tmp_transform;
2206
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002207 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002208 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2209 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002210 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002211
2212 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002213 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002215#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2216 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002217 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002218 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2219 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002220 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2222 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002223 }
2224 }
2225#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002226
2227 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002228}
2229
2230/*
2231 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002232 */
2233int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2234{
2235 int ret = 0;
2236
2237 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2238
2239 ret = mbedtls_ssl_flight_transmit( ssl );
2240
2241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2242
2243 return( ret );
2244}
2245
2246/*
2247 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002248 *
2249 * Need to remember the current message in case flush_output returns
2250 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002251 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002252 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002253int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254{
Janos Follath865b3eb2019-12-16 11:46:15 +00002255 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002256 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002259 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002261
2262 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002263 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002264 ret = ssl_swap_epochs( ssl );
2265 if( ret != 0 )
2266 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002269 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002270
2271 while( ssl->handshake->cur_msg != NULL )
2272 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002273 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002274 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002275
Hanno Beckere1dcb032018-08-17 16:47:58 +01002276 int const is_finished =
2277 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2278 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2279
Hanno Becker04da1892018-08-14 13:22:10 +01002280 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2281 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2282
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002283 /* Swap epochs before sending Finished: we can't do it after
2284 * sending ChangeCipherSpec, in case write returns WANT_READ.
2285 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002286 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002287 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002288 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002289 ret = ssl_swap_epochs( ssl );
2290 if( ret != 0 )
2291 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002292 }
2293
Hanno Becker67bc7c32018-08-06 11:33:50 +01002294 ret = ssl_get_remaining_payload_in_datagram( ssl );
2295 if( ret < 0 )
2296 return( ret );
2297 max_frag_len = (size_t) ret;
2298
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002299 /* CCS is copied as is, while HS messages may need fragmentation */
2300 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2301 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002302 if( max_frag_len == 0 )
2303 {
2304 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2305 return( ret );
2306
2307 continue;
2308 }
2309
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002310 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002311 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002312 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002314 /* Update position inside current message */
2315 ssl->handshake->cur_msg_p += cur->len;
2316 }
2317 else
2318 {
2319 const unsigned char * const p = ssl->handshake->cur_msg_p;
2320 const size_t hs_len = cur->len - 12;
2321 const size_t frag_off = p - ( cur->p + 12 );
2322 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002323 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002324
Hanno Beckere1dcb032018-08-17 16:47:58 +01002325 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002326 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002327 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002328 {
2329 ret = ssl_swap_epochs( ssl );
2330 if( ret != 0 )
2331 return( ret );
2332 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002333
Hanno Becker67bc7c32018-08-06 11:33:50 +01002334 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2335 return( ret );
2336
2337 continue;
2338 }
2339 max_hs_frag_len = max_frag_len - 12;
2340
2341 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2342 max_hs_frag_len : rem_len;
2343
2344 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002345 {
2346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002347 (unsigned) cur_hs_frag_len,
2348 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002349 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002350
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002351 /* Messages are stored with handshake headers as if not fragmented,
2352 * copy beginning of headers then fill fragmentation fields.
2353 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2354 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002355
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002356 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2357 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2358 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2359
Hanno Becker67bc7c32018-08-06 11:33:50 +01002360 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2361 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2362 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002363
2364 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2365
Hanno Becker3f7b9732018-08-28 09:53:25 +01002366 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002367 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2368 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002369 ssl->out_msgtype = cur->type;
2370
2371 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002372 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002373 }
2374
2375 /* If done with the current message move to the next one if any */
2376 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2377 {
2378 if( cur->next != NULL )
2379 {
2380 ssl->handshake->cur_msg = cur->next;
2381 ssl->handshake->cur_msg_p = cur->next->p + 12;
2382 }
2383 else
2384 {
2385 ssl->handshake->cur_msg = NULL;
2386 ssl->handshake->cur_msg_p = NULL;
2387 }
2388 }
2389
2390 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002391 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394 return( ret );
2395 }
2396 }
2397
Hanno Becker67bc7c32018-08-06 11:33:50 +01002398 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2399 return( ret );
2400
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002401 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2403 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002404 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002405 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002407 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002408 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002409
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002410 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002411
2412 return( 0 );
2413}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002414
2415/*
2416 * To be called when the last message of an incoming flight is received.
2417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002419{
2420 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002421 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422 ssl->handshake->flight = NULL;
2423 ssl->handshake->cur_msg = NULL;
2424
2425 /* The next incoming flight will start with this msg_seq */
2426 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2427
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002428 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002429 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002430
Hanno Becker0271f962018-08-16 13:23:47 +01002431 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002432 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002433
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002434 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002435 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2438 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002439 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002441 }
2442 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002444}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002445
2446/*
2447 * To be called when the last message of an outgoing flight is send.
2448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002450{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002451 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002452 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2455 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002458 }
2459 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002461}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002463
Paul Bakker5121ce52009-01-03 21:22:43 +00002464/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002465 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002466 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002467
2468/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002469 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002470 *
2471 * - fill in handshake headers
2472 * - update handshake checksum
2473 * - DTLS: save message for resending
2474 * - then pass to the record layer
2475 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002476 * DTLS: except for HelloRequest, messages are only queued, and will only be
2477 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002478 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002479 * Inputs:
2480 * - ssl->out_msglen: 4 + actual handshake message len
2481 * (4 is the size of handshake headers for TLS)
2482 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2483 * - ssl->out_msg + 4: the handshake message body
2484 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002485 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002486 * - ssl->out_msglen: the length of the record contents
2487 * (including handshake headers but excluding record headers)
2488 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002489 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002490int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002491{
Janos Follath865b3eb2019-12-16 11:46:15 +00002492 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002493 const size_t hs_len = ssl->out_msglen - 4;
2494 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002496 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2497
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002498 /*
2499 * Sanity checks
2500 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002501 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002502 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2503 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002504 /* In SSLv3, the client might send a NoCertificate alert. */
2505#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2506 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2507 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2508 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2509#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2510 {
2511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2513 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002514 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002515
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002516 /* Whenever we send anything different from a
2517 * HelloRequest we should be in a handshake - double check. */
2518 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2519 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002520 ssl->handshake == NULL )
2521 {
2522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2523 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2524 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002527 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002528 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002530 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2532 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002533 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002534#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002535
Hanno Beckerb50a2532018-08-06 11:52:54 +01002536 /* Double-check that we did not exceed the bounds
2537 * of the outgoing record buffer.
2538 * This should never fail as the various message
2539 * writing functions must obey the bounds of the
2540 * outgoing record buffer, but better be safe.
2541 *
2542 * Note: We deliberately do not check for the MTU or MFL here.
2543 */
2544 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2545 {
2546 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2547 "size %u, maximum %u",
2548 (unsigned) ssl->out_msglen,
2549 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2550 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2551 }
2552
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002553 /*
2554 * Fill handshake headers
2555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002557 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002558 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2559 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2560 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002561
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002562 /*
2563 * DTLS has additional fields in the Handshake layer,
2564 * between the length field and the actual payload:
2565 * uint16 message_seq;
2566 * uint24 fragment_offset;
2567 * uint24 fragment_length;
2568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002570 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002571 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002572 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002573 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002574 {
2575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2576 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002577 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002578 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002579 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2580 }
2581
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002582 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002583 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002584
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002585 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002586 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002587 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002588 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2589 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2590 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002591 }
2592 else
2593 {
2594 ssl->out_msg[4] = 0;
2595 ssl->out_msg[5] = 0;
2596 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002597
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002598 /* Handshake hashes are computed without fragmentation,
2599 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002600 memset( ssl->out_msg + 6, 0x00, 3 );
2601 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002602 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002604
Hanno Becker0207e532018-08-28 10:28:28 +01002605 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002606 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2607 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 }
2609
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002612 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002613 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2614 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002615 {
2616 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2617 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002619 return( ret );
2620 }
2621 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002622 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002623#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002624 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002625 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002626 {
2627 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2628 return( ret );
2629 }
2630 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002631
2632 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2633
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002634 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002635}
2636
2637/*
2638 * Record layer functions
2639 */
2640
2641/*
2642 * Write current record.
2643 *
2644 * Uses:
2645 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2646 * - ssl->out_msglen: length of the record content (excl headers)
2647 * - ssl->out_msg: record content
2648 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002649int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002650{
2651 int ret, done = 0;
2652 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002653 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002654
2655 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002658 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002660 {
2661 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002664 return( ret );
2665 }
2666
2667 len = ssl->out_msglen;
2668 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2672 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002673 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676 ret = mbedtls_ssl_hw_record_write( ssl );
2677 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2680 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002681 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002682
2683 if( ret == 0 )
2684 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002685 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002687 if( !done )
2688 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002689 unsigned i;
2690 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002691#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2692 size_t out_buf_len = ssl->out_buf_len;
2693#else
2694 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2695#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002696 /* Skip writing the record content type to after the encryption,
2697 * as it may change when using the CID extension. */
2698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002700 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002701
Hanno Becker19859472018-08-06 09:40:20 +01002702 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002703 ssl->out_len[0] = (unsigned char)( len >> 8 );
2704 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002705
Paul Bakker48916f92012-09-16 19:57:18 +00002706 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002707 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002708 mbedtls_record rec;
2709
2710 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002711 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002712 rec.data_len = ssl->out_msglen;
2713 rec.data_offset = ssl->out_msg - rec.buf;
2714
2715 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2716 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2717 ssl->conf->transport, rec.ver );
2718 rec.type = ssl->out_msgtype;
2719
Hanno Beckera0e20d02019-05-15 14:03:01 +01002720#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002721 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002722 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002723#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002724
Hanno Beckera18d1322018-01-03 14:27:32 +00002725 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002726 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002727 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002729 return( ret );
2730 }
2731
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002732 if( rec.data_offset != 0 )
2733 {
2734 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2735 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2736 }
2737
Hanno Becker6430faf2019-05-08 11:57:13 +01002738 /* Update the record content type and CID. */
2739 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002740#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002741 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002742#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002743 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002744 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2745 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002746 }
2747
Hanno Becker5903de42019-05-03 14:46:38 +01002748 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002749
2750#if defined(MBEDTLS_SSL_PROTO_DTLS)
2751 /* In case of DTLS, double-check that we don't exceed
2752 * the remaining space in the datagram. */
2753 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2754 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002755 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002756 if( ret < 0 )
2757 return( ret );
2758
2759 if( protected_record_size > (size_t) ret )
2760 {
2761 /* Should never happen */
2762 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2763 }
2764 }
2765#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002766
Hanno Becker6430faf2019-05-08 11:57:13 +01002767 /* Now write the potentially updated record content type. */
2768 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002771 "version = [%d:%d], msglen = %d",
2772 ssl->out_hdr[0], ssl->out_hdr[1],
2773 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002776 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002777
2778 ssl->out_left += protected_record_size;
2779 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002780 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002781
Hanno Beckerdd772292020-02-05 10:38:31 +00002782 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002783 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2784 break;
2785
2786 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002787 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002788 {
2789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2790 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2791 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 }
2793
Hanno Becker67bc7c32018-08-06 11:33:50 +01002794#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002795 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2796 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002797 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002798 size_t remaining;
2799 ret = ssl_get_remaining_payload_in_datagram( ssl );
2800 if( ret < 0 )
2801 {
2802 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2803 ret );
2804 return( ret );
2805 }
2806
2807 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002808 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002809 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002810 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002811 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002812 else
2813 {
Hanno Becker513815a2018-08-20 11:56:09 +01002814 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002815 }
2816 }
2817#endif /* MBEDTLS_SSL_PROTO_DTLS */
2818
2819 if( ( flush == SSL_FORCE_FLUSH ) &&
2820 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002821 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002823 return( ret );
2824 }
2825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002827
2828 return( 0 );
2829}
2830
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002832
2833static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2834{
2835 if( ssl->in_msglen < ssl->in_hslen ||
2836 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2837 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2838 {
2839 return( 1 );
2840 }
2841 return( 0 );
2842}
Hanno Becker44650b72018-08-16 12:51:11 +01002843
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002844static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002845{
2846 return( ( ssl->in_msg[9] << 16 ) |
2847 ( ssl->in_msg[10] << 8 ) |
2848 ssl->in_msg[11] );
2849}
2850
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002851static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002852{
2853 return( ( ssl->in_msg[6] << 16 ) |
2854 ( ssl->in_msg[7] << 8 ) |
2855 ssl->in_msg[8] );
2856}
2857
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002858static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002859{
2860 uint32_t msg_len, frag_off, frag_len;
2861
2862 msg_len = ssl_get_hs_total_len( ssl );
2863 frag_off = ssl_get_hs_frag_off( ssl );
2864 frag_len = ssl_get_hs_frag_len( ssl );
2865
2866 if( frag_off > msg_len )
2867 return( -1 );
2868
2869 if( frag_len > msg_len - frag_off )
2870 return( -1 );
2871
2872 if( frag_len + 12 > ssl->in_msglen )
2873 return( -1 );
2874
2875 return( 0 );
2876}
2877
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002878/*
2879 * Mark bits in bitmask (used for DTLS HS reassembly)
2880 */
2881static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2882{
2883 unsigned int start_bits, end_bits;
2884
2885 start_bits = 8 - ( offset % 8 );
2886 if( start_bits != 8 )
2887 {
2888 size_t first_byte_idx = offset / 8;
2889
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002890 /* Special case */
2891 if( len <= start_bits )
2892 {
2893 for( ; len != 0; len-- )
2894 mask[first_byte_idx] |= 1 << ( start_bits - len );
2895
2896 /* Avoid potential issues with offset or len becoming invalid */
2897 return;
2898 }
2899
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002900 offset += start_bits; /* Now offset % 8 == 0 */
2901 len -= start_bits;
2902
2903 for( ; start_bits != 0; start_bits-- )
2904 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2905 }
2906
2907 end_bits = len % 8;
2908 if( end_bits != 0 )
2909 {
2910 size_t last_byte_idx = ( offset + len ) / 8;
2911
2912 len -= end_bits; /* Now len % 8 == 0 */
2913
2914 for( ; end_bits != 0; end_bits-- )
2915 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2916 }
2917
2918 memset( mask + offset / 8, 0xFF, len / 8 );
2919}
2920
2921/*
2922 * Check that bitmask is full
2923 */
2924static int ssl_bitmask_check( unsigned char *mask, size_t len )
2925{
2926 size_t i;
2927
2928 for( i = 0; i < len / 8; i++ )
2929 if( mask[i] != 0xFF )
2930 return( -1 );
2931
2932 for( i = 0; i < len % 8; i++ )
2933 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2934 return( -1 );
2935
2936 return( 0 );
2937}
2938
Hanno Becker56e205e2018-08-16 09:06:12 +01002939/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002940static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002941 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002942{
Hanno Becker56e205e2018-08-16 09:06:12 +01002943 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002944
Hanno Becker56e205e2018-08-16 09:06:12 +01002945 alloc_len = 12; /* Handshake header */
2946 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002947
Hanno Beckerd07df862018-08-16 09:14:58 +01002948 if( add_bitmap )
2949 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002950
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002951 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002952}
Hanno Becker56e205e2018-08-16 09:06:12 +01002953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002955
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002956static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002957{
2958 return( ( ssl->in_msg[1] << 16 ) |
2959 ( ssl->in_msg[2] << 8 ) |
2960 ssl->in_msg[3] );
2961}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002962
Simon Butcher99000142016-10-13 17:21:01 +01002963int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002964{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002966 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002968 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002970 }
2971
Hanno Becker12555c62018-08-16 12:47:53 +01002972 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002975 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002976 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002979 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002980 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002981 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002982 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002983
Hanno Becker44650b72018-08-16 12:51:11 +01002984 if( ssl_check_hs_header( ssl ) != 0 )
2985 {
2986 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2987 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2988 }
2989
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002990 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002991 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2992 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2993 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2994 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002995 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002996 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2997 {
2998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2999 recv_msg_seq,
3000 ssl->handshake->in_msg_seq ) );
3001 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3002 }
3003
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003004 /* Retransmit only on last message from previous flight, to avoid
3005 * too many retransmissions.
3006 * Besides, No sane server ever retransmits HelloVerifyRequest */
3007 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003009 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003011 "message_seq = %d, start_of_flight = %d",
3012 recv_msg_seq,
3013 ssl->handshake->in_flight_start_seq ) );
3014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003016 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003018 return( ret );
3019 }
3020 }
3021 else
3022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003024 "message_seq = %d, expected = %d",
3025 recv_msg_seq,
3026 ssl->handshake->in_msg_seq ) );
3027 }
3028
Hanno Becker90333da2017-10-10 11:27:13 +01003029 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003030 }
3031 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003032
Hanno Becker6d97ef52018-08-16 13:09:04 +01003033 /* Message reassembly is handled alongside buffering of future
3034 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003035 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003036 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003037 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003038 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003040 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003041 }
3042 }
3043 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003045 /* With TLS we don't handle fragmentation (for now) */
3046 if( ssl->in_msglen < ssl->in_hslen )
3047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3049 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003050 }
3051
Simon Butcher99000142016-10-13 17:21:01 +01003052 return( 0 );
3053}
3054
3055void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3056{
Hanno Becker0271f962018-08-16 13:23:47 +01003057 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003058
Hanno Becker0271f962018-08-16 13:23:47 +01003059 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003060 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003061 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003062 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003063
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003064 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003066 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003067 ssl->handshake != NULL )
3068 {
Hanno Becker0271f962018-08-16 13:23:47 +01003069 unsigned offset;
3070 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003071
Hanno Becker0271f962018-08-16 13:23:47 +01003072 /* Increment handshake sequence number */
3073 hs->in_msg_seq++;
3074
3075 /*
3076 * Clear up handshake buffering and reassembly structure.
3077 */
3078
3079 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003080 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003081
3082 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003083 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3084 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003085 offset++, hs_buf++ )
3086 {
3087 *hs_buf = *(hs_buf + 1);
3088 }
3089
3090 /* Create a fresh last entry */
3091 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003092 }
3093#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003094}
3095
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003096/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003097 * DTLS anti-replay: RFC 6347 4.1.2.6
3098 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003099 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3100 * Bit n is set iff record number in_window_top - n has been seen.
3101 *
3102 * Usually, in_window_top is the last record number seen and the lsb of
3103 * in_window is set. The only exception is the initial state (record number 0
3104 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003105 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003107void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003108{
3109 ssl->in_window_top = 0;
3110 ssl->in_window = 0;
3111}
3112
3113static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3114{
3115 return( ( (uint64_t) buf[0] << 40 ) |
3116 ( (uint64_t) buf[1] << 32 ) |
3117 ( (uint64_t) buf[2] << 24 ) |
3118 ( (uint64_t) buf[3] << 16 ) |
3119 ( (uint64_t) buf[4] << 8 ) |
3120 ( (uint64_t) buf[5] ) );
3121}
3122
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003123static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3124{
Janos Follath865b3eb2019-12-16 11:46:15 +00003125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003126 unsigned char *original_in_ctr;
3127
3128 // save original in_ctr
3129 original_in_ctr = ssl->in_ctr;
3130
3131 // use counter from record
3132 ssl->in_ctr = record_in_ctr;
3133
3134 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3135
3136 // restore the counter
3137 ssl->in_ctr = original_in_ctr;
3138
3139 return ret;
3140}
3141
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003142/*
3143 * Return 0 if sequence number is acceptable, -1 otherwise
3144 */
Hanno Becker0183d692019-07-12 08:50:37 +01003145int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003146{
3147 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3148 uint64_t bit;
3149
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003150 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003151 return( 0 );
3152
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003153 if( rec_seqnum > ssl->in_window_top )
3154 return( 0 );
3155
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003156 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003157
3158 if( bit >= 64 )
3159 return( -1 );
3160
3161 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3162 return( -1 );
3163
3164 return( 0 );
3165}
3166
3167/*
3168 * Update replay window on new validated record
3169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003171{
3172 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3173
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003174 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003175 return;
3176
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003177 if( rec_seqnum > ssl->in_window_top )
3178 {
3179 /* Update window_top and the contents of the window */
3180 uint64_t shift = rec_seqnum - ssl->in_window_top;
3181
3182 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003183 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003184 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003185 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003186 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003187 ssl->in_window |= 1;
3188 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003189
3190 ssl->in_window_top = rec_seqnum;
3191 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003192 else
3193 {
3194 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003195 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003196
3197 if( bit < 64 ) /* Always true, but be extra sure */
3198 ssl->in_window |= (uint64_t) 1 << bit;
3199 }
3200}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003202
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003203#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003204/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003205 * Without any SSL context, check if a datagram looks like a ClientHello with
3206 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003207 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003208 *
3209 * - if cookie is valid, return 0
3210 * - if ClientHello looks superficially valid but cookie is not,
3211 * fill obuf and set olen, then
3212 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3213 * - otherwise return a specific error code
3214 */
3215static int ssl_check_dtls_clihlo_cookie(
3216 mbedtls_ssl_cookie_write_t *f_cookie_write,
3217 mbedtls_ssl_cookie_check_t *f_cookie_check,
3218 void *p_cookie,
3219 const unsigned char *cli_id, size_t cli_id_len,
3220 const unsigned char *in, size_t in_len,
3221 unsigned char *obuf, size_t buf_len, size_t *olen )
3222{
3223 size_t sid_len, cookie_len;
3224 unsigned char *p;
3225
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003226 /*
3227 * Structure of ClientHello with record and handshake headers,
3228 * and expected values. We don't need to check a lot, more checks will be
3229 * done when actually parsing the ClientHello - skipping those checks
3230 * avoids code duplication and does not make cookie forging any easier.
3231 *
3232 * 0-0 ContentType type; copied, must be handshake
3233 * 1-2 ProtocolVersion version; copied
3234 * 3-4 uint16 epoch; copied, must be 0
3235 * 5-10 uint48 sequence_number; copied
3236 * 11-12 uint16 length; (ignored)
3237 *
3238 * 13-13 HandshakeType msg_type; (ignored)
3239 * 14-16 uint24 length; (ignored)
3240 * 17-18 uint16 message_seq; copied
3241 * 19-21 uint24 fragment_offset; copied, must be 0
3242 * 22-24 uint24 fragment_length; (ignored)
3243 *
3244 * 25-26 ProtocolVersion client_version; (ignored)
3245 * 27-58 Random random; (ignored)
3246 * 59-xx SessionID session_id; 1 byte len + sid_len content
3247 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3248 * ...
3249 *
3250 * Minimum length is 61 bytes.
3251 */
3252 if( in_len < 61 ||
3253 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3254 in[3] != 0 || in[4] != 0 ||
3255 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3256 {
3257 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3258 }
3259
3260 sid_len = in[59];
3261 if( sid_len > in_len - 61 )
3262 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3263
3264 cookie_len = in[60 + sid_len];
3265 if( cookie_len > in_len - 60 )
3266 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3267
3268 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3269 cli_id, cli_id_len ) == 0 )
3270 {
3271 /* Valid cookie */
3272 return( 0 );
3273 }
3274
3275 /*
3276 * If we get here, we've got an invalid cookie, let's prepare HVR.
3277 *
3278 * 0-0 ContentType type; copied
3279 * 1-2 ProtocolVersion version; copied
3280 * 3-4 uint16 epoch; copied
3281 * 5-10 uint48 sequence_number; copied
3282 * 11-12 uint16 length; olen - 13
3283 *
3284 * 13-13 HandshakeType msg_type; hello_verify_request
3285 * 14-16 uint24 length; olen - 25
3286 * 17-18 uint16 message_seq; copied
3287 * 19-21 uint24 fragment_offset; copied
3288 * 22-24 uint24 fragment_length; olen - 25
3289 *
3290 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3291 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3292 *
3293 * Minimum length is 28.
3294 */
3295 if( buf_len < 28 )
3296 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3297
3298 /* Copy most fields and adapt others */
3299 memcpy( obuf, in, 25 );
3300 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3301 obuf[25] = 0xfe;
3302 obuf[26] = 0xff;
3303
3304 /* Generate and write actual cookie */
3305 p = obuf + 28;
3306 if( f_cookie_write( p_cookie,
3307 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3308 {
3309 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3310 }
3311
3312 *olen = p - obuf;
3313
3314 /* Go back and fill length fields */
3315 obuf[27] = (unsigned char)( *olen - 28 );
3316
3317 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3318 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3319 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3320
3321 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3322 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3323
3324 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3325}
3326
3327/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003328 * Handle possible client reconnect with the same UDP quadruplet
3329 * (RFC 6347 Section 4.2.8).
3330 *
3331 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3332 * that looks like a ClientHello.
3333 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003334 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003335 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003336 * - if the input looks like a ClientHello with a valid cookie,
3337 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003338 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003339 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003340 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003341 * This function is called (through ssl_check_client_reconnect()) when an
3342 * unexpected record is found in ssl_get_next_record(), which will discard the
3343 * record if we return 0, and bubble up the return value otherwise (this
3344 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3345 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003346 */
3347static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3348{
Janos Follath865b3eb2019-12-16 11:46:15 +00003349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003350 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003351
Hanno Becker2fddd372019-07-10 14:37:41 +01003352 if( ssl->conf->f_cookie_write == NULL ||
3353 ssl->conf->f_cookie_check == NULL )
3354 {
3355 /* If we can't use cookies to verify reachability of the peer,
3356 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3358 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003359 return( 0 );
3360 }
3361
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362 ret = ssl_check_dtls_clihlo_cookie(
3363 ssl->conf->f_cookie_write,
3364 ssl->conf->f_cookie_check,
3365 ssl->conf->p_cookie,
3366 ssl->cli_id, ssl->cli_id_len,
3367 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003368 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003369
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003370 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3371
3372 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003373 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003374 int send_ret;
3375 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3376 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3377 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003378 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003379 * If the error is permanent we'll catch it later,
3380 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003381 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3382 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3383 (void) send_ret;
3384
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003385 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003386 }
3387
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003388 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003389 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003391 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003392 {
3393 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3394 return( ret );
3395 }
3396
3397 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003398 }
3399
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003400 return( ret );
3401}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003402#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003403
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003404static int ssl_check_record_type( uint8_t record_type )
3405{
3406 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3407 record_type != MBEDTLS_SSL_MSG_ALERT &&
3408 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3409 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3410 {
3411 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3412 }
3413
3414 return( 0 );
3415}
3416
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003417/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003418 * ContentType type;
3419 * ProtocolVersion version;
3420 * uint16 epoch; // DTLS only
3421 * uint48 sequence_number; // DTLS only
3422 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003423 *
3424 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003425 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003426 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3427 *
3428 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003429 * 1. proceed with the record if this function returns 0
3430 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3431 * 3. return CLIENT_RECONNECT if this function return that value
3432 * 4. drop the whole datagram if this function returns anything else.
3433 * Point 2 is needed when the peer is resending, and we have already received
3434 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003435 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003436static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003437 unsigned char *buf,
3438 size_t len,
3439 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003440{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003441 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003442
Hanno Beckere5e7e782019-07-11 12:29:35 +01003443 size_t const rec_hdr_type_offset = 0;
3444 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003445
Hanno Beckere5e7e782019-07-11 12:29:35 +01003446 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3447 rec_hdr_type_len;
3448 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003449
Hanno Beckere5e7e782019-07-11 12:29:35 +01003450 size_t const rec_hdr_ctr_len = 8;
3451#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003452 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003453 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3454 rec_hdr_version_len;
3455
Hanno Beckera0e20d02019-05-15 14:03:01 +01003456#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003457 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3458 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003459 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003460#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3461#endif /* MBEDTLS_SSL_PROTO_DTLS */
3462
3463 size_t rec_hdr_len_offset; /* To be determined */
3464 size_t const rec_hdr_len_len = 2;
3465
3466 /*
3467 * Check minimum lengths for record header.
3468 */
3469
3470#if defined(MBEDTLS_SSL_PROTO_DTLS)
3471 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3472 {
3473 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3474 }
3475 else
3476#endif /* MBEDTLS_SSL_PROTO_DTLS */
3477 {
3478 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3479 }
3480
3481 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3482 {
3483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3484 (unsigned) len,
3485 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3486 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3487 }
3488
3489 /*
3490 * Parse and validate record content type
3491 */
3492
3493 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003494
3495 /* Check record content type */
3496#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3497 rec->cid_len = 0;
3498
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003499 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003500 ssl->conf->cid_len != 0 &&
3501 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003502 {
3503 /* Shift pointers to account for record header including CID
3504 * struct {
3505 * ContentType special_type = tls12_cid;
3506 * ProtocolVersion version;
3507 * uint16 epoch;
3508 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003509 * opaque cid[cid_length]; // Additional field compared to
3510 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003511 * uint16 length;
3512 * opaque enc_content[DTLSCiphertext.length];
3513 * } DTLSCiphertext;
3514 */
3515
3516 /* So far, we only support static CID lengths
3517 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003518 rec_hdr_cid_len = ssl->conf->cid_len;
3519 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003520
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003522 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3524 (unsigned) len,
3525 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003526 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003527 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003528
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003529 /* configured CID len is guaranteed at most 255, see
3530 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3531 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003532 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003533 }
3534 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003535#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003536 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003537 if( ssl_check_record_type( rec->type ) )
3538 {
Hanno Becker54229812019-07-12 14:40:00 +01003539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3540 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003541 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3542 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003543 }
3544
Hanno Beckere5e7e782019-07-11 12:29:35 +01003545 /*
3546 * Parse and validate record version
3547 */
3548
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003549 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3550 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003551 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3552 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003553 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003554
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003555 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003556 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3558 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003559 }
3560
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003561 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3564 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003565 }
3566
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567 /*
3568 * Parse/Copy record sequence number.
3569 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003570
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571#if defined(MBEDTLS_SSL_PROTO_DTLS)
3572 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003573 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003574 /* Copy explicit record sequence number from input buffer. */
3575 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3576 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003577 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003578 else
3579#endif /* MBEDTLS_SSL_PROTO_DTLS */
3580 {
3581 /* Copy implicit record sequence number from SSL context structure. */
3582 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3583 }
Paul Bakker40e46942009-01-03 21:51:57 +00003584
Hanno Beckere5e7e782019-07-11 12:29:35 +01003585 /*
3586 * Parse record length.
3587 */
3588
Hanno Beckere5e7e782019-07-11 12:29:35 +01003589 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003590 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3591 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003593
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003594 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003595 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596 rec->type,
3597 major_ver, minor_ver, rec->data_len ) );
3598
3599 rec->buf = buf;
3600 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003601
Hanno Beckerd417cc92019-07-26 08:20:27 +01003602 if( rec->data_len == 0 )
3603 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003604
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003605 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003606 * DTLS-related tests.
3607 * Check epoch before checking length constraint because
3608 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3609 * message gets duplicated before the corresponding Finished message,
3610 * the second ChangeCipherSpec should be discarded because it belongs
3611 * to an old epoch, but not because its length is shorter than
3612 * the minimum record length for packets using the new record transform.
3613 * Note that these two kinds of failures are handled differently,
3614 * as an unexpected record is silently skipped but an invalid
3615 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003616 */
3617#if defined(MBEDTLS_SSL_PROTO_DTLS)
3618 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3619 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003620 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003621
Hanno Becker955a5c92019-07-10 17:12:07 +01003622 /* Check that the datagram is large enough to contain a record
3623 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003624 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003625 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3627 (unsigned) len,
3628 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003629 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3630 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003631
Hanno Becker37cfe732019-07-10 17:20:01 +01003632 /* Records from other, non-matching epochs are silently discarded.
3633 * (The case of same-port Client reconnects must be considered in
3634 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003635 if( rec_epoch != ssl->in_epoch )
3636 {
3637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3638 "expected %d, received %d",
3639 ssl->in_epoch, rec_epoch ) );
3640
Hanno Becker552f7472019-07-19 10:59:12 +01003641 /* Records from the next epoch are considered for buffering
3642 * (concretely: early Finished messages). */
3643 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003644 {
Hanno Becker552f7472019-07-19 10:59:12 +01003645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3646 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003647 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003648
Hanno Becker2fddd372019-07-10 14:37:41 +01003649 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003650 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003651#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003652 /* For records from the correct epoch, check whether their
3653 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003654 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3655 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003656 {
3657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3658 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3659 }
3660#endif
3661 }
3662#endif /* MBEDTLS_SSL_PROTO_DTLS */
3663
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003664 return( 0 );
3665}
Paul Bakker5121ce52009-01-03 21:22:43 +00003666
Paul Bakker5121ce52009-01-03 21:22:43 +00003667
Hanno Becker2fddd372019-07-10 14:37:41 +01003668#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3669static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3670{
3671 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3672
3673 /*
3674 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3675 * access the first byte of record content (handshake type), as we
3676 * have an active transform (possibly iv_len != 0), so use the
3677 * fact that the record header len is 13 instead.
3678 */
3679 if( rec_epoch == 0 &&
3680 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3681 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3682 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3683 ssl->in_left > 13 &&
3684 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3685 {
3686 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3687 "from the same port" ) );
3688 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003689 }
3690
3691 return( 0 );
3692}
Hanno Becker2fddd372019-07-10 14:37:41 +01003693#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003694
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003695/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003696 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003697 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003698static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3699 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003700{
3701 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003703 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003704 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003706#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3707 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003708 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003711 ret = mbedtls_ssl_hw_record_read( ssl );
3712 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003713 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003714 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3715 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003716 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003717
3718 if( ret == 0 )
3719 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003720 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003722 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003723 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003724 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003725
Hanno Beckera18d1322018-01-03 14:27:32 +00003726 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003727 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003728 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003729 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003730
Hanno Beckera0e20d02019-05-15 14:03:01 +01003731#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003732 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3733 ssl->conf->ignore_unexpected_cid
3734 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3735 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003736 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003737 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003738 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003739#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003740
Paul Bakker5121ce52009-01-03 21:22:43 +00003741 return( ret );
3742 }
3743
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003744 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003745 {
3746 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003747 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003748 }
3749
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003750 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003751 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003752
Hanno Beckera0e20d02019-05-15 14:03:01 +01003753#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003754 /* We have already checked the record content type
3755 * in ssl_parse_record_header(), failing or silently
3756 * dropping the record in the case of an unknown type.
3757 *
3758 * Since with the use of CIDs, the record content type
3759 * might change during decryption, re-check the record
3760 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003761 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003762 {
3763 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3764 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3765 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003766#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003767
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003768 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003769 {
3770#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3771 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003772 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003773 {
3774 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3776 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3777 }
3778#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3779
3780 ssl->nb_zero++;
3781
3782 /*
3783 * Three or more empty messages may be a DoS attack
3784 * (excessive CPU consumption).
3785 */
3786 if( ssl->nb_zero > 3 )
3787 {
3788 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003789 "messages, possible DoS attack" ) );
3790 /* Treat the records as if they were not properly authenticated,
3791 * thereby failing the connection if we see more than allowed
3792 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003793 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3794 }
3795 }
3796 else
3797 ssl->nb_zero = 0;
3798
3799#if defined(MBEDTLS_SSL_PROTO_DTLS)
3800 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3801 {
3802 ; /* in_ctr read from peer, not maintained internally */
3803 }
3804 else
3805#endif
3806 {
3807 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003808 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003809 if( ++ssl->in_ctr[i - 1] != 0 )
3810 break;
3811
3812 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003813 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003814 {
3815 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3816 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3817 }
3818 }
3819
Paul Bakker5121ce52009-01-03 21:22:43 +00003820 }
3821
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003822#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003823 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003824 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003825 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003826 }
3827#endif
3828
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003829 /* Check actual (decrypted) record content length against
3830 * configured maximum. */
3831 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3832 {
3833 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3834 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3835 }
3836
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003837 return( 0 );
3838}
3839
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003840/*
3841 * Read a record.
3842 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003843 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3844 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3845 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003846 */
Hanno Becker1097b342018-08-15 14:09:41 +01003847
3848/* Helper functions for mbedtls_ssl_read_record(). */
3849static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003850static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3851static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003852
Hanno Becker327c93b2018-08-15 13:56:18 +01003853int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003854 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003855{
Janos Follath865b3eb2019-12-16 11:46:15 +00003856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003859
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003860 if( ssl->keep_current_message == 0 )
3861 {
3862 do {
Simon Butcher99000142016-10-13 17:21:01 +01003863
Hanno Becker26994592018-08-15 14:14:59 +01003864 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003865 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003866 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003867
Hanno Beckere74d5562018-08-15 14:26:08 +01003868 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003869 {
Hanno Becker40f50842018-08-15 14:48:01 +01003870#if defined(MBEDTLS_SSL_PROTO_DTLS)
3871 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003872
Hanno Becker40f50842018-08-15 14:48:01 +01003873 /* We only check for buffered messages if the
3874 * current datagram is fully consumed. */
3875 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003876 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003877 {
Hanno Becker40f50842018-08-15 14:48:01 +01003878 if( ssl_load_buffered_message( ssl ) == 0 )
3879 have_buffered = 1;
3880 }
3881
3882 if( have_buffered == 0 )
3883#endif /* MBEDTLS_SSL_PROTO_DTLS */
3884 {
3885 ret = ssl_get_next_record( ssl );
3886 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3887 continue;
3888
3889 if( ret != 0 )
3890 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003891 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003892 return( ret );
3893 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003894 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003895 }
3896
3897 ret = mbedtls_ssl_handle_message_type( ssl );
3898
Hanno Becker40f50842018-08-15 14:48:01 +01003899#if defined(MBEDTLS_SSL_PROTO_DTLS)
3900 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3901 {
3902 /* Buffer future message */
3903 ret = ssl_buffer_message( ssl );
3904 if( ret != 0 )
3905 return( ret );
3906
3907 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3908 }
3909#endif /* MBEDTLS_SSL_PROTO_DTLS */
3910
Hanno Becker90333da2017-10-10 11:27:13 +01003911 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3912 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003913
3914 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003915 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003916 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003917 return( ret );
3918 }
3919
Hanno Becker327c93b2018-08-15 13:56:18 +01003920 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003921 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003922 {
3923 mbedtls_ssl_update_handshake_status( ssl );
3924 }
Simon Butcher99000142016-10-13 17:21:01 +01003925 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003926 else
Simon Butcher99000142016-10-13 17:21:01 +01003927 {
Hanno Becker02f59072018-08-15 14:00:24 +01003928 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003929 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003930 }
3931
3932 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3933
3934 return( 0 );
3935}
3936
Hanno Becker40f50842018-08-15 14:48:01 +01003937#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003938static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003939{
Hanno Becker40f50842018-08-15 14:48:01 +01003940 if( ssl->in_left > ssl->next_record_offset )
3941 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003942
Hanno Becker40f50842018-08-15 14:48:01 +01003943 return( 0 );
3944}
3945
3946static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3947{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003948 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003949 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003950 int ret = 0;
3951
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003952 if( hs == NULL )
3953 return( -1 );
3954
Hanno Beckere00ae372018-08-20 09:39:42 +01003955 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3956
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003957 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3958 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3959 {
3960 /* Check if we have seen a ChangeCipherSpec before.
3961 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003962 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003963 {
3964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3965 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003966 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003967 }
3968
Hanno Becker39b8bc92018-08-28 17:17:13 +01003969 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003970 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3971 ssl->in_msglen = 1;
3972 ssl->in_msg[0] = 1;
3973
3974 /* As long as they are equal, the exact value doesn't matter. */
3975 ssl->in_left = 0;
3976 ssl->next_record_offset = 0;
3977
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003978 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003979 goto exit;
3980 }
Hanno Becker37f95322018-08-16 13:55:32 +01003981
Hanno Beckerb8f50142018-08-28 10:01:34 +01003982#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003983 /* Debug only */
3984 {
3985 unsigned offset;
3986 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3987 {
3988 hs_buf = &hs->buffering.hs[offset];
3989 if( hs_buf->is_valid == 1 )
3990 {
3991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3992 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003993 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003994 }
3995 }
3996 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003997#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003998
3999 /* Check if we have buffered and/or fully reassembled the
4000 * next handshake message. */
4001 hs_buf = &hs->buffering.hs[0];
4002 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4003 {
4004 /* Synthesize a record containing the buffered HS message. */
4005 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4006 ( hs_buf->data[2] << 8 ) |
4007 hs_buf->data[3];
4008
4009 /* Double-check that we haven't accidentally buffered
4010 * a message that doesn't fit into the input buffer. */
4011 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4012 {
4013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4014 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4015 }
4016
4017 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4018 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4019 hs_buf->data, msg_len + 12 );
4020
4021 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4022 ssl->in_hslen = msg_len + 12;
4023 ssl->in_msglen = msg_len + 12;
4024 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4025
4026 ret = 0;
4027 goto exit;
4028 }
4029 else
4030 {
4031 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4032 hs->in_msg_seq ) );
4033 }
4034
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004035 ret = -1;
4036
4037exit:
4038
4039 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4040 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004041}
4042
Hanno Beckera02b0b42018-08-21 17:20:27 +01004043static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4044 size_t desired )
4045{
4046 int offset;
4047 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4049 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004050
Hanno Becker01315ea2018-08-21 17:22:17 +01004051 /* Get rid of future records epoch first, if such exist. */
4052 ssl_free_buffered_record( ssl );
4053
4054 /* Check if we have enough space available now. */
4055 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4056 hs->buffering.total_bytes_buffered ) )
4057 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004058 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004059 return( 0 );
4060 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004061
Hanno Becker4f432ad2018-08-28 10:02:32 +01004062 /* We don't have enough space to buffer the next expected handshake
4063 * message. Remove buffers used for future messages to gain space,
4064 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004065 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4066 offset >= 0; offset-- )
4067 {
4068 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4069 offset ) );
4070
Hanno Beckerb309b922018-08-23 13:18:05 +01004071 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004072
4073 /* Check if we have enough space available now. */
4074 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4075 hs->buffering.total_bytes_buffered ) )
4076 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004077 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004078 return( 0 );
4079 }
4080 }
4081
4082 return( -1 );
4083}
4084
Hanno Becker40f50842018-08-15 14:48:01 +01004085static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4086{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004087 int ret = 0;
4088 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4089
4090 if( hs == NULL )
4091 return( 0 );
4092
4093 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4094
4095 switch( ssl->in_msgtype )
4096 {
4097 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004099
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004100 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004101 break;
4102
4103 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004104 {
4105 unsigned recv_msg_seq_offset;
4106 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4107 mbedtls_ssl_hs_buffer *hs_buf;
4108 size_t msg_len = ssl->in_hslen - 12;
4109
4110 /* We should never receive an old handshake
4111 * message - double-check nonetheless. */
4112 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4113 {
4114 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4115 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4116 }
4117
4118 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4119 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4120 {
4121 /* Silently ignore -- message too far in the future */
4122 MBEDTLS_SSL_DEBUG_MSG( 2,
4123 ( "Ignore future HS message with sequence number %u, "
4124 "buffering window %u - %u",
4125 recv_msg_seq, ssl->handshake->in_msg_seq,
4126 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4127
4128 goto exit;
4129 }
4130
4131 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4132 recv_msg_seq, recv_msg_seq_offset ) );
4133
4134 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4135
4136 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004137 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004138 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004139 size_t reassembly_buf_sz;
4140
Hanno Becker37f95322018-08-16 13:55:32 +01004141 hs_buf->is_fragmented =
4142 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4143
4144 /* We copy the message back into the input buffer
4145 * after reassembly, so check that it's not too large.
4146 * This is an implementation-specific limitation
4147 * and not one from the standard, hence it is not
4148 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004149 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004150 {
4151 /* Ignore message */
4152 goto exit;
4153 }
4154
Hanno Beckere0b150f2018-08-21 15:51:03 +01004155 /* Check if we have enough space to buffer the message. */
4156 if( hs->buffering.total_bytes_buffered >
4157 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4158 {
4159 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4160 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4161 }
4162
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004163 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4164 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004165
4166 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4167 hs->buffering.total_bytes_buffered ) )
4168 {
4169 if( recv_msg_seq_offset > 0 )
4170 {
4171 /* If we can't buffer a future message because
4172 * of space limitations -- ignore. */
4173 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",
4174 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4175 (unsigned) hs->buffering.total_bytes_buffered ) );
4176 goto exit;
4177 }
Hanno Beckere1801392018-08-21 16:51:05 +01004178 else
4179 {
4180 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",
4181 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4182 (unsigned) hs->buffering.total_bytes_buffered ) );
4183 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004184
Hanno Beckera02b0b42018-08-21 17:20:27 +01004185 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004186 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004187 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",
4188 (unsigned) msg_len,
4189 (unsigned) reassembly_buf_sz,
4190 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004191 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004192 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4193 goto exit;
4194 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004195 }
4196
4197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4198 msg_len ) );
4199
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004200 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4201 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004202 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004203 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004204 goto exit;
4205 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004206 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004207
4208 /* Prepare final header: copy msg_type, length and message_seq,
4209 * then add standardised fragment_offset and fragment_length */
4210 memcpy( hs_buf->data, ssl->in_msg, 6 );
4211 memset( hs_buf->data + 6, 0, 3 );
4212 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4213
4214 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004215
4216 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004217 }
4218 else
4219 {
4220 /* Make sure msg_type and length are consistent */
4221 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4222 {
4223 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4224 /* Ignore */
4225 goto exit;
4226 }
4227 }
4228
Hanno Becker4422bbb2018-08-20 09:40:19 +01004229 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004230 {
4231 size_t frag_len, frag_off;
4232 unsigned char * const msg = hs_buf->data + 12;
4233
4234 /*
4235 * Check and copy current fragment
4236 */
4237
4238 /* Validation of header fields already done in
4239 * mbedtls_ssl_prepare_handshake_record(). */
4240 frag_off = ssl_get_hs_frag_off( ssl );
4241 frag_len = ssl_get_hs_frag_len( ssl );
4242
4243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4244 frag_off, frag_len ) );
4245 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4246
4247 if( hs_buf->is_fragmented )
4248 {
4249 unsigned char * const bitmask = msg + msg_len;
4250 ssl_bitmask_set( bitmask, frag_off, frag_len );
4251 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4252 msg_len ) == 0 );
4253 }
4254 else
4255 {
4256 hs_buf->is_complete = 1;
4257 }
4258
4259 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4260 hs_buf->is_complete ? "" : "not yet " ) );
4261 }
4262
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004263 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004264 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004265
4266 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004267 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004268 break;
4269 }
4270
4271exit:
4272
4273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4274 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004275}
4276#endif /* MBEDTLS_SSL_PROTO_DTLS */
4277
Hanno Becker1097b342018-08-15 14:09:41 +01004278static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004279{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004280 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004281 * Consume last content-layer message and potentially
4282 * update in_msglen which keeps track of the contents'
4283 * consumption state.
4284 *
4285 * (1) Handshake messages:
4286 * Remove last handshake message, move content
4287 * and adapt in_msglen.
4288 *
4289 * (2) Alert messages:
4290 * Consume whole record content, in_msglen = 0.
4291 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004292 * (3) Change cipher spec:
4293 * Consume whole record content, in_msglen = 0.
4294 *
4295 * (4) Application data:
4296 * Don't do anything - the record layer provides
4297 * the application data as a stream transport
4298 * and consumes through mbedtls_ssl_read only.
4299 *
4300 */
4301
4302 /* Case (1): Handshake messages */
4303 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004304 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004305 /* Hard assertion to be sure that no application data
4306 * is in flight, as corrupting ssl->in_msglen during
4307 * ssl->in_offt != NULL is fatal. */
4308 if( ssl->in_offt != NULL )
4309 {
4310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4311 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4312 }
4313
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004314 /*
4315 * Get next Handshake message in the current record
4316 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004317
Hanno Becker4a810fb2017-05-24 16:27:30 +01004318 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004319 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004320 * current handshake content: If DTLS handshake
4321 * fragmentation is used, that's the fragment
4322 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004323 * size here is faulty and should be changed at
4324 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004325 * (2) While it doesn't seem to cause problems, one
4326 * has to be very careful not to assume that in_hslen
4327 * is always <= in_msglen in a sensible communication.
4328 * Again, it's wrong for DTLS handshake fragmentation.
4329 * The following check is therefore mandatory, and
4330 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004331 * Additionally, ssl->in_hslen might be arbitrarily out of
4332 * bounds after handling a DTLS message with an unexpected
4333 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004334 */
4335 if( ssl->in_hslen < ssl->in_msglen )
4336 {
4337 ssl->in_msglen -= ssl->in_hslen;
4338 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4339 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004340
Hanno Becker4a810fb2017-05-24 16:27:30 +01004341 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4342 ssl->in_msg, ssl->in_msglen );
4343 }
4344 else
4345 {
4346 ssl->in_msglen = 0;
4347 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004348
Hanno Becker4a810fb2017-05-24 16:27:30 +01004349 ssl->in_hslen = 0;
4350 }
4351 /* Case (4): Application data */
4352 else if( ssl->in_offt != NULL )
4353 {
4354 return( 0 );
4355 }
4356 /* Everything else (CCS & Alerts) */
4357 else
4358 {
4359 ssl->in_msglen = 0;
4360 }
4361
Hanno Becker1097b342018-08-15 14:09:41 +01004362 return( 0 );
4363}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004364
Hanno Beckere74d5562018-08-15 14:26:08 +01004365static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4366{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004367 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004368 return( 1 );
4369
4370 return( 0 );
4371}
4372
Hanno Becker5f066e72018-08-16 14:56:31 +01004373#if defined(MBEDTLS_SSL_PROTO_DTLS)
4374
4375static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4376{
4377 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4378 if( hs == NULL )
4379 return;
4380
Hanno Becker01315ea2018-08-21 17:22:17 +01004381 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004383 hs->buffering.total_bytes_buffered -=
4384 hs->buffering.future_record.len;
4385
4386 mbedtls_free( hs->buffering.future_record.data );
4387 hs->buffering.future_record.data = NULL;
4388 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004389}
4390
4391static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4392{
4393 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4394 unsigned char * rec;
4395 size_t rec_len;
4396 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004397#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4398 size_t in_buf_len = ssl->in_buf_len;
4399#else
4400 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4401#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004402 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4403 return( 0 );
4404
4405 if( hs == NULL )
4406 return( 0 );
4407
Hanno Becker5f066e72018-08-16 14:56:31 +01004408 rec = hs->buffering.future_record.data;
4409 rec_len = hs->buffering.future_record.len;
4410 rec_epoch = hs->buffering.future_record.epoch;
4411
4412 if( rec == NULL )
4413 return( 0 );
4414
Hanno Becker4cb782d2018-08-20 11:19:05 +01004415 /* Only consider loading future records if the
4416 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004417 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004418 return( 0 );
4419
Hanno Becker5f066e72018-08-16 14:56:31 +01004420 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4421
4422 if( rec_epoch != ssl->in_epoch )
4423 {
4424 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4425 goto exit;
4426 }
4427
4428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4429
4430 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004431 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004432 {
4433 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4434 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4435 }
4436
4437 memcpy( ssl->in_hdr, rec, rec_len );
4438 ssl->in_left = rec_len;
4439 ssl->next_record_offset = 0;
4440
4441 ssl_free_buffered_record( ssl );
4442
4443exit:
4444 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4445 return( 0 );
4446}
4447
Hanno Becker519f15d2019-07-11 12:43:20 +01004448static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4449 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004450{
4451 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004452
4453 /* Don't buffer future records outside handshakes. */
4454 if( hs == NULL )
4455 return( 0 );
4456
4457 /* Only buffer handshake records (we are only interested
4458 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004459 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004460 return( 0 );
4461
4462 /* Don't buffer more than one future epoch record. */
4463 if( hs->buffering.future_record.data != NULL )
4464 return( 0 );
4465
Hanno Becker01315ea2018-08-21 17:22:17 +01004466 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004467 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004468 hs->buffering.total_bytes_buffered ) )
4469 {
4470 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 +01004471 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004472 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004473 return( 0 );
4474 }
4475
Hanno Becker5f066e72018-08-16 14:56:31 +01004476 /* Buffer record */
4477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4478 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004479 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004480
4481 /* ssl_parse_record_header() only considers records
4482 * of the next epoch as candidates for buffering. */
4483 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004484 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004485
4486 hs->buffering.future_record.data =
4487 mbedtls_calloc( 1, hs->buffering.future_record.len );
4488 if( hs->buffering.future_record.data == NULL )
4489 {
4490 /* If we run out of RAM trying to buffer a
4491 * record from the next epoch, just ignore. */
4492 return( 0 );
4493 }
4494
Hanno Becker519f15d2019-07-11 12:43:20 +01004495 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004496
Hanno Becker519f15d2019-07-11 12:43:20 +01004497 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004498 return( 0 );
4499}
4500
4501#endif /* MBEDTLS_SSL_PROTO_DTLS */
4502
Hanno Beckere74d5562018-08-15 14:26:08 +01004503static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004504{
Janos Follath865b3eb2019-12-16 11:46:15 +00004505 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004506 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004507
Hanno Becker5f066e72018-08-16 14:56:31 +01004508#if defined(MBEDTLS_SSL_PROTO_DTLS)
4509 /* We might have buffered a future record; if so,
4510 * and if the epoch matches now, load it.
4511 * On success, this call will set ssl->in_left to
4512 * the length of the buffered record, so that
4513 * the calls to ssl_fetch_input() below will
4514 * essentially be no-ops. */
4515 ret = ssl_load_buffered_record( ssl );
4516 if( ret != 0 )
4517 return( ret );
4518#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004519
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004520 /* Ensure that we have enough space available for the default form
4521 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4522 * with no space for CIDs counted in). */
4523 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4524 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004525 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004526 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004527 return( ret );
4528 }
4529
Hanno Beckere5e7e782019-07-11 12:29:35 +01004530 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4531 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004532 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004534 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004535 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004536 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4537 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004538 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004539 if( ret != 0 )
4540 return( ret );
4541
4542 /* Fall through to handling of unexpected records */
4543 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4544 }
4545
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004546 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4547 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004548#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004549 /* Reset in pointers to default state for TLS/DTLS records,
4550 * assuming no CID and no offset between record content and
4551 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004552 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004553
Hanno Becker7ae20e02019-07-12 08:33:49 +01004554 /* Setup internal message pointers from record structure. */
4555 ssl->in_msgtype = rec.type;
4556#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4557 ssl->in_len = ssl->in_cid + rec.cid_len;
4558#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4559 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4560 ssl->in_msglen = rec.data_len;
4561
Hanno Becker2fddd372019-07-10 14:37:41 +01004562 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004563 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004564 if( ret != 0 )
4565 return( ret );
4566#endif
4567
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004568 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004569 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004570
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004571 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4572 "(header)" ) );
4573 }
4574 else
4575 {
4576 /* Skip invalid record and the rest of the datagram */
4577 ssl->next_record_offset = 0;
4578 ssl->in_left = 0;
4579
4580 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4581 "(header)" ) );
4582 }
4583
4584 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004585 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004586 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004587 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004588#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004589 {
4590 return( ret );
4591 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004592 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004595 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004596 {
Hanno Beckera8814792019-07-10 15:01:45 +01004597 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004598 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004599 if( ssl->next_record_offset < ssl->in_left )
4600 {
4601 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4602 }
4603 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004604 else
4605#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004606 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004607 /*
4608 * Fetch record contents from underlying transport.
4609 */
Hanno Beckera3175662019-07-11 12:50:29 +01004610 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004611 if( ret != 0 )
4612 {
4613 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4614 return( ret );
4615 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004616
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004617 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004618 }
4619
4620 /*
4621 * Decrypt record contents.
4622 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004623
Hanno Beckerfdf66042019-07-11 13:07:45 +01004624 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004625 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004626#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004627 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004628 {
4629 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004630 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004631 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004632 /* Except when waiting for Finished as a bad mac here
4633 * probably means something went wrong in the handshake
4634 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4635 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4636 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4637 {
4638#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4639 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4640 {
4641 mbedtls_ssl_send_alert_message( ssl,
4642 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4643 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4644 }
4645#endif
4646 return( ret );
4647 }
4648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004650 if( ssl->conf->badmac_limit != 0 &&
4651 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004652 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4654 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004655 }
4656#endif
4657
Hanno Becker4a810fb2017-05-24 16:27:30 +01004658 /* As above, invalid records cause
4659 * dismissal of the whole datagram. */
4660
4661 ssl->next_record_offset = 0;
4662 ssl->in_left = 0;
4663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004664 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004665 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004666 }
4667
4668 return( ret );
4669 }
4670 else
4671#endif
4672 {
4673 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004674#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4675 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004677 mbedtls_ssl_send_alert_message( ssl,
4678 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4679 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004680 }
4681#endif
4682 return( ret );
4683 }
4684 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004685
Hanno Becker44d89b22019-07-12 09:40:44 +01004686
4687 /* Reset in pointers to default state for TLS/DTLS records,
4688 * assuming no CID and no offset between record content and
4689 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004690 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004691#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4692 ssl->in_len = ssl->in_cid + rec.cid_len;
4693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004694 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004695
Hanno Becker8685c822019-07-12 09:37:30 +01004696 /* The record content type may change during decryption,
4697 * so re-read it. */
4698 ssl->in_msgtype = rec.type;
4699 /* Also update the input buffer, because unfortunately
4700 * the server-side ssl_parse_client_hello() reparses the
4701 * record header when receiving a ClientHello initiating
4702 * a renegotiation. */
4703 ssl->in_hdr[0] = rec.type;
4704 ssl->in_msg = rec.buf + rec.data_offset;
4705 ssl->in_msglen = rec.data_len;
4706 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4707 ssl->in_len[1] = (unsigned char)( rec.data_len );
4708
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004709#if defined(MBEDTLS_ZLIB_SUPPORT)
4710 if( ssl->transform_in != NULL &&
4711 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4712 {
4713 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4714 {
4715 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4716 return( ret );
4717 }
4718
4719 /* Check actual (decompress) record content length against
4720 * configured maximum. */
4721 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4722 {
4723 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4724 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4725 }
4726 }
4727#endif /* MBEDTLS_ZLIB_SUPPORT */
4728
Simon Butcher99000142016-10-13 17:21:01 +01004729 return( 0 );
4730}
4731
4732int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4733{
Janos Follath865b3eb2019-12-16 11:46:15 +00004734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004735
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004736 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004737 * Handle particular types of records
4738 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004739 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004740 {
Simon Butcher99000142016-10-13 17:21:01 +01004741 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4742 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004743 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004744 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004745 }
4746
Hanno Beckere678eaa2018-08-21 14:57:46 +01004747 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004748 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004749 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004750 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004751 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4752 ssl->in_msglen ) );
4753 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004754 }
4755
Hanno Beckere678eaa2018-08-21 14:57:46 +01004756 if( ssl->in_msg[0] != 1 )
4757 {
4758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4759 ssl->in_msg[0] ) );
4760 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4761 }
4762
4763#if defined(MBEDTLS_SSL_PROTO_DTLS)
4764 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4765 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4766 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4767 {
4768 if( ssl->handshake == NULL )
4769 {
4770 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4771 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4772 }
4773
4774 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4775 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4776 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004777#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004778 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004780 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004781 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004782 if( ssl->in_msglen != 2 )
4783 {
4784 /* Note: Standard allows for more than one 2 byte alert
4785 to be packed in a single message, but Mbed TLS doesn't
4786 currently support this. */
4787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4788 ssl->in_msglen ) );
4789 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4790 }
4791
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004793 ssl->in_msg[0], ssl->in_msg[1] ) );
4794
4795 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004796 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004799 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004801 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004803 }
4804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004805 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4806 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4809 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004810 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004811
4812#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4813 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4814 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4815 {
Hanno Becker90333da2017-10-10 11:27:13 +01004816 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004817 /* Will be handled when trying to parse ServerHello */
4818 return( 0 );
4819 }
4820#endif
4821
4822#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4823 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4824 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4825 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4826 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4827 {
4828 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4829 /* Will be handled in mbedtls_ssl_parse_certificate() */
4830 return( 0 );
4831 }
4832#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4833
4834 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004835 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004836 }
4837
Hanno Beckerc76c6192017-06-06 10:03:17 +01004838#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004839 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004840 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004841 /* Drop unexpected ApplicationData records,
4842 * except at the beginning of renegotiations */
4843 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4844 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4845#if defined(MBEDTLS_SSL_RENEGOTIATION)
4846 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4847 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004848#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004849 )
4850 {
4851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4852 return( MBEDTLS_ERR_SSL_NON_FATAL );
4853 }
4854
4855 if( ssl->handshake != NULL &&
4856 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4857 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004858 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004859 }
4860 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004861#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004862
Paul Bakker5121ce52009-01-03 21:22:43 +00004863 return( 0 );
4864}
4865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004867{
irwir6c0da642019-09-26 21:07:41 +03004868 return( mbedtls_ssl_send_alert_message( ssl,
4869 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4870 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004871}
4872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004873int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004874 unsigned char level,
4875 unsigned char message )
4876{
Janos Follath865b3eb2019-12-16 11:46:15 +00004877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004878
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004879 if( ssl == NULL || ssl->conf == NULL )
4880 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004882 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004883 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004885 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004886 ssl->out_msglen = 2;
4887 ssl->out_msg[0] = level;
4888 ssl->out_msg[1] = message;
4889
Hanno Becker67bc7c32018-08-06 11:33:50 +01004890 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004891 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004892 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004893 return( ret );
4894 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004895 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004896
4897 return( 0 );
4898}
4899
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004900int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004901{
Janos Follath865b3eb2019-12-16 11:46:15 +00004902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004905
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004906 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004907 ssl->out_msglen = 1;
4908 ssl->out_msg[0] = 1;
4909
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 ssl->state++;
4911
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004912 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004913 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004914 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004915 return( ret );
4916 }
4917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004918 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004919
4920 return( 0 );
4921}
4922
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004924{
Janos Follath865b3eb2019-12-16 11:46:15 +00004925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004927 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004928
Hanno Becker327c93b2018-08-15 13:56:18 +01004929 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004930 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004932 return( ret );
4933 }
4934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004936 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004938 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4939 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004940 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004941 }
4942
Hanno Beckere678eaa2018-08-21 14:57:46 +01004943 /* CCS records are only accepted if they have length 1 and content '1',
4944 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004945
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004946 /*
4947 * Switch to our negotiated transform and session parameters for inbound
4948 * data.
4949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004950 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004951 ssl->transform_in = ssl->transform_negotiate;
4952 ssl->session_in = ssl->session_negotiate;
4953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004954#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004955 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004956 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004957#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004958 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004959#endif
4960
4961 /* Increment epoch */
4962 if( ++ssl->in_epoch == 0 )
4963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004965 /* This is highly unlikely to happen for legitimate reasons, so
4966 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004967 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004968 }
4969 }
4970 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004971#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004972 memset( ssl->in_ctr, 0, 8 );
4973
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004974 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004975
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004976#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4977 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004978 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004979 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004980 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004981 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004982 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4983 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004984 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004985 }
4986 }
4987#endif
4988
Paul Bakker5121ce52009-01-03 21:22:43 +00004989 ssl->state++;
4990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004992
4993 return( 0 );
4994}
4995
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004996/* Once ssl->out_hdr as the address of the beginning of the
4997 * next outgoing record is set, deduce the other pointers.
4998 *
4999 * Note: For TLS, we save the implicit record sequence number
5000 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5001 * and the caller has to make sure there's space for this.
5002 */
5003
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005004static size_t ssl_transform_get_explicit_iv_len(
5005 mbedtls_ssl_transform const *transform )
5006{
5007 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5008 return( 0 );
5009
5010 return( transform->ivlen - transform->fixed_ivlen );
5011}
5012
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005013void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5014 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005015{
5016#if defined(MBEDTLS_SSL_PROTO_DTLS)
5017 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5018 {
5019 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005020#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005021 ssl->out_cid = ssl->out_ctr + 8;
5022 ssl->out_len = ssl->out_cid;
5023 if( transform != NULL )
5024 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005025#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005026 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005027#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005028 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005029 }
5030 else
5031#endif
5032 {
5033 ssl->out_ctr = ssl->out_hdr - 8;
5034 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005035#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005036 ssl->out_cid = ssl->out_len;
5037#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005038 ssl->out_iv = ssl->out_hdr + 5;
5039 }
5040
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005041 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005042 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005043 if( transform != NULL )
5044 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005045}
5046
5047/* Once ssl->in_hdr as the address of the beginning of the
5048 * next incoming record is set, deduce the other pointers.
5049 *
5050 * Note: For TLS, we save the implicit record sequence number
5051 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5052 * and the caller has to make sure there's space for this.
5053 */
5054
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005055void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005056{
Hanno Becker79594fd2019-05-08 09:38:41 +01005057 /* This function sets the pointers to match the case
5058 * of unprotected TLS/DTLS records, with both ssl->in_iv
5059 * and ssl->in_msg pointing to the beginning of the record
5060 * content.
5061 *
5062 * When decrypting a protected record, ssl->in_msg
5063 * will be shifted to point to the beginning of the
5064 * record plaintext.
5065 */
5066
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005067#if defined(MBEDTLS_SSL_PROTO_DTLS)
5068 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5069 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005070 /* This sets the header pointers to match records
5071 * without CID. When we receive a record containing
5072 * a CID, the fields are shifted accordingly in
5073 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005074 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005076 ssl->in_cid = ssl->in_ctr + 8;
5077 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005078#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005079 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005080#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005081 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005082 }
5083 else
5084#endif
5085 {
5086 ssl->in_ctr = ssl->in_hdr - 8;
5087 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005088#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005089 ssl->in_cid = ssl->in_len;
5090#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005091 ssl->in_iv = ssl->in_hdr + 5;
5092 }
5093
Hanno Becker79594fd2019-05-08 09:38:41 +01005094 /* This will be adjusted at record decryption time. */
5095 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005096}
5097
Paul Bakker5121ce52009-01-03 21:22:43 +00005098/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005099 * Setup an SSL context
5100 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005101
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005102void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005103{
5104 /* Set the incoming and outgoing record pointers. */
5105#if defined(MBEDTLS_SSL_PROTO_DTLS)
5106 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5107 {
5108 ssl->out_hdr = ssl->out_buf;
5109 ssl->in_hdr = ssl->in_buf;
5110 }
5111 else
5112#endif /* MBEDTLS_SSL_PROTO_DTLS */
5113 {
5114 ssl->out_hdr = ssl->out_buf + 8;
5115 ssl->in_hdr = ssl->in_buf + 8;
5116 }
5117
5118 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005119 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5120 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005121}
5122
Paul Bakker5121ce52009-01-03 21:22:43 +00005123/*
5124 * SSL get accessors
5125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005126size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005127{
5128 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5129}
5130
Hanno Becker8b170a02017-10-10 11:51:19 +01005131int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5132{
5133 /*
5134 * Case A: We're currently holding back
5135 * a message for further processing.
5136 */
5137
5138 if( ssl->keep_current_message == 1 )
5139 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005140 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005141 return( 1 );
5142 }
5143
5144 /*
5145 * Case B: Further records are pending in the current datagram.
5146 */
5147
5148#if defined(MBEDTLS_SSL_PROTO_DTLS)
5149 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5150 ssl->in_left > ssl->next_record_offset )
5151 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005152 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005153 return( 1 );
5154 }
5155#endif /* MBEDTLS_SSL_PROTO_DTLS */
5156
5157 /*
5158 * Case C: A handshake message is being processed.
5159 */
5160
Hanno Becker8b170a02017-10-10 11:51:19 +01005161 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5162 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005164 return( 1 );
5165 }
5166
5167 /*
5168 * Case D: An application data message is being processed
5169 */
5170 if( ssl->in_offt != NULL )
5171 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005172 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005173 return( 1 );
5174 }
5175
5176 /*
5177 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005178 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005179 * we implement support for multiple alerts in single records.
5180 */
5181
5182 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5183 return( 0 );
5184}
5185
Paul Bakker43ca69c2011-01-15 17:35:19 +00005186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005188{
Hanno Becker3136ede2018-08-17 15:28:19 +01005189 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005190 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005191 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005192
Hanno Becker5903de42019-05-03 14:46:38 +01005193 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5194
Hanno Becker78640902018-08-13 16:35:15 +01005195 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005196 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005198#if defined(MBEDTLS_ZLIB_SUPPORT)
5199 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5200 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005201#endif
5202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005203 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005204 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005205 case MBEDTLS_MODE_GCM:
5206 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005207 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005208 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005209 transform_expansion = transform->minlen;
5210 break;
5211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005212 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005213
5214 block_size = mbedtls_cipher_get_block_size(
5215 &transform->cipher_ctx_enc );
5216
Hanno Becker3136ede2018-08-17 15:28:19 +01005217 /* Expansion due to the addition of the MAC. */
5218 transform_expansion += transform->maclen;
5219
5220 /* Expansion due to the addition of CBC padding;
5221 * Theoretically up to 256 bytes, but we never use
5222 * more than the block size of the underlying cipher. */
5223 transform_expansion += block_size;
5224
5225 /* For TLS 1.1 or higher, an explicit IV is added
5226 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005227#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5228 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005229 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005230#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005231
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005232 break;
5233
5234 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005235 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005236 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005237 }
5238
Hanno Beckera0e20d02019-05-15 14:03:01 +01005239#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005240 if( transform->out_cid_len != 0 )
5241 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005242#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005243
Hanno Becker5903de42019-05-03 14:46:38 +01005244 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005245}
5246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005247#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005248/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005249 * Check record counters and renegotiate if they're above the limit.
5250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005251static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005252{
Hanno Beckerdd772292020-02-05 10:38:31 +00005253 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005254 int in_ctr_cmp;
5255 int out_ctr_cmp;
5256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005257 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5258 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005259 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005260 {
5261 return( 0 );
5262 }
5263
Andres AG2196c7f2016-12-15 17:01:16 +00005264 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5265 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005266 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005267 ssl->conf->renego_period + ep_len, 8 - ep_len );
5268
5269 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005270 {
5271 return( 0 );
5272 }
5273
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005274 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005275 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005276}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005277#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005278
5279/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005280 * Receive application data decrypted from the SSL layer
5281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005282int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005283{
Janos Follath865b3eb2019-12-16 11:46:15 +00005284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005285 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005286
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005287 if( ssl == NULL || ssl->conf == NULL )
5288 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5289
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005292#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005293 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005294 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005295 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005296 return( ret );
5297
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005298 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005299 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005300 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005301 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005302 return( ret );
5303 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005304 }
5305#endif
5306
Hanno Becker4a810fb2017-05-24 16:27:30 +01005307 /*
5308 * Check if renegotiation is necessary and/or handshake is
5309 * in process. If yes, perform/continue, and fall through
5310 * if an unexpected packet is received while the client
5311 * is waiting for the ServerHello.
5312 *
5313 * (There is no equivalent to the last condition on
5314 * the server-side as it is not treated as within
5315 * a handshake while waiting for the ClientHello
5316 * after a renegotiation request.)
5317 */
5318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005319#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005320 ret = ssl_check_ctr_renegotiate( ssl );
5321 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5322 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005324 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005325 return( ret );
5326 }
5327#endif
5328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005330 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005331 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005332 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5333 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005334 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005335 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005336 return( ret );
5337 }
5338 }
5339
Hanno Beckere41158b2017-10-23 13:30:32 +01005340 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005341 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005342 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005343 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005344 if( ssl->f_get_timer != NULL &&
5345 ssl->f_get_timer( ssl->p_timer ) == -1 )
5346 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005347 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005348 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005349
Hanno Becker327c93b2018-08-15 13:56:18 +01005350 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005351 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005352 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5353 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005354
Hanno Becker4a810fb2017-05-24 16:27:30 +01005355 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5356 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005357 }
5358
5359 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005361 {
5362 /*
5363 * OpenSSL sends empty messages to randomize the IV
5364 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005365 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005366 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005367 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005368 return( 0 );
5369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005370 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005371 return( ret );
5372 }
5373 }
5374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005375 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005376 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005377 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005378
Hanno Becker4a810fb2017-05-24 16:27:30 +01005379 /*
5380 * - For client-side, expect SERVER_HELLO_REQUEST.
5381 * - For server-side, expect CLIENT_HELLO.
5382 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5383 */
5384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005386 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005387 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005388 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005391
5392 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005394 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005395 {
5396 continue;
5397 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005398#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005400 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005401#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005402
Hanno Becker4a810fb2017-05-24 16:27:30 +01005403#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005404 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005405 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005406 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005407 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005408
5409 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005410#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005411 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005412 {
5413 continue;
5414 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005415#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005417 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005418#endif /* MBEDTLS_SSL_SRV_C */
5419
Hanno Becker21df7f92017-10-17 11:03:26 +01005420#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005421 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005422 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5423 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5424 ssl->conf->allow_legacy_renegotiation ==
5425 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5426 {
5427 /*
5428 * Accept renegotiation request
5429 */
Paul Bakker48916f92012-09-16 19:57:18 +00005430
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005431 /* DTLS clients need to know renego is server-initiated */
5432#if defined(MBEDTLS_SSL_PROTO_DTLS)
5433 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5434 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5435 {
5436 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5437 }
5438#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005439 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005440 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5441 ret != 0 )
5442 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005443 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5444 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005445 return( ret );
5446 }
5447 }
5448 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005449#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005450 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005451 /*
5452 * Refuse renegotiation
5453 */
5454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005455 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457#if defined(MBEDTLS_SSL_PROTO_SSL3)
5458 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005459 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005460 /* SSLv3 does not have a "no_renegotiation" warning, so
5461 we send a fatal alert and abort the connection. */
5462 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5463 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5464 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005465 }
5466 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005467#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5468#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5469 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5470 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005471 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005472 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5473 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5474 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005475 {
5476 return( ret );
5477 }
Paul Bakker48916f92012-09-16 19:57:18 +00005478 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005479 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5481 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005482 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5484 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005485 }
Paul Bakker48916f92012-09-16 19:57:18 +00005486 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005487
Hanno Becker90333da2017-10-10 11:27:13 +01005488 /* At this point, we don't know whether the renegotiation has been
5489 * completed or not. The cases to consider are the following:
5490 * 1) The renegotiation is complete. In this case, no new record
5491 * has been read yet.
5492 * 2) The renegotiation is incomplete because the client received
5493 * an application data record while awaiting the ServerHello.
5494 * 3) The renegotiation is incomplete because the client received
5495 * a non-handshake, non-application data message while awaiting
5496 * the ServerHello.
5497 * In each of these case, looping will be the proper action:
5498 * - For 1), the next iteration will read a new record and check
5499 * if it's application data.
5500 * - For 2), the loop condition isn't satisfied as application data
5501 * is present, hence continue is the same as break
5502 * - For 3), the loop condition is satisfied and read_record
5503 * will re-deliver the message that was held back by the client
5504 * when expecting the ServerHello.
5505 */
5506 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005507 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005508#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005510 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005511 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005512 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005513 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005514 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005516 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005517 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005518 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005519 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005520 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005523 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5524 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005525 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005527 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005528 }
5529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005530 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5533 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005534 }
5535
5536 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005537
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005538 /* We're going to return something now, cancel timer,
5539 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005540 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005541 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005542
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005543#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005544 /* If we requested renego but received AppData, resend HelloRequest.
5545 * Do it now, after setting in_offt, to avoid taking this branch
5546 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005548 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005550 {
Hanno Becker786300f2020-02-05 10:46:40 +00005551 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005552 {
Hanno Becker786300f2020-02-05 10:46:40 +00005553 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5554 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005555 return( ret );
5556 }
5557 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005558#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005559#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005560 }
5561
5562 n = ( len < ssl->in_msglen )
5563 ? len : ssl->in_msglen;
5564
5565 memcpy( buf, ssl->in_offt, n );
5566 ssl->in_msglen -= n;
5567
5568 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005569 {
5570 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005571 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005572 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005573 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005574 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005575 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005576 /* more data available */
5577 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005578 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005581
Paul Bakker23986e52011-04-24 08:57:21 +00005582 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005583}
5584
5585/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005586 * Send application data to be encrypted by the SSL layer, taking care of max
5587 * fragment length and buffer size.
5588 *
5589 * According to RFC 5246 Section 6.2.1:
5590 *
5591 * Zero-length fragments of Application data MAY be sent as they are
5592 * potentially useful as a traffic analysis countermeasure.
5593 *
5594 * Therefore, it is possible that the input message length is 0 and the
5595 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005596 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005597static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005598 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005599{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005600 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5601 const size_t max_len = (size_t) ret;
5602
5603 if( ret < 0 )
5604 {
5605 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5606 return( ret );
5607 }
5608
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005609 if( len > max_len )
5610 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005612 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005613 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005615 "maximum fragment length: %d > %d",
5616 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005617 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005618 }
5619 else
5620#endif
5621 len = max_len;
5622 }
Paul Bakker887bd502011-06-08 13:10:54 +00005623
Paul Bakker5121ce52009-01-03 21:22:43 +00005624 if( ssl->out_left != 0 )
5625 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005626 /*
5627 * The user has previously tried to send the data and
5628 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5629 * written. In this case, we expect the high-level write function
5630 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005632 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005633 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005634 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005635 return( ret );
5636 }
5637 }
Paul Bakker887bd502011-06-08 13:10:54 +00005638 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005639 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005640 /*
5641 * The user is trying to send a message the first time, so we need to
5642 * copy the data into the internal buffers and setup the data structure
5643 * to keep track of partial writes
5644 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005645 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005647 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005648
Hanno Becker67bc7c32018-08-06 11:33:50 +01005649 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005650 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005651 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005652 return( ret );
5653 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005654 }
5655
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005656 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005657}
5658
5659/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005660 * Write application data, doing 1/n-1 splitting if necessary.
5661 *
5662 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005663 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005664 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005666#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005667static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005668 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005669{
Janos Follath865b3eb2019-12-16 11:46:15 +00005670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005671
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005672 if( ssl->conf->cbc_record_splitting ==
5673 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005674 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5676 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5677 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005678 {
5679 return( ssl_write_real( ssl, buf, len ) );
5680 }
5681
5682 if( ssl->split_done == 0 )
5683 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005684 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005685 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005686 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005687 }
5688
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005689 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5690 return( ret );
5691 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005692
5693 return( ret + 1 );
5694}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005695#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005696
5697/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005698 * Write application data (public-facing wrapper)
5699 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005700int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005701{
Janos Follath865b3eb2019-12-16 11:46:15 +00005702 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005703
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005705
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005706 if( ssl == NULL || ssl->conf == NULL )
5707 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5708
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005709#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005710 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5711 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005712 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005713 return( ret );
5714 }
5715#endif
5716
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005717 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005718 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005719 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005720 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005721 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005722 return( ret );
5723 }
5724 }
5725
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005726#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005727 ret = ssl_write_split( ssl, buf, len );
5728#else
5729 ret = ssl_write_real( ssl, buf, len );
5730#endif
5731
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005733
5734 return( ret );
5735}
5736
5737/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005738 * Notify the peer that the connection is being closed
5739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005741{
Janos Follath865b3eb2019-12-16 11:46:15 +00005742 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005743
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005744 if( ssl == NULL || ssl->conf == NULL )
5745 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005748
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005749 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005750 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005752 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005753 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005754 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5755 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5756 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005757 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005758 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005759 return( ret );
5760 }
5761 }
5762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005764
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005765 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005766}
5767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005769{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005770 if( transform == NULL )
5771 return;
5772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005774 deflateEnd( &transform->ctx_deflate );
5775 inflateEnd( &transform->ctx_inflate );
5776#endif
5777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5779 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005780
Hanno Beckerd56ed242018-01-03 15:32:51 +00005781#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005782 mbedtls_md_free( &transform->md_ctx_enc );
5783 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005784#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005785
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005786 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005787}
5788
Hanno Becker0271f962018-08-16 13:23:47 +01005789#if defined(MBEDTLS_SSL_PROTO_DTLS)
5790
Hanno Becker533ab5f2020-02-05 10:49:13 +00005791void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005792{
5793 unsigned offset;
5794 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5795
5796 if( hs == NULL )
5797 return;
5798
Hanno Becker283f5ef2018-08-24 09:34:47 +01005799 ssl_free_buffered_record( ssl );
5800
Hanno Becker0271f962018-08-16 13:23:47 +01005801 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005802 ssl_buffering_free_slot( ssl, offset );
5803}
5804
5805static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5806 uint8_t slot )
5807{
5808 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5809 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005810
5811 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5812 return;
5813
Hanno Beckere605b192018-08-21 15:59:07 +01005814 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005815 {
Hanno Beckere605b192018-08-21 15:59:07 +01005816 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005817 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005818 mbedtls_free( hs_buf->data );
5819 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005820 }
5821}
5822
5823#endif /* MBEDTLS_SSL_PROTO_DTLS */
5824
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005825/*
5826 * Convert version numbers to/from wire format
5827 * and, for DTLS, to/from TLS equivalent.
5828 *
5829 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005830 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005831 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5832 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005834void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005835 unsigned char ver[2] )
5836{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005837#if defined(MBEDTLS_SSL_PROTO_DTLS)
5838 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005839 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005840 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005841 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5842
5843 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5844 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5845 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005846 else
5847#else
5848 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005849#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005850 {
5851 ver[0] = (unsigned char) major;
5852 ver[1] = (unsigned char) minor;
5853 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005854}
5855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005856void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005857 const unsigned char ver[2] )
5858{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005859#if defined(MBEDTLS_SSL_PROTO_DTLS)
5860 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005861 {
5862 *major = 255 - ver[0] + 2;
5863 *minor = 255 - ver[1] + 1;
5864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005865 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005866 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5867 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005868 else
5869#else
5870 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005871#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005872 {
5873 *major = ver[0];
5874 *minor = ver[1];
5875 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005876}
5877
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005878#endif /* MBEDTLS_SSL_TLS_C */