blob: 420e539c73bf6571297c23feac3e21b63c0dae95 [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 Becker581bc1b2020-05-04 12:20:03 +0100346/* This functions transforms a (D)TLS plaintext fragment and a record content
347 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
348 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
349 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100350 *
351 * struct {
352 * opaque content[DTLSPlaintext.length];
353 * ContentType real_type;
354 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100355 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100356 *
357 * Input:
358 * - `content`: The beginning of the buffer holding the
359 * plaintext to be wrapped.
360 * - `*content_size`: The length of the plaintext in Bytes.
361 * - `max_len`: The number of Bytes available starting from
362 * `content`. This must be `>= *content_size`.
363 * - `rec_type`: The desired record content type.
364 *
365 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100366 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
367 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100368 *
369 * Returns:
370 * - `0` on success.
371 * - A negative error code if `max_len` didn't offer enough space
372 * for the expansion.
373 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100374static int ssl_build_inner_plaintext( unsigned char *content,
375 size_t *content_size,
376 size_t remaining,
377 uint8_t rec_type )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100378{
379 size_t len = *content_size;
Hanno Beckerb9ec44f2019-05-13 15:31:17 +0100380 size_t pad = ( MBEDTLS_SSL_CID_PADDING_GRANULARITY -
381 ( len + 1 ) % MBEDTLS_SSL_CID_PADDING_GRANULARITY ) %
382 MBEDTLS_SSL_CID_PADDING_GRANULARITY;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100383
384 /* Write real content type */
385 if( remaining == 0 )
386 return( -1 );
387 content[ len ] = rec_type;
388 len++;
389 remaining--;
390
391 if( remaining < pad )
392 return( -1 );
393 memset( content + len, 0, pad );
394 len += pad;
395 remaining -= pad;
396
397 *content_size = len;
398 return( 0 );
399}
400
Hanno Becker581bc1b2020-05-04 12:20:03 +0100401/* This function parses a (D)TLSInnerPlaintext structure.
402 * See ssl_build_inner_plaintext() for details. */
403static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100404 size_t *content_size,
405 uint8_t *rec_type )
406{
407 size_t remaining = *content_size;
408
409 /* Determine length of padding by skipping zeroes from the back. */
410 do
411 {
412 if( remaining == 0 )
413 return( -1 );
414 remaining--;
415 } while( content[ remaining ] == 0 );
416
417 *content_size = remaining;
418 *rec_type = content[ remaining ];
419
420 return( 0 );
421}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100422#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
423 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100424
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100425/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100426 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000427static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100428 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100429 mbedtls_record *rec,
430 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000431{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100432 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100433 *
434 * additional_data = seq_num + TLSCompressed.type +
435 * TLSCompressed.version + TLSCompressed.length;
436 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100437 * For the CID extension, this is extended as follows
438 * (quoting draft-ietf-tls-dtls-connection-id-05,
439 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100440 *
441 * additional_data = seq_num + DTLSPlaintext.type +
442 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100443 * cid +
444 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100445 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100446 *
447 * For TLS 1.3, the record sequence number is dropped from the AAD
448 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100449 */
450
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 unsigned char *cur = add_data;
452
453#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
454 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
455#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
456 {
457 ((void) minor_ver);
458 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
459 cur += sizeof( rec->ctr );
460 }
461
462 *cur = rec->type;
463 cur++;
464
465 memcpy( cur, rec->ver, sizeof( rec->ver ) );
466 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100467
Hanno Beckera0e20d02019-05-15 14:03:01 +0100468#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100469 if( rec->cid_len != 0 )
470 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100471 memcpy( cur, rec->cid, rec->cid_len );
472 cur += rec->cid_len;
473
474 *cur = rec->cid_len;
475 cur++;
476
477 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
478 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
479 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100480 }
481 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100482#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100483 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100484 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
485 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
486 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100487 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100488
489 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000490}
491
Hanno Becker9d062f92020-02-07 10:26:36 +0000492#if defined(MBEDTLS_SSL_PROTO_SSL3)
493
494#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
495
496/*
497 * SSLv3.0 MAC functions
498 */
499static void ssl_mac( mbedtls_md_context_t *md_ctx,
500 const unsigned char *secret,
501 const unsigned char *buf, size_t len,
502 const unsigned char *ctr, int type,
503 unsigned char out[SSL3_MAC_MAX_BYTES] )
504{
505 unsigned char header[11];
506 unsigned char padding[48];
507 int padlen;
508 int md_size = mbedtls_md_get_size( md_ctx->md_info );
509 int md_type = mbedtls_md_get_type( md_ctx->md_info );
510
511 /* Only MD5 and SHA-1 supported */
512 if( md_type == MBEDTLS_MD_MD5 )
513 padlen = 48;
514 else
515 padlen = 40;
516
517 memcpy( header, ctr, 8 );
518 header[ 8] = (unsigned char) type;
519 header[ 9] = (unsigned char)( len >> 8 );
520 header[10] = (unsigned char)( len );
521
522 memset( padding, 0x36, padlen );
523 mbedtls_md_starts( md_ctx );
524 mbedtls_md_update( md_ctx, secret, md_size );
525 mbedtls_md_update( md_ctx, padding, padlen );
526 mbedtls_md_update( md_ctx, header, 11 );
527 mbedtls_md_update( md_ctx, buf, len );
528 mbedtls_md_finish( md_ctx, out );
529
530 memset( padding, 0x5C, padlen );
531 mbedtls_md_starts( md_ctx );
532 mbedtls_md_update( md_ctx, secret, md_size );
533 mbedtls_md_update( md_ctx, padding, padlen );
534 mbedtls_md_update( md_ctx, out, md_size );
535 mbedtls_md_finish( md_ctx, out );
536}
537#endif /* MBEDTLS_SSL_PROTO_SSL3 */
538
Hanno Beckerdf8be222020-05-21 15:30:57 +0100539#define SSL_RECORD_AEAD_NONCE_UNKNOWN 0u
540#define SSL_RECORD_AEAD_NONCE_CONCAT 1u
541#define SSL_RECORD_AEAD_NONCE_XOR 2u
542
543static int ssl_transform_get_nonce_mode( mbedtls_ssl_transform const *transform )
544{
545#if defined(MBEDTLS_CHACHAPOLY_C)
546 if( transform->ivlen == 12 && transform->fixed_ivlen == 12 )
547 {
548 return( SSL_RECORD_AEAD_NONCE_XOR );
549 }
550#endif /* MBEDTLS_CHACHAPOLY_C */
551
552#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)
553 if( transform->ivlen == 12 && transform->fixed_ivlen == 4 )
554 {
555 return( SSL_RECORD_AEAD_NONCE_CONCAT );
556 }
557#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
558
559 return( SSL_RECORD_AEAD_NONCE_UNKNOWN );
560}
561
562/* Preconditions:
563 * - If mode == SSL_RECORD_AEAD_NONCE_CONCAT, then
564 * dst_nonce_len == fixed_iv_len + dynamic_iv_len
565 * - If mode == SSL_RECORD_AEAD_NONCE_XOR, then
566 * dst_nonce_len == fixed_iv_len &&
567 * dynamic_iv_len < dst_nonce
568 */
569static int ssl_build_record_nonce( unsigned char *dst_nonce,
570 size_t dst_nonce_len,
571 unsigned char const *fixed_iv,
572 size_t fixed_iv_len,
573 unsigned char const *dynamic_iv,
574 size_t dynamic_iv_len,
575 unsigned mode )
576{
577 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
578
579 ((void) dst_nonce_len);
580
581 /* Start with Fixed IV || 0 */
582 memcpy( dst_nonce, fixed_iv, fixed_iv_len );
583 dst_nonce += fixed_iv_len;
584
585 if( mode == SSL_RECORD_AEAD_NONCE_CONCAT )
586 {
587 /* Nonce := Fixed IV || Dynamic IV */
588 memcpy( dst_nonce, dynamic_iv, dynamic_iv_len );
589 ret = 0;
590 }
591 else if( mode == SSL_RECORD_AEAD_NONCE_XOR )
592 {
593 /* Nonce := Fixed IV XOR ( 0 || Dynamic IV ) */
594 unsigned char i;
595
596 /* This is safe by the second precondition above. */
597 dst_nonce -= dynamic_iv_len;
598 for( i = 0; i < dynamic_iv_len; i++ )
599 dst_nonce[i] ^= dynamic_iv[i];
600
601 ret = 0;
602 }
603 else
604 {
605 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
606 }
607
608 return( ret );
609}
610
Hanno Beckera18d1322018-01-03 14:27:32 +0000611int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
612 mbedtls_ssl_transform *transform,
613 mbedtls_record *rec,
614 int (*f_rng)(void *, unsigned char *, size_t),
615 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000616{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100618 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000619 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100620 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100621 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000622 size_t post_avail;
623
624 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000625#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200626 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000627 ((void) ssl);
628#endif
629
630 /* The PRNG is used for dynamic IV generation that's used
631 * for CBC transformations in TLS 1.1 and TLS 1.2. */
632#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
633 ( defined(MBEDTLS_AES_C) || \
634 defined(MBEDTLS_ARIA_C) || \
635 defined(MBEDTLS_CAMELLIA_C) ) && \
636 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
637 ((void) f_rng);
638 ((void) p_rng);
639#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200641 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000642
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000643 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100644 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000645 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
646 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
647 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100648 if( rec == NULL
649 || rec->buf == NULL
650 || rec->buf_len < rec->data_offset
651 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100652#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100653 || rec->cid_len != 0
654#endif
655 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000656 {
657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100659 }
660
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100662 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 data, rec->data_len );
665
666 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
667
668 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
669 {
670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
671 (unsigned) rec->data_len,
672 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
673 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
674 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100675
Hanno Becker92313402020-05-20 13:58:58 +0100676 /* The following two code paths implement the (D)TLSInnerPlaintext
677 * structure present in TLS 1.3 and DTLS 1.2 + CID.
678 *
679 * See ssl_build_inner_plaintext() for more information.
680 *
681 * Note that this changes `rec->data_len`, and hence
682 * `post_avail` needs to be recalculated afterwards.
683 *
684 * Note also that the two code paths cannot occur simultaneously
685 * since they apply to different versions of the protocol. There
686 * is hence no risk of double-addition of the inner plaintext.
687 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100688#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
689 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
690 {
Hanno Beckerccc13d02020-05-04 12:30:04 +0100691 if( ssl_build_inner_plaintext( data,
692 &rec->data_len,
693 post_avail,
694 rec->type ) != 0 )
695 {
696 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
697 }
698
699 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
700 }
701#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
702
Hanno Beckera0e20d02019-05-15 14:03:01 +0100703#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100704 /*
705 * Add CID information
706 */
707 rec->cid_len = transform->out_cid_len;
708 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
709 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100710
711 if( rec->cid_len != 0 )
712 {
713 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100714 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100715 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100716 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100717 * Note that this changes `rec->data_len`, and hence
718 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100719 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100720 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100721 &rec->data_len,
722 post_avail,
723 rec->type ) != 0 )
724 {
725 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
726 }
727
728 rec->type = MBEDTLS_SSL_MSG_CID;
729 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100730#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100731
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100732 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
733
Paul Bakker5121ce52009-01-03 21:22:43 +0000734 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100735 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000736 */
Hanno Becker52344c22018-01-03 15:24:20 +0000737#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 if( mode == MBEDTLS_MODE_STREAM ||
739 ( mode == MBEDTLS_MODE_CBC
740#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000741 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100742#endif
743 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000744 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000745 if( post_avail < transform->maclen )
746 {
747 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
748 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
749 }
750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200753 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000754 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000755 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
756 data, rec->data_len, rec->ctr, rec->type, mac );
757 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200758 }
759 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200760#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
762 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000763 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200764 {
Hanno Becker992b6872017-11-09 18:57:39 +0000765 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
766
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100767 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
768 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000769
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100771 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000772 mbedtls_md_hmac_update( &transform->md_ctx_enc,
773 data, rec->data_len );
774 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
775 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
776
777 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200778 }
779 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200780#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
783 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200784 }
785
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000786 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
787 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200788
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000789 rec->data_len += transform->maclen;
790 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100791 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200792 }
Hanno Becker52344c22018-01-03 15:24:20 +0000793#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000794
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200795 /*
796 * Encrypt
797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
799 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000800 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000802 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 "including %d bytes of padding",
805 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000806
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000807 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
808 transform->iv_enc, transform->ivlen,
809 data, rec->data_len,
810 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200811 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200813 return( ret );
814 }
815
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000816 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200817 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
819 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200820 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 }
Paul Bakker68884e32013-01-07 18:20:04 +0100822 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000824
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200825#if defined(MBEDTLS_GCM_C) || \
826 defined(MBEDTLS_CCM_C) || \
827 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200829 mode == MBEDTLS_MODE_CCM ||
830 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000831 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200833 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100834 unsigned char *dynamic_iv;
835 size_t dynamic_iv_len;
836
837 unsigned const nonce_mode
838 = ssl_transform_get_nonce_mode( transform );
839 unsigned const dynamic_iv_is_explicit
840 = nonce_mode == SSL_RECORD_AEAD_NONCE_CONCAT;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000841
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100842 /* Check that there's space for the authentication tag. */
843 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000844 {
845 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
846 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
847 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000848
Paul Bakker68884e32013-01-07 18:20:04 +0100849 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100850 * Build nonce for AEAD encryption.
851 *
852 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
853 * part of the IV is prepended to the ciphertext and
854 * can be chosen freely - in particular, it need not
855 * agree with the record sequence number.
856 * However, since ChaChaPoly as well as all AEAD modes
857 * in TLS 1.3 use the record sequence number as the
858 * dynamic part of the nonce, we uniformly use the
859 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100860 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100861 dynamic_iv = rec->ctr;
862 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200863
Hanno Beckerdf8be222020-05-21 15:30:57 +0100864 ret = ssl_build_record_nonce( iv, sizeof( iv ),
865 transform->iv_enc,
866 transform->fixed_ivlen,
867 dynamic_iv,
868 dynamic_iv_len,
869 nonce_mode );
870 if( ret != 0 )
871 return( ret );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100872
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100873 /*
874 * Build additional data for AEAD encryption.
875 * This depends on the TLS version.
876 */
877 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
878 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100879
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200880 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
881 iv, transform->ivlen );
882 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Beckerdf8be222020-05-21 15:30:57 +0100883 data - dynamic_iv_len * dynamic_iv_is_explicit,
884 dynamic_iv_len * dynamic_iv_is_explicit );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000885 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100886 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200888 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000889 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000890
Paul Bakker68884e32013-01-07 18:20:04 +0100891 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200892 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200893 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000894
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200895 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100897 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000898 data, rec->data_len, /* source */
899 data, &rec->data_len, /* destination */
900 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200901 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200903 return( ret );
904 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000905 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
906 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100907 /* Account for authentication tag. */
908 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100910
911 /*
912 * Prefix record content with dynamic IV in case it is explicit.
913 */
914 if( dynamic_iv_is_explicit == 1 )
915 {
916 if( rec->data_offset < dynamic_iv_len )
917 {
918 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
919 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
920 }
921
922 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
923 rec->data_offset -= dynamic_iv_len;
924 rec->data_len += dynamic_iv_len;
925 }
926
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100927 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000928 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000929 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
931#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000932 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000934 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000936 size_t padlen, i;
937 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000938
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 /* Currently we're always using minimal padding
940 * (up to 255 bytes would be allowed). */
941 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
942 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000943 padlen = 0;
944
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 /* Check there's enough space in the buffer for the padding. */
946 if( post_avail < padlen + 1 )
947 {
948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
949 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
950 }
951
Paul Bakker5121ce52009-01-03 21:22:43 +0000952 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000953 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000954
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000955 rec->data_len += padlen + 1;
956 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000959 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000960 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
961 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000962 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000964 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000965 if( f_rng == NULL )
966 {
967 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
968 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
969 }
970
971 if( rec->data_offset < transform->ivlen )
972 {
973 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
974 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
975 }
976
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000977 /*
978 * Generate IV
979 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000981 if( ret != 0 )
982 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000983
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000984 memcpy( data - transform->ivlen, transform->iv_enc,
985 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000986
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000987 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000991 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000992 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200993 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000994
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000995 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
996 transform->iv_enc,
997 transform->ivlen,
998 data, rec->data_len,
999 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001002 return( ret );
1003 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001004
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001005 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1008 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001009 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001010
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001013 {
1014 /*
1015 * Save IV in SSL3 and TLS1
1016 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001017 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
1018 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001019 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001020 else
Paul Bakkercca5b812013-08-31 17:40:26 +02001021#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 {
1023 data -= transform->ivlen;
1024 rec->data_offset -= transform->ivlen;
1025 rec->data_len += transform->ivlen;
1026 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001029 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001030 {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001031 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
1032
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001033 /*
1034 * MAC(MAC_write_key, seq_num +
1035 * TLSCipherText.type +
1036 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001037 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001038 * IV + // except for TLS 1.0
1039 * ENC(content + padding + padding_length));
1040 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001041
1042 if( post_avail < transform->maclen)
1043 {
1044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1045 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1046 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001047
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001048 ssl_extract_add_data_from_record( add_data, &add_data_len,
1049 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001052 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001053 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001054
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001055 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001056 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001057 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1058 data, rec->data_len );
1059 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1060 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001061
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001062 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001063
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001064 rec->data_len += transform->maclen;
1065 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001066 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001067 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001069 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001070 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001072 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001073 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1075 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001076 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001077
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001078 /* Make extra sure authentication was performed, exactly once */
1079 if( auth_done != 1 )
1080 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1082 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001083 }
1084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001086
1087 return( 0 );
1088}
1089
Hanno Becker605949f2019-07-12 08:23:59 +01001090int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001091 mbedtls_ssl_transform *transform,
1092 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001093{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001094 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001096 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001097#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001098 size_t padlen = 0, correct = 1;
1099#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001100 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001101 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001102 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001103
Hanno Beckera18d1322018-01-03 14:27:32 +00001104#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001105 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001106 ((void) ssl);
1107#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001110 if( rec == NULL ||
1111 rec->buf == NULL ||
1112 rec->buf_len < rec->data_offset ||
1113 rec->buf_len - rec->data_offset < rec->data_len )
1114 {
1115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001117 }
1118
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001119 data = rec->buf + rec->data_offset;
1120 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001121
Hanno Beckera0e20d02019-05-15 14:03:01 +01001122#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001123 /*
1124 * Match record's CID with incoming CID.
1125 */
Hanno Becker938489a2019-05-08 13:02:22 +01001126 if( rec->cid_len != transform->in_cid_len ||
1127 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1128 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001129 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001130 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001131#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1134 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001135 {
1136 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001137 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1138 transform->iv_dec,
1139 transform->ivlen,
1140 data, rec->data_len,
1141 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001144 return( ret );
1145 }
1146
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001147 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001148 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1150 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001151 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001152 }
Paul Bakker68884e32013-01-07 18:20:04 +01001153 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001155#if defined(MBEDTLS_GCM_C) || \
1156 defined(MBEDTLS_CCM_C) || \
1157 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001159 mode == MBEDTLS_MODE_CCM ||
1160 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001161 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001162 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001163 unsigned const nonce_mode = ssl_transform_get_nonce_mode( transform );
1164 unsigned char *dynamic_iv;
1165 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001166
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001167 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001168 * Extract dynamic part of nonce for AEAD decryption.
1169 *
1170 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1171 * part of the IV is prepended to the ciphertext and
1172 * can be chosen freely - in particular, it need not
1173 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001174 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001175 dynamic_iv_len = sizeof( rec->ctr );
1176 if( nonce_mode == SSL_RECORD_AEAD_NONCE_XOR )
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001177 {
Hanno Beckerdf8be222020-05-21 15:30:57 +01001178 dynamic_iv = rec->ctr;
1179 }
1180 else
1181 {
1182 if( rec->data_len < dynamic_iv_len )
1183 {
1184 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1185 rec->data_len,
1186 dynamic_iv_len ) );
1187 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1188 }
1189 dynamic_iv = data;
1190
1191 data += dynamic_iv_len;
1192 rec->data_offset += dynamic_iv_len;
1193 rec->data_len -= dynamic_iv_len;
1194 }
1195
1196 /* Check that there's space for the authentication tag. */
1197 if( rec->data_len < transform->taglen )
1198 {
1199 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001201 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001202 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001203
Hanno Beckerdf8be222020-05-21 15:30:57 +01001204 /*
1205 * Prepare nonce from dynamic and static parts.
1206 */
1207 ret = ssl_build_record_nonce( iv, sizeof( iv ),
1208 transform->iv_dec,
1209 transform->fixed_ivlen,
1210 dynamic_iv,
1211 dynamic_iv_len,
1212 nonce_mode );
1213 if( ret != 0 )
1214 return( ret );
Paul Bakker68884e32013-01-07 18:20:04 +01001215
Hanno Beckerdf8be222020-05-21 15:30:57 +01001216 /*
1217 * Build additional data for AEAD encryption.
1218 * This depends on the TLS version.
1219 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001220 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1221 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001222 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001223 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001224
Hanno Beckerd96a6522019-07-10 13:55:25 +01001225 /* Because of the check above, we know that there are
1226 * explicit_iv_len Bytes preceeding data, and taglen
1227 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001228 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001229 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001230
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001231 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001232 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001233 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001234
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001235 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001236 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001237 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001238 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1239 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001240 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001241 data, rec->data_len,
1242 data, &olen,
1243 data + rec->data_len,
1244 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001245 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1249 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001250
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001251 return( ret );
1252 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001253 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001254
Hanno Beckerd96a6522019-07-10 13:55:25 +01001255 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001256 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001257 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1259 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001260 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001261 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1264#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001265 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001267 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001268 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001269
Paul Bakker5121ce52009-01-03 21:22:43 +00001270 /*
Paul Bakker45829992013-01-03 14:52:21 +01001271 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001274 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1275 {
1276 /* The ciphertext is prefixed with the CBC IV. */
1277 minlen += transform->ivlen;
1278 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001279#endif
Paul Bakker45829992013-01-03 14:52:21 +01001280
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001281 /* Size considerations:
1282 *
1283 * - The CBC cipher text must not be empty and hence
1284 * at least of size transform->ivlen.
1285 *
1286 * Together with the potential IV-prefix, this explains
1287 * the first of the two checks below.
1288 *
1289 * - The record must contain a MAC, either in plain or
1290 * encrypted, depending on whether Encrypt-then-MAC
1291 * is used or not.
1292 * - If it is, the message contains the IV-prefix,
1293 * the CBC ciphertext, and the MAC.
1294 * - If it is not, the padded plaintext, and hence
1295 * the CBC ciphertext, has at least length maclen + 1
1296 * because there is at least the padding length byte.
1297 *
1298 * As the CBC ciphertext is not empty, both cases give the
1299 * lower bound minlen + maclen + 1 on the record size, which
1300 * we test for in the second check below.
1301 */
1302 if( rec->data_len < minlen + transform->ivlen ||
1303 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001304 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001306 "+ 1 ) ( + expl IV )", rec->data_len,
1307 transform->ivlen,
1308 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001310 }
1311
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001312 /*
1313 * Authenticate before decrypt if enabled
1314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001316 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001317 {
Hanno Becker992b6872017-11-09 18:57:39 +00001318 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001321
Hanno Beckerd96a6522019-07-10 13:55:25 +01001322 /* Update data_len in tandem with add_data.
1323 *
1324 * The subtraction is safe because of the previous check
1325 * data_len >= minlen + maclen + 1.
1326 *
1327 * Afterwards, we know that data + data_len is followed by at
1328 * least maclen Bytes, which justifies the call to
1329 * mbedtls_ssl_safer_memcmp() below.
1330 *
1331 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001333 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1334 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001335
Hanno Beckerd96a6522019-07-10 13:55:25 +01001336 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001337 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1338 add_data_len );
1339 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1340 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1342 data, rec->data_len );
1343 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1344 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001345
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001346 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1347 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001348 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001349 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001350
Hanno Beckerd96a6522019-07-10 13:55:25 +01001351 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001352 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1353 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001354 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001355 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001357 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001358 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001359 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001361
1362 /*
1363 * Check length sanity
1364 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001365
1366 /* We know from above that data_len > minlen >= 0,
1367 * so the following check in particular implies that
1368 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001369 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001370 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001372 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001374 }
1375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001377 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001378 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001379 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001380 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001381 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001382 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001383 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001384
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001385 data += transform->ivlen;
1386 rec->data_offset += transform->ivlen;
1387 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001388 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001390
Hanno Beckerd96a6522019-07-10 13:55:25 +01001391 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1392
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001393 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1394 transform->iv_dec, transform->ivlen,
1395 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001396 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001398 return( ret );
1399 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001400
Hanno Beckerd96a6522019-07-10 13:55:25 +01001401 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001402 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001403 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1405 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001406 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001409 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001410 {
1411 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001412 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1413 * records is equivalent to CBC decryption of the concatenation
1414 * of the records; in other words, IVs are maintained across
1415 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001416 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001417 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1418 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001419 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001420#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001421
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422 /* Safe since data_len >= minlen + maclen + 1, so after having
1423 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001424 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1425 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001427
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001428 if( auth_done == 1 )
1429 {
1430 correct *= ( rec->data_len >= padlen + 1 );
1431 padlen *= ( rec->data_len >= padlen + 1 );
1432 }
1433 else
Paul Bakker45829992013-01-03 14:52:21 +01001434 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436 if( rec->data_len < transform->maclen + padlen + 1 )
1437 {
1438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1439 rec->data_len,
1440 transform->maclen,
1441 padlen + 1 ) );
1442 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001443#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001444
1445 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1446 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001447 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001448
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001449 padlen++;
1450
1451 /* Regardless of the validity of the padding,
1452 * we have data_len >= padlen here. */
1453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001455 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001456 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001457 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001458 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459#if defined(MBEDTLS_SSL_DEBUG_ALL)
1460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001461 "should be no more than %d",
1462 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001463#endif
Paul Bakker45829992013-01-03 14:52:21 +01001464 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001465 }
1466 }
1467 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1469#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1470 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001471 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001472 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001473 /* The padding check involves a series of up to 256
1474 * consecutive memory reads at the end of the record
1475 * plaintext buffer. In order to hide the length and
1476 * validity of the padding, always perform exactly
1477 * `min(256,plaintext_len)` reads (but take into account
1478 * only the last `padlen` bytes for the padding check). */
1479 size_t pad_count = 0;
1480 size_t real_count = 0;
1481 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001482
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001483 /* Index of first padding byte; it has been ensured above
1484 * that the subtraction is safe. */
1485 size_t const padding_idx = rec->data_len - padlen;
1486 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1487 size_t const start_idx = rec->data_len - num_checks;
1488 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001489
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001490 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001491 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 real_count |= ( idx >= padding_idx );
1493 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001494 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001495 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001498 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001500#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001501 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001502 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001503 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1505 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001506 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1508 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001509 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001510
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001511 /* If the padding was found to be invalid, padlen == 0
1512 * and the subtraction is safe. If the padding was found valid,
1513 * padlen hasn't been changed and the previous assertion
1514 * data_len >= padlen still holds. */
1515 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001516 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001517 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001518#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001519 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001520 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1522 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001523 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001524
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001525#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001528#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001529
1530 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001531 * Authenticate if not done yet.
1532 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001533 */
Hanno Becker52344c22018-01-03 15:24:20 +00001534#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001535 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001536 {
Hanno Becker992b6872017-11-09 18:57:39 +00001537 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001538
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001539 /* If the initial value of padlen was such that
1540 * data_len < maclen + padlen + 1, then padlen
1541 * got reset to 1, and the initial check
1542 * data_len >= minlen + maclen + 1
1543 * guarantees that at this point we still
1544 * have at least data_len >= maclen.
1545 *
1546 * If the initial value of padlen was such that
1547 * data_len >= maclen + padlen + 1, then we have
1548 * subtracted either padlen + 1 (if the padding was correct)
1549 * or 0 (if the padding was incorrect) since then,
1550 * hence data_len >= maclen in any case.
1551 */
1552 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001553 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1554 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001557 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001558 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001559 ssl_mac( &transform->md_ctx_dec,
1560 transform->mac_dec,
1561 data, rec->data_len,
1562 rec->ctr, rec->type,
1563 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001564 }
1565 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1567#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1568 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001569 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001570 {
1571 /*
1572 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001573 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001574 *
1575 * Known timing attacks:
1576 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1577 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001578 * To compensate for different timings for the MAC calculation
1579 * depending on how much padding was removed (which is determined
1580 * by padlen), process extra_run more blocks through the hash
1581 * function.
1582 *
1583 * The formula in the paper is
1584 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1585 * where L1 is the size of the header plus the decrypted message
1586 * plus CBC padding and L2 is the size of the header plus the
1587 * decrypted message. This is for an underlying hash function
1588 * with 64-byte blocks.
1589 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1590 * correctly. We round down instead of up, so -56 is the correct
1591 * value for our calculations instead of -55.
1592 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001593 * Repeat the formula rather than defining a block_size variable.
1594 * This avoids requiring division by a variable at runtime
1595 * (which would be marginally less efficient and would require
1596 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001597 */
1598 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001599 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001600
1601 /*
1602 * The next two sizes are the minimum and maximum values of
1603 * in_msglen over all padlen values.
1604 *
1605 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001606 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001607 *
1608 * Note that max_len + maclen is never more than the buffer
1609 * length, as we previously did in_msglen -= maclen too.
1610 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001611 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001612 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1613
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001614 memset( tmp, 0, sizeof( tmp ) );
1615
1616 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001617 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001618#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1619 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001620 case MBEDTLS_MD_MD5:
1621 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001622 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001623 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001624 extra_run =
1625 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1626 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001627 break;
1628#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001629#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001630 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001631 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001632 extra_run =
1633 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1634 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001635 break;
1636#endif
1637 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001639 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1640 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001641
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001642 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001643
Hanno Beckercab87e62019-04-29 13:52:53 +01001644 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1645 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001646 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1647 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001648 /* Make sure we access everything even when padlen > 0. This
1649 * makes the synchronisation requirements for just-in-time
1650 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001651 ssl_read_memory( data + rec->data_len, padlen );
1652 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001653
1654 /* Call mbedtls_md_process at least once due to cache attacks
1655 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001656 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001657 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001658
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001659 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001660
1661 /* Make sure we access all the memory that could contain the MAC,
1662 * before we check it in the next code block. This makes the
1663 * synchronisation requirements for just-in-time Prime+Probe
1664 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001665 ssl_read_memory( data + min_len,
1666 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001667 }
1668 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1670 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001671 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1673 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001674 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001675
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001676#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001677 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1678 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001679#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001680
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001681 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1682 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001683 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684#if defined(MBEDTLS_SSL_DEBUG_ALL)
1685 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001686#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001687 correct = 0;
1688 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001689 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001690 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001691
1692 /*
1693 * Finally check the correct flag
1694 */
1695 if( correct == 0 )
1696 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001697#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001698
1699 /* Make extra sure authentication was performed, exactly once */
1700 if( auth_done != 1 )
1701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1703 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001704 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001705
Hanno Beckerccc13d02020-05-04 12:30:04 +01001706#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1707 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1708 {
1709 /* Remove inner padding and infer true content type. */
1710 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1711 &rec->type );
1712
1713 if( ret != 0 )
1714 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1715 }
1716#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1717
Hanno Beckera0e20d02019-05-15 14:03:01 +01001718#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001719 if( rec->cid_len != 0 )
1720 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001721 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1722 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001723 if( ret != 0 )
1724 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1725 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001726#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001729
1730 return( 0 );
1731}
1732
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001733#undef MAC_NONE
1734#undef MAC_PLAINTEXT
1735#undef MAC_CIPHERTEXT
1736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001738/*
1739 * Compression/decompression functions
1740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001742{
Janos Follath865b3eb2019-12-16 11:46:15 +00001743 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001744 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001745 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001746 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001747 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001748#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1749 size_t out_buf_len = ssl->out_buf_len;
1750#else
1751 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1752#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001754 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001755
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001756 if( len_pre == 0 )
1757 return( 0 );
1758
Paul Bakker2770fbd2012-07-03 13:30:23 +00001759 memcpy( msg_pre, ssl->out_msg, len_pre );
1760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001762 ssl->out_msglen ) );
1763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001765 ssl->out_msg, ssl->out_msglen );
1766
Paul Bakker48916f92012-09-16 19:57:18 +00001767 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1768 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1769 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001770 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001771
Paul Bakker48916f92012-09-16 19:57:18 +00001772 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001773 if( ret != Z_OK )
1774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1776 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001777 }
1778
Darryl Greenb33cc762019-11-28 14:29:44 +00001779 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001780 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001783 ssl->out_msglen ) );
1784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001785 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786 ssl->out_msg, ssl->out_msglen );
1787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001789
1790 return( 0 );
1791}
1792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794{
Janos Follath865b3eb2019-12-16 11:46:15 +00001795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001796 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001797 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001799 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001800#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1801 size_t in_buf_len = ssl->in_buf_len;
1802#else
1803 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1804#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001807
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001808 if( len_pre == 0 )
1809 return( 0 );
1810
Paul Bakker2770fbd2012-07-03 13:30:23 +00001811 memcpy( msg_pre, ssl->in_msg, len_pre );
1812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814 ssl->in_msglen ) );
1815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001817 ssl->in_msg, ssl->in_msglen );
1818
Paul Bakker48916f92012-09-16 19:57:18 +00001819 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1820 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1821 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001822 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001823
Paul Bakker48916f92012-09-16 19:57:18 +00001824 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001825 if( ret != Z_OK )
1826 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1828 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829 }
1830
Darryl Greenb33cc762019-11-28 14:29:44 +00001831 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001832 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001835 ssl->in_msglen ) );
1836
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838 ssl->in_msg, ssl->in_msglen );
1839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001841
1842 return( 0 );
1843}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001845
Paul Bakker5121ce52009-01-03 21:22:43 +00001846/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001847 * Fill the input message buffer by appending data to it.
1848 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001849 *
1850 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1851 * available (from this read and/or a previous one). Otherwise, an error code
1852 * is returned (possibly EOF or WANT_READ).
1853 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001854 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1855 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1856 * since we always read a whole datagram at once.
1857 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001858 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001859 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001861int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001862{
Janos Follath865b3eb2019-12-16 11:46:15 +00001863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001864 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001865#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1866 size_t in_buf_len = ssl->in_buf_len;
1867#else
1868 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1869#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001872
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001873 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1874 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001876 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001878 }
1879
Darryl Greenb33cc762019-11-28 14:29:44 +00001880 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001881 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1883 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001884 }
1885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001887 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001888 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001889 uint32_t timeout;
1890
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001891 /* Just to be sure */
1892 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1893 {
1894 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1895 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1896 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1897 }
1898
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001899 /*
1900 * The point is, we need to always read a full datagram at once, so we
1901 * sometimes read more then requested, and handle the additional data.
1902 * It could be the rest of the current record (while fetching the
1903 * header) and/or some other records in the same datagram.
1904 */
1905
1906 /*
1907 * Move to the next record in the already read datagram if applicable
1908 */
1909 if( ssl->next_record_offset != 0 )
1910 {
1911 if( ssl->in_left < ssl->next_record_offset )
1912 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1914 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001915 }
1916
1917 ssl->in_left -= ssl->next_record_offset;
1918
1919 if( ssl->in_left != 0 )
1920 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001922 ssl->next_record_offset ) );
1923 memmove( ssl->in_hdr,
1924 ssl->in_hdr + ssl->next_record_offset,
1925 ssl->in_left );
1926 }
1927
1928 ssl->next_record_offset = 0;
1929 }
1930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001932 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001933
1934 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001935 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001936 */
1937 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001938 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001940 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001941 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001942
1943 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001944 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001945 * are not at the beginning of a new record, the caller did something
1946 * wrong.
1947 */
1948 if( ssl->in_left != 0 )
1949 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1951 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001952 }
1953
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001954 /*
1955 * Don't even try to read if time's out already.
1956 * This avoids by-passing the timer when repeatedly receiving messages
1957 * that will end up being dropped.
1958 */
Hanno Becker7876d122020-02-05 10:39:31 +00001959 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001960 {
1961 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001962 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001963 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001964 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001965 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001966 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001969 timeout = ssl->handshake->retransmit_timeout;
1970 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001971 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001974
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001975 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001976 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1977 timeout );
1978 else
1979 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1980
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001982
1983 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001985 }
1986
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001987 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001988 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001990 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001993 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001994 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1995 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001997 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001998 }
1999
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002001 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002003 return( ret );
2004 }
2005
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002006 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002007 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002009 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002011 {
Hanno Becker786300f2020-02-05 10:46:40 +00002012 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002013 {
Hanno Becker786300f2020-02-05 10:46:40 +00002014 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2015 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002016 return( ret );
2017 }
2018
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002019 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002020 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002022 }
2023
Paul Bakker5121ce52009-01-03 21:22:43 +00002024 if( ret < 0 )
2025 return( ret );
2026
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002027 ssl->in_left = ret;
2028 }
2029 else
2030#endif
2031 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002033 ssl->in_left, nb_want ) );
2034
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002035 while( ssl->in_left < nb_want )
2036 {
2037 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002038
Hanno Becker7876d122020-02-05 10:39:31 +00002039 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002040 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2041 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002042 {
2043 if( ssl->f_recv_timeout != NULL )
2044 {
2045 ret = ssl->f_recv_timeout( ssl->p_bio,
2046 ssl->in_hdr + ssl->in_left, len,
2047 ssl->conf->read_timeout );
2048 }
2049 else
2050 {
2051 ret = ssl->f_recv( ssl->p_bio,
2052 ssl->in_hdr + ssl->in_left, len );
2053 }
2054 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002057 ssl->in_left, nb_want ) );
2058 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002059
2060 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002062
2063 if( ret < 0 )
2064 return( ret );
2065
mohammad160352aecb92018-03-28 23:41:40 -07002066 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002067 {
Darryl Green11999bb2018-03-13 15:22:58 +00002068 MBEDTLS_SSL_DEBUG_MSG( 1,
2069 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002070 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002071 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2072 }
2073
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002074 ssl->in_left += ret;
2075 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002076 }
2077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002079
2080 return( 0 );
2081}
2082
2083/*
2084 * Flush any data not yet written
2085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002087{
Janos Follath865b3eb2019-12-16 11:46:15 +00002088 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002089 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002092
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002093 if( ssl->f_send == NULL )
2094 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002096 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002097 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002098 }
2099
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002100 /* Avoid incrementing counter if data is flushed */
2101 if( ssl->out_left == 0 )
2102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002104 return( 0 );
2105 }
2106
Paul Bakker5121ce52009-01-03 21:22:43 +00002107 while( ssl->out_left > 0 )
2108 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002110 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
Hanno Becker2b1e3542018-08-06 11:19:13 +01002112 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002113 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002115 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002116
2117 if( ret <= 0 )
2118 return( ret );
2119
mohammad160352aecb92018-03-28 23:41:40 -07002120 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002121 {
Darryl Green11999bb2018-03-13 15:22:58 +00002122 MBEDTLS_SSL_DEBUG_MSG( 1,
2123 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002124 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002125 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2126 }
2127
Paul Bakker5121ce52009-01-03 21:22:43 +00002128 ssl->out_left -= ret;
2129 }
2130
Hanno Becker2b1e3542018-08-06 11:19:13 +01002131#if defined(MBEDTLS_SSL_PROTO_DTLS)
2132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002133 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002134 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002135 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002136 else
2137#endif
2138 {
2139 ssl->out_hdr = ssl->out_buf + 8;
2140 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002141 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
2145 return( 0 );
2146}
2147
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002148/*
2149 * Functions to handle the DTLS retransmission state machine
2150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002152/*
2153 * Append current handshake message to current outgoing flight
2154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002158 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2159 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2160 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002161
2162 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002163 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002164 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002165 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002167 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002168 }
2169
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002170 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002171 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002172 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002174 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002175 }
2176
2177 /* Copy current handshake message with headers */
2178 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2179 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002180 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181 msg->next = NULL;
2182
2183 /* Append to the current flight */
2184 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002185 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002186 else
2187 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189 while( cur->next != NULL )
2190 cur = cur->next;
2191 cur->next = msg;
2192 }
2193
Hanno Becker3b235902018-08-06 09:54:53 +01002194 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002195 return( 0 );
2196}
2197
2198/*
2199 * Free the current flight of handshake messages
2200 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002201void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 mbedtls_ssl_flight_item *cur = flight;
2204 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002205
2206 while( cur != NULL )
2207 {
2208 next = cur->next;
2209
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 mbedtls_free( cur->p );
2211 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002212
2213 cur = next;
2214 }
2215}
2216
2217/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002218 * Swap transform_out and out_ctr with the alternative ones
2219 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002220static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002221{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002223 unsigned char tmp_out_ctr[8];
2224
2225 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2226 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002227 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002228 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002229 }
2230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002232
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002233 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002234 tmp_transform = ssl->transform_out;
2235 ssl->transform_out = ssl->handshake->alt_transform_out;
2236 ssl->handshake->alt_transform_out = tmp_transform;
2237
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002238 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002239 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2240 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002241 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002242
2243 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002244 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002246#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2247 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002248 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002249 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2250 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002251 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2253 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002254 }
2255 }
2256#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002257
2258 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002259}
2260
2261/*
2262 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002263 */
2264int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2265{
2266 int ret = 0;
2267
2268 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2269
2270 ret = mbedtls_ssl_flight_transmit( ssl );
2271
2272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2273
2274 return( ret );
2275}
2276
2277/*
2278 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002279 *
2280 * Need to remember the current message in case flush_output returns
2281 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002282 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002283 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002284int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002285{
Janos Follath865b3eb2019-12-16 11:46:15 +00002286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002290 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002292
2293 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002294 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002295 ret = ssl_swap_epochs( ssl );
2296 if( ret != 0 )
2297 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002300 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002301
2302 while( ssl->handshake->cur_msg != NULL )
2303 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002304 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002305 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002306
Hanno Beckere1dcb032018-08-17 16:47:58 +01002307 int const is_finished =
2308 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2309 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2310
Hanno Becker04da1892018-08-14 13:22:10 +01002311 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2312 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2313
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002314 /* Swap epochs before sending Finished: we can't do it after
2315 * sending ChangeCipherSpec, in case write returns WANT_READ.
2316 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002317 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002318 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002319 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002320 ret = ssl_swap_epochs( ssl );
2321 if( ret != 0 )
2322 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002323 }
2324
Hanno Becker67bc7c32018-08-06 11:33:50 +01002325 ret = ssl_get_remaining_payload_in_datagram( ssl );
2326 if( ret < 0 )
2327 return( ret );
2328 max_frag_len = (size_t) ret;
2329
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002330 /* CCS is copied as is, while HS messages may need fragmentation */
2331 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2332 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002333 if( max_frag_len == 0 )
2334 {
2335 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2336 return( ret );
2337
2338 continue;
2339 }
2340
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002341 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002342 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002343 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002344
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002345 /* Update position inside current message */
2346 ssl->handshake->cur_msg_p += cur->len;
2347 }
2348 else
2349 {
2350 const unsigned char * const p = ssl->handshake->cur_msg_p;
2351 const size_t hs_len = cur->len - 12;
2352 const size_t frag_off = p - ( cur->p + 12 );
2353 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002354 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002355
Hanno Beckere1dcb032018-08-17 16:47:58 +01002356 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002357 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002358 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002359 {
2360 ret = ssl_swap_epochs( ssl );
2361 if( ret != 0 )
2362 return( ret );
2363 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002364
Hanno Becker67bc7c32018-08-06 11:33:50 +01002365 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2366 return( ret );
2367
2368 continue;
2369 }
2370 max_hs_frag_len = max_frag_len - 12;
2371
2372 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2373 max_hs_frag_len : rem_len;
2374
2375 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002376 {
2377 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002378 (unsigned) cur_hs_frag_len,
2379 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002380 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002381
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002382 /* Messages are stored with handshake headers as if not fragmented,
2383 * copy beginning of headers then fill fragmentation fields.
2384 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2385 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002386
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002387 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2388 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2389 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2390
Hanno Becker67bc7c32018-08-06 11:33:50 +01002391 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2392 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2393 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002394
2395 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2396
Hanno Becker3f7b9732018-08-28 09:53:25 +01002397 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002398 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2399 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002400 ssl->out_msgtype = cur->type;
2401
2402 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002403 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002404 }
2405
2406 /* If done with the current message move to the next one if any */
2407 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2408 {
2409 if( cur->next != NULL )
2410 {
2411 ssl->handshake->cur_msg = cur->next;
2412 ssl->handshake->cur_msg_p = cur->next->p + 12;
2413 }
2414 else
2415 {
2416 ssl->handshake->cur_msg = NULL;
2417 ssl->handshake->cur_msg_p = NULL;
2418 }
2419 }
2420
2421 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002422 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425 return( ret );
2426 }
2427 }
2428
Hanno Becker67bc7c32018-08-06 11:33:50 +01002429 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2430 return( ret );
2431
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002432 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2434 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002435 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002436 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002438 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002439 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002440
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002441 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002442
2443 return( 0 );
2444}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002445
2446/*
2447 * To be called when the last message of an incoming flight is received.
2448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002450{
2451 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002452 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002453 ssl->handshake->flight = NULL;
2454 ssl->handshake->cur_msg = NULL;
2455
2456 /* The next incoming flight will start with this msg_seq */
2457 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2458
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002459 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002460 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002461
Hanno Becker0271f962018-08-16 13:23:47 +01002462 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002463 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002464
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002465 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002466 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2469 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002472 }
2473 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002475}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002476
2477/*
2478 * To be called when the last message of an outgoing flight is send.
2479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002481{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002482 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002483 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2486 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002487 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002489 }
2490 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002492}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002494
Paul Bakker5121ce52009-01-03 21:22:43 +00002495/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002496 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002497 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002498
2499/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002500 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002501 *
2502 * - fill in handshake headers
2503 * - update handshake checksum
2504 * - DTLS: save message for resending
2505 * - then pass to the record layer
2506 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002507 * DTLS: except for HelloRequest, messages are only queued, and will only be
2508 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002509 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002510 * Inputs:
2511 * - ssl->out_msglen: 4 + actual handshake message len
2512 * (4 is the size of handshake headers for TLS)
2513 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2514 * - ssl->out_msg + 4: the handshake message body
2515 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002516 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002517 * - ssl->out_msglen: the length of the record contents
2518 * (including handshake headers but excluding record headers)
2519 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002520 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002521int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002522{
Janos Follath865b3eb2019-12-16 11:46:15 +00002523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002524 const size_t hs_len = ssl->out_msglen - 4;
2525 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002526
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2528
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002529 /*
2530 * Sanity checks
2531 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002532 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002533 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2534 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002535 /* In SSLv3, the client might send a NoCertificate alert. */
2536#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2537 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2538 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2539 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2540#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2541 {
2542 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2543 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2544 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002545 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002546
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002547 /* Whenever we send anything different from a
2548 * HelloRequest we should be in a handshake - double check. */
2549 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2550 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002551 ssl->handshake == NULL )
2552 {
2553 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2554 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2555 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002558 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002559 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002561 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002562 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2563 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002564 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002565#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002566
Hanno Beckerb50a2532018-08-06 11:52:54 +01002567 /* Double-check that we did not exceed the bounds
2568 * of the outgoing record buffer.
2569 * This should never fail as the various message
2570 * writing functions must obey the bounds of the
2571 * outgoing record buffer, but better be safe.
2572 *
2573 * Note: We deliberately do not check for the MTU or MFL here.
2574 */
2575 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2576 {
2577 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2578 "size %u, maximum %u",
2579 (unsigned) ssl->out_msglen,
2580 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2581 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2582 }
2583
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002584 /*
2585 * Fill handshake headers
2586 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002588 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002589 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2590 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2591 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002592
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002593 /*
2594 * DTLS has additional fields in the Handshake layer,
2595 * between the length field and the actual payload:
2596 * uint16 message_seq;
2597 * uint24 fragment_offset;
2598 * uint24 fragment_length;
2599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002601 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002602 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002603 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002604 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002605 {
2606 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2607 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002608 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002609 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002610 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2611 }
2612
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002613 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002614 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002615
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002616 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002617 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002618 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002619 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2620 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2621 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002622 }
2623 else
2624 {
2625 ssl->out_msg[4] = 0;
2626 ssl->out_msg[5] = 0;
2627 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002628
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002629 /* Handshake hashes are computed without fragmentation,
2630 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002631 memset( ssl->out_msg + 6, 0x00, 3 );
2632 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002633 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002635
Hanno Becker0207e532018-08-28 10:28:28 +01002636 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002637 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2638 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002639 }
2640
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002641 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002643 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002644 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2645 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002646 {
2647 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2648 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002650 return( ret );
2651 }
2652 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002653 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002654#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002655 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002656 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002657 {
2658 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2659 return( ret );
2660 }
2661 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002662
2663 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2664
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002665 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002666}
2667
2668/*
2669 * Record layer functions
2670 */
2671
2672/*
2673 * Write current record.
2674 *
2675 * Uses:
2676 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2677 * - ssl->out_msglen: length of the record content (excl headers)
2678 * - ssl->out_msg: record content
2679 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002680int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002681{
2682 int ret, done = 0;
2683 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002684 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002685
2686 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002687
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002689 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002691 {
2692 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2693 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002695 return( ret );
2696 }
2697
2698 len = ssl->out_msglen;
2699 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002701
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2703 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 ret = mbedtls_ssl_hw_record_write( ssl );
2708 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002709 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2711 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002712 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002713
2714 if( ret == 0 )
2715 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002716 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002718 if( !done )
2719 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002720 unsigned i;
2721 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002722#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2723 size_t out_buf_len = ssl->out_buf_len;
2724#else
2725 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2726#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002727 /* Skip writing the record content type to after the encryption,
2728 * as it may change when using the CID extension. */
2729
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002731 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002732
Hanno Becker19859472018-08-06 09:40:20 +01002733 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002734 ssl->out_len[0] = (unsigned char)( len >> 8 );
2735 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002736
Paul Bakker48916f92012-09-16 19:57:18 +00002737 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002738 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002739 mbedtls_record rec;
2740
2741 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002742 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002743 rec.data_len = ssl->out_msglen;
2744 rec.data_offset = ssl->out_msg - rec.buf;
2745
2746 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2747 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2748 ssl->conf->transport, rec.ver );
2749 rec.type = ssl->out_msgtype;
2750
Hanno Beckera0e20d02019-05-15 14:03:01 +01002751#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002752 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002753 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002754#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002755
Hanno Beckera18d1322018-01-03 14:27:32 +00002756 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002757 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002760 return( ret );
2761 }
2762
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002763 if( rec.data_offset != 0 )
2764 {
2765 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2766 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2767 }
2768
Hanno Becker6430faf2019-05-08 11:57:13 +01002769 /* Update the record content type and CID. */
2770 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002771#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002772 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002773#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002774 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002775 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2776 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002777 }
2778
Hanno Becker5903de42019-05-03 14:46:38 +01002779 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002780
2781#if defined(MBEDTLS_SSL_PROTO_DTLS)
2782 /* In case of DTLS, double-check that we don't exceed
2783 * the remaining space in the datagram. */
2784 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2785 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002786 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002787 if( ret < 0 )
2788 return( ret );
2789
2790 if( protected_record_size > (size_t) ret )
2791 {
2792 /* Should never happen */
2793 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2794 }
2795 }
2796#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002797
Hanno Becker6430faf2019-05-08 11:57:13 +01002798 /* Now write the potentially updated record content type. */
2799 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2800
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002802 "version = [%d:%d], msglen = %d",
2803 ssl->out_hdr[0], ssl->out_hdr[1],
2804 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002807 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002808
2809 ssl->out_left += protected_record_size;
2810 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002811 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002812
Hanno Beckerdd772292020-02-05 10:38:31 +00002813 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002814 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2815 break;
2816
2817 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002818 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002819 {
2820 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2821 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2822 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002823 }
2824
Hanno Becker67bc7c32018-08-06 11:33:50 +01002825#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002826 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2827 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002828 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002829 size_t remaining;
2830 ret = ssl_get_remaining_payload_in_datagram( ssl );
2831 if( ret < 0 )
2832 {
2833 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2834 ret );
2835 return( ret );
2836 }
2837
2838 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002839 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002840 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002841 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002842 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002843 else
2844 {
Hanno Becker513815a2018-08-20 11:56:09 +01002845 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002846 }
2847 }
2848#endif /* MBEDTLS_SSL_PROTO_DTLS */
2849
2850 if( ( flush == SSL_FORCE_FLUSH ) &&
2851 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002852 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002854 return( ret );
2855 }
2856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002858
2859 return( 0 );
2860}
2861
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002862#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002863
2864static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2865{
2866 if( ssl->in_msglen < ssl->in_hslen ||
2867 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2868 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2869 {
2870 return( 1 );
2871 }
2872 return( 0 );
2873}
Hanno Becker44650b72018-08-16 12:51:11 +01002874
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002875static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002876{
2877 return( ( ssl->in_msg[9] << 16 ) |
2878 ( ssl->in_msg[10] << 8 ) |
2879 ssl->in_msg[11] );
2880}
2881
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002882static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002883{
2884 return( ( ssl->in_msg[6] << 16 ) |
2885 ( ssl->in_msg[7] << 8 ) |
2886 ssl->in_msg[8] );
2887}
2888
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002889static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002890{
2891 uint32_t msg_len, frag_off, frag_len;
2892
2893 msg_len = ssl_get_hs_total_len( ssl );
2894 frag_off = ssl_get_hs_frag_off( ssl );
2895 frag_len = ssl_get_hs_frag_len( ssl );
2896
2897 if( frag_off > msg_len )
2898 return( -1 );
2899
2900 if( frag_len > msg_len - frag_off )
2901 return( -1 );
2902
2903 if( frag_len + 12 > ssl->in_msglen )
2904 return( -1 );
2905
2906 return( 0 );
2907}
2908
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002909/*
2910 * Mark bits in bitmask (used for DTLS HS reassembly)
2911 */
2912static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2913{
2914 unsigned int start_bits, end_bits;
2915
2916 start_bits = 8 - ( offset % 8 );
2917 if( start_bits != 8 )
2918 {
2919 size_t first_byte_idx = offset / 8;
2920
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002921 /* Special case */
2922 if( len <= start_bits )
2923 {
2924 for( ; len != 0; len-- )
2925 mask[first_byte_idx] |= 1 << ( start_bits - len );
2926
2927 /* Avoid potential issues with offset or len becoming invalid */
2928 return;
2929 }
2930
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002931 offset += start_bits; /* Now offset % 8 == 0 */
2932 len -= start_bits;
2933
2934 for( ; start_bits != 0; start_bits-- )
2935 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2936 }
2937
2938 end_bits = len % 8;
2939 if( end_bits != 0 )
2940 {
2941 size_t last_byte_idx = ( offset + len ) / 8;
2942
2943 len -= end_bits; /* Now len % 8 == 0 */
2944
2945 for( ; end_bits != 0; end_bits-- )
2946 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2947 }
2948
2949 memset( mask + offset / 8, 0xFF, len / 8 );
2950}
2951
2952/*
2953 * Check that bitmask is full
2954 */
2955static int ssl_bitmask_check( unsigned char *mask, size_t len )
2956{
2957 size_t i;
2958
2959 for( i = 0; i < len / 8; i++ )
2960 if( mask[i] != 0xFF )
2961 return( -1 );
2962
2963 for( i = 0; i < len % 8; i++ )
2964 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2965 return( -1 );
2966
2967 return( 0 );
2968}
2969
Hanno Becker56e205e2018-08-16 09:06:12 +01002970/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002971static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002972 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002973{
Hanno Becker56e205e2018-08-16 09:06:12 +01002974 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002975
Hanno Becker56e205e2018-08-16 09:06:12 +01002976 alloc_len = 12; /* Handshake header */
2977 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002978
Hanno Beckerd07df862018-08-16 09:14:58 +01002979 if( add_bitmap )
2980 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002981
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002982 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002983}
Hanno Becker56e205e2018-08-16 09:06:12 +01002984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002986
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002987static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002988{
2989 return( ( ssl->in_msg[1] << 16 ) |
2990 ( ssl->in_msg[2] << 8 ) |
2991 ssl->in_msg[3] );
2992}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002993
Simon Butcher99000142016-10-13 17:21:01 +01002994int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002995{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002997 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002999 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003000 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003001 }
3002
Hanno Becker12555c62018-08-16 12:47:53 +01003003 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003006 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003007 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003010 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003011 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003013 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003014
Hanno Becker44650b72018-08-16 12:51:11 +01003015 if( ssl_check_hs_header( ssl ) != 0 )
3016 {
3017 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3018 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3019 }
3020
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003021 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003022 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3023 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3024 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3025 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003026 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003027 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3028 {
3029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3030 recv_msg_seq,
3031 ssl->handshake->in_msg_seq ) );
3032 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3033 }
3034
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003035 /* Retransmit only on last message from previous flight, to avoid
3036 * too many retransmissions.
3037 * Besides, No sane server ever retransmits HelloVerifyRequest */
3038 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003040 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003042 "message_seq = %d, start_of_flight = %d",
3043 recv_msg_seq,
3044 ssl->handshake->in_flight_start_seq ) );
3045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003049 return( ret );
3050 }
3051 }
3052 else
3053 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003055 "message_seq = %d, expected = %d",
3056 recv_msg_seq,
3057 ssl->handshake->in_msg_seq ) );
3058 }
3059
Hanno Becker90333da2017-10-10 11:27:13 +01003060 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003061 }
3062 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003063
Hanno Becker6d97ef52018-08-16 13:09:04 +01003064 /* Message reassembly is handled alongside buffering of future
3065 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003066 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003067 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003068 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003069 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003071 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003072 }
3073 }
3074 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003076 /* With TLS we don't handle fragmentation (for now) */
3077 if( ssl->in_msglen < ssl->in_hslen )
3078 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3080 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003081 }
3082
Simon Butcher99000142016-10-13 17:21:01 +01003083 return( 0 );
3084}
3085
3086void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3087{
Hanno Becker0271f962018-08-16 13:23:47 +01003088 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003089
Hanno Becker0271f962018-08-16 13:23:47 +01003090 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003091 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003092 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003093 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003094
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003095 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003097 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003098 ssl->handshake != NULL )
3099 {
Hanno Becker0271f962018-08-16 13:23:47 +01003100 unsigned offset;
3101 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003102
Hanno Becker0271f962018-08-16 13:23:47 +01003103 /* Increment handshake sequence number */
3104 hs->in_msg_seq++;
3105
3106 /*
3107 * Clear up handshake buffering and reassembly structure.
3108 */
3109
3110 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003111 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003112
3113 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003114 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3115 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003116 offset++, hs_buf++ )
3117 {
3118 *hs_buf = *(hs_buf + 1);
3119 }
3120
3121 /* Create a fresh last entry */
3122 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003123 }
3124#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003125}
3126
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003127/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003128 * DTLS anti-replay: RFC 6347 4.1.2.6
3129 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003130 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3131 * Bit n is set iff record number in_window_top - n has been seen.
3132 *
3133 * Usually, in_window_top is the last record number seen and the lsb of
3134 * in_window is set. The only exception is the initial state (record number 0
3135 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003138void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003139{
3140 ssl->in_window_top = 0;
3141 ssl->in_window = 0;
3142}
3143
3144static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3145{
3146 return( ( (uint64_t) buf[0] << 40 ) |
3147 ( (uint64_t) buf[1] << 32 ) |
3148 ( (uint64_t) buf[2] << 24 ) |
3149 ( (uint64_t) buf[3] << 16 ) |
3150 ( (uint64_t) buf[4] << 8 ) |
3151 ( (uint64_t) buf[5] ) );
3152}
3153
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003154static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3155{
Janos Follath865b3eb2019-12-16 11:46:15 +00003156 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003157 unsigned char *original_in_ctr;
3158
3159 // save original in_ctr
3160 original_in_ctr = ssl->in_ctr;
3161
3162 // use counter from record
3163 ssl->in_ctr = record_in_ctr;
3164
3165 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3166
3167 // restore the counter
3168 ssl->in_ctr = original_in_ctr;
3169
3170 return ret;
3171}
3172
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003173/*
3174 * Return 0 if sequence number is acceptable, -1 otherwise
3175 */
Hanno Becker0183d692019-07-12 08:50:37 +01003176int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003177{
3178 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3179 uint64_t bit;
3180
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003181 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003182 return( 0 );
3183
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003184 if( rec_seqnum > ssl->in_window_top )
3185 return( 0 );
3186
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003187 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003188
3189 if( bit >= 64 )
3190 return( -1 );
3191
3192 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3193 return( -1 );
3194
3195 return( 0 );
3196}
3197
3198/*
3199 * Update replay window on new validated record
3200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003202{
3203 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3204
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003205 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003206 return;
3207
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003208 if( rec_seqnum > ssl->in_window_top )
3209 {
3210 /* Update window_top and the contents of the window */
3211 uint64_t shift = rec_seqnum - ssl->in_window_top;
3212
3213 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003214 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003215 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003216 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003217 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003218 ssl->in_window |= 1;
3219 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003220
3221 ssl->in_window_top = rec_seqnum;
3222 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003223 else
3224 {
3225 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003226 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003227
3228 if( bit < 64 ) /* Always true, but be extra sure */
3229 ssl->in_window |= (uint64_t) 1 << bit;
3230 }
3231}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003233
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003234#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003235/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003236 * Without any SSL context, check if a datagram looks like a ClientHello with
3237 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003238 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003239 *
3240 * - if cookie is valid, return 0
3241 * - if ClientHello looks superficially valid but cookie is not,
3242 * fill obuf and set olen, then
3243 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3244 * - otherwise return a specific error code
3245 */
3246static int ssl_check_dtls_clihlo_cookie(
3247 mbedtls_ssl_cookie_write_t *f_cookie_write,
3248 mbedtls_ssl_cookie_check_t *f_cookie_check,
3249 void *p_cookie,
3250 const unsigned char *cli_id, size_t cli_id_len,
3251 const unsigned char *in, size_t in_len,
3252 unsigned char *obuf, size_t buf_len, size_t *olen )
3253{
3254 size_t sid_len, cookie_len;
3255 unsigned char *p;
3256
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003257 /*
3258 * Structure of ClientHello with record and handshake headers,
3259 * and expected values. We don't need to check a lot, more checks will be
3260 * done when actually parsing the ClientHello - skipping those checks
3261 * avoids code duplication and does not make cookie forging any easier.
3262 *
3263 * 0-0 ContentType type; copied, must be handshake
3264 * 1-2 ProtocolVersion version; copied
3265 * 3-4 uint16 epoch; copied, must be 0
3266 * 5-10 uint48 sequence_number; copied
3267 * 11-12 uint16 length; (ignored)
3268 *
3269 * 13-13 HandshakeType msg_type; (ignored)
3270 * 14-16 uint24 length; (ignored)
3271 * 17-18 uint16 message_seq; copied
3272 * 19-21 uint24 fragment_offset; copied, must be 0
3273 * 22-24 uint24 fragment_length; (ignored)
3274 *
3275 * 25-26 ProtocolVersion client_version; (ignored)
3276 * 27-58 Random random; (ignored)
3277 * 59-xx SessionID session_id; 1 byte len + sid_len content
3278 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3279 * ...
3280 *
3281 * Minimum length is 61 bytes.
3282 */
3283 if( in_len < 61 ||
3284 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3285 in[3] != 0 || in[4] != 0 ||
3286 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3287 {
3288 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3289 }
3290
3291 sid_len = in[59];
3292 if( sid_len > in_len - 61 )
3293 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3294
3295 cookie_len = in[60 + sid_len];
3296 if( cookie_len > in_len - 60 )
3297 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3298
3299 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3300 cli_id, cli_id_len ) == 0 )
3301 {
3302 /* Valid cookie */
3303 return( 0 );
3304 }
3305
3306 /*
3307 * If we get here, we've got an invalid cookie, let's prepare HVR.
3308 *
3309 * 0-0 ContentType type; copied
3310 * 1-2 ProtocolVersion version; copied
3311 * 3-4 uint16 epoch; copied
3312 * 5-10 uint48 sequence_number; copied
3313 * 11-12 uint16 length; olen - 13
3314 *
3315 * 13-13 HandshakeType msg_type; hello_verify_request
3316 * 14-16 uint24 length; olen - 25
3317 * 17-18 uint16 message_seq; copied
3318 * 19-21 uint24 fragment_offset; copied
3319 * 22-24 uint24 fragment_length; olen - 25
3320 *
3321 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3322 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3323 *
3324 * Minimum length is 28.
3325 */
3326 if( buf_len < 28 )
3327 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3328
3329 /* Copy most fields and adapt others */
3330 memcpy( obuf, in, 25 );
3331 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3332 obuf[25] = 0xfe;
3333 obuf[26] = 0xff;
3334
3335 /* Generate and write actual cookie */
3336 p = obuf + 28;
3337 if( f_cookie_write( p_cookie,
3338 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3339 {
3340 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3341 }
3342
3343 *olen = p - obuf;
3344
3345 /* Go back and fill length fields */
3346 obuf[27] = (unsigned char)( *olen - 28 );
3347
3348 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3349 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3350 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3351
3352 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3353 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3354
3355 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3356}
3357
3358/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003359 * Handle possible client reconnect with the same UDP quadruplet
3360 * (RFC 6347 Section 4.2.8).
3361 *
3362 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3363 * that looks like a ClientHello.
3364 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003365 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003366 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003367 * - if the input looks like a ClientHello with a valid cookie,
3368 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003369 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003370 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003371 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003372 * This function is called (through ssl_check_client_reconnect()) when an
3373 * unexpected record is found in ssl_get_next_record(), which will discard the
3374 * record if we return 0, and bubble up the return value otherwise (this
3375 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3376 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003377 */
3378static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3379{
Janos Follath865b3eb2019-12-16 11:46:15 +00003380 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003381 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003382
Hanno Becker2fddd372019-07-10 14:37:41 +01003383 if( ssl->conf->f_cookie_write == NULL ||
3384 ssl->conf->f_cookie_check == NULL )
3385 {
3386 /* If we can't use cookies to verify reachability of the peer,
3387 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003388 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3389 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003390 return( 0 );
3391 }
3392
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003393 ret = ssl_check_dtls_clihlo_cookie(
3394 ssl->conf->f_cookie_write,
3395 ssl->conf->f_cookie_check,
3396 ssl->conf->p_cookie,
3397 ssl->cli_id, ssl->cli_id_len,
3398 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003399 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003400
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003401 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3402
3403 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003404 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003405 int send_ret;
3406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3407 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3408 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003409 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003410 * If the error is permanent we'll catch it later,
3411 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003412 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3413 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3414 (void) send_ret;
3415
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003416 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003417 }
3418
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003419 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003420 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003422 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003423 {
3424 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3425 return( ret );
3426 }
3427
3428 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003429 }
3430
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003431 return( ret );
3432}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003433#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003434
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003435static int ssl_check_record_type( uint8_t record_type )
3436{
3437 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3438 record_type != MBEDTLS_SSL_MSG_ALERT &&
3439 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3440 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3441 {
3442 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3443 }
3444
3445 return( 0 );
3446}
3447
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003448/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003449 * ContentType type;
3450 * ProtocolVersion version;
3451 * uint16 epoch; // DTLS only
3452 * uint48 sequence_number; // DTLS only
3453 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003454 *
3455 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003456 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003457 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3458 *
3459 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003460 * 1. proceed with the record if this function returns 0
3461 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3462 * 3. return CLIENT_RECONNECT if this function return that value
3463 * 4. drop the whole datagram if this function returns anything else.
3464 * Point 2 is needed when the peer is resending, and we have already received
3465 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003466 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003467static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003468 unsigned char *buf,
3469 size_t len,
3470 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003471{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003472 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003473
Hanno Beckere5e7e782019-07-11 12:29:35 +01003474 size_t const rec_hdr_type_offset = 0;
3475 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003476
Hanno Beckere5e7e782019-07-11 12:29:35 +01003477 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3478 rec_hdr_type_len;
3479 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003480
Hanno Beckere5e7e782019-07-11 12:29:35 +01003481 size_t const rec_hdr_ctr_len = 8;
3482#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003483 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003484 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3485 rec_hdr_version_len;
3486
Hanno Beckera0e20d02019-05-15 14:03:01 +01003487#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003488 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3489 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003490 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3492#endif /* MBEDTLS_SSL_PROTO_DTLS */
3493
3494 size_t rec_hdr_len_offset; /* To be determined */
3495 size_t const rec_hdr_len_len = 2;
3496
3497 /*
3498 * Check minimum lengths for record header.
3499 */
3500
3501#if defined(MBEDTLS_SSL_PROTO_DTLS)
3502 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3503 {
3504 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3505 }
3506 else
3507#endif /* MBEDTLS_SSL_PROTO_DTLS */
3508 {
3509 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3510 }
3511
3512 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3513 {
3514 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3515 (unsigned) len,
3516 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3517 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3518 }
3519
3520 /*
3521 * Parse and validate record content type
3522 */
3523
3524 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003525
3526 /* Check record content type */
3527#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3528 rec->cid_len = 0;
3529
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003530 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003531 ssl->conf->cid_len != 0 &&
3532 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003533 {
3534 /* Shift pointers to account for record header including CID
3535 * struct {
3536 * ContentType special_type = tls12_cid;
3537 * ProtocolVersion version;
3538 * uint16 epoch;
3539 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003540 * opaque cid[cid_length]; // Additional field compared to
3541 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003542 * uint16 length;
3543 * opaque enc_content[DTLSCiphertext.length];
3544 * } DTLSCiphertext;
3545 */
3546
3547 /* So far, we only support static CID lengths
3548 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003549 rec_hdr_cid_len = ssl->conf->cid_len;
3550 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003551
Hanno Beckere5e7e782019-07-11 12:29:35 +01003552 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003553 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003554 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3555 (unsigned) len,
3556 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003557 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003558 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003559
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003560 /* configured CID len is guaranteed at most 255, see
3561 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3562 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003563 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003564 }
3565 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003566#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003567 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568 if( ssl_check_record_type( rec->type ) )
3569 {
Hanno Becker54229812019-07-12 14:40:00 +01003570 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3571 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003572 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3573 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003574 }
3575
Hanno Beckere5e7e782019-07-11 12:29:35 +01003576 /*
3577 * Parse and validate record version
3578 */
3579
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003580 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3581 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003582 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3583 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003584 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003585
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003586 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003587 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3589 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003590 }
3591
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003592 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003593 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3595 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003596 }
3597
Hanno Beckere5e7e782019-07-11 12:29:35 +01003598 /*
3599 * Parse/Copy record sequence number.
3600 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003601
Hanno Beckere5e7e782019-07-11 12:29:35 +01003602#if defined(MBEDTLS_SSL_PROTO_DTLS)
3603 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003604 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003605 /* Copy explicit record sequence number from input buffer. */
3606 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3607 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003608 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003609 else
3610#endif /* MBEDTLS_SSL_PROTO_DTLS */
3611 {
3612 /* Copy implicit record sequence number from SSL context structure. */
3613 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3614 }
Paul Bakker40e46942009-01-03 21:51:57 +00003615
Hanno Beckere5e7e782019-07-11 12:29:35 +01003616 /*
3617 * Parse record length.
3618 */
3619
Hanno Beckere5e7e782019-07-11 12:29:35 +01003620 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003621 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3622 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003623 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003624
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003626 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003627 rec->type,
3628 major_ver, minor_ver, rec->data_len ) );
3629
3630 rec->buf = buf;
3631 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003632
Hanno Beckerd417cc92019-07-26 08:20:27 +01003633 if( rec->data_len == 0 )
3634 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003635
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003636 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003637 * DTLS-related tests.
3638 * Check epoch before checking length constraint because
3639 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3640 * message gets duplicated before the corresponding Finished message,
3641 * the second ChangeCipherSpec should be discarded because it belongs
3642 * to an old epoch, but not because its length is shorter than
3643 * the minimum record length for packets using the new record transform.
3644 * Note that these two kinds of failures are handled differently,
3645 * as an unexpected record is silently skipped but an invalid
3646 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003647 */
3648#if defined(MBEDTLS_SSL_PROTO_DTLS)
3649 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3650 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003652
Hanno Becker955a5c92019-07-10 17:12:07 +01003653 /* Check that the datagram is large enough to contain a record
3654 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003655 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003656 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3658 (unsigned) len,
3659 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003660 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3661 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003662
Hanno Becker37cfe732019-07-10 17:20:01 +01003663 /* Records from other, non-matching epochs are silently discarded.
3664 * (The case of same-port Client reconnects must be considered in
3665 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003666 if( rec_epoch != ssl->in_epoch )
3667 {
3668 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3669 "expected %d, received %d",
3670 ssl->in_epoch, rec_epoch ) );
3671
Hanno Becker552f7472019-07-19 10:59:12 +01003672 /* Records from the next epoch are considered for buffering
3673 * (concretely: early Finished messages). */
3674 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003675 {
Hanno Becker552f7472019-07-19 10:59:12 +01003676 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3677 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003678 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003679
Hanno Becker2fddd372019-07-10 14:37:41 +01003680 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003681 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003682#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003683 /* For records from the correct epoch, check whether their
3684 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003685 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3686 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003687 {
3688 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3689 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3690 }
3691#endif
3692 }
3693#endif /* MBEDTLS_SSL_PROTO_DTLS */
3694
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003695 return( 0 );
3696}
Paul Bakker5121ce52009-01-03 21:22:43 +00003697
Paul Bakker5121ce52009-01-03 21:22:43 +00003698
Hanno Becker2fddd372019-07-10 14:37:41 +01003699#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3700static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3701{
3702 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3703
3704 /*
3705 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3706 * access the first byte of record content (handshake type), as we
3707 * have an active transform (possibly iv_len != 0), so use the
3708 * fact that the record header len is 13 instead.
3709 */
3710 if( rec_epoch == 0 &&
3711 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3712 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3713 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3714 ssl->in_left > 13 &&
3715 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3716 {
3717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3718 "from the same port" ) );
3719 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003720 }
3721
3722 return( 0 );
3723}
Hanno Becker2fddd372019-07-10 14:37:41 +01003724#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003725
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003726/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003727 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003728 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003729static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3730 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003731{
3732 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003735 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003737#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3738 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003739 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003740 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742 ret = mbedtls_ssl_hw_record_read( ssl );
3743 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003745 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3746 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003747 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003748
3749 if( ret == 0 )
3750 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003751 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003752#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003753 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003754 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003755 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003756
Hanno Beckera18d1322018-01-03 14:27:32 +00003757 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003758 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003759 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003760 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003761
Hanno Beckera0e20d02019-05-15 14:03:01 +01003762#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003763 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3764 ssl->conf->ignore_unexpected_cid
3765 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3766 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003767 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003768 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003769 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003770#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003771
Paul Bakker5121ce52009-01-03 21:22:43 +00003772 return( ret );
3773 }
3774
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003775 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003776 {
3777 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003778 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003779 }
3780
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003781 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003782 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003783
Hanno Beckera0e20d02019-05-15 14:03:01 +01003784#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003785 /* We have already checked the record content type
3786 * in ssl_parse_record_header(), failing or silently
3787 * dropping the record in the case of an unknown type.
3788 *
3789 * Since with the use of CIDs, the record content type
3790 * might change during decryption, re-check the record
3791 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003792 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003793 {
3794 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3795 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3796 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003797#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003798
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003799 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003800 {
3801#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3802 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003803 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003804 {
3805 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3807 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3808 }
3809#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3810
3811 ssl->nb_zero++;
3812
3813 /*
3814 * Three or more empty messages may be a DoS attack
3815 * (excessive CPU consumption).
3816 */
3817 if( ssl->nb_zero > 3 )
3818 {
3819 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003820 "messages, possible DoS attack" ) );
3821 /* Treat the records as if they were not properly authenticated,
3822 * thereby failing the connection if we see more than allowed
3823 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003824 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3825 }
3826 }
3827 else
3828 ssl->nb_zero = 0;
3829
3830#if defined(MBEDTLS_SSL_PROTO_DTLS)
3831 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3832 {
3833 ; /* in_ctr read from peer, not maintained internally */
3834 }
3835 else
3836#endif
3837 {
3838 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003839 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003840 if( ++ssl->in_ctr[i - 1] != 0 )
3841 break;
3842
3843 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003844 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003845 {
3846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3847 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3848 }
3849 }
3850
Paul Bakker5121ce52009-01-03 21:22:43 +00003851 }
3852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003853#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003854 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003855 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003856 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003857 }
3858#endif
3859
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003860 /* Check actual (decrypted) record content length against
3861 * configured maximum. */
3862 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3863 {
3864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3865 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3866 }
3867
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003868 return( 0 );
3869}
3870
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003871/*
3872 * Read a record.
3873 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003874 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3875 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3876 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003877 */
Hanno Becker1097b342018-08-15 14:09:41 +01003878
3879/* Helper functions for mbedtls_ssl_read_record(). */
3880static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003881static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3882static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003883
Hanno Becker327c93b2018-08-15 13:56:18 +01003884int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003885 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003886{
Janos Follath865b3eb2019-12-16 11:46:15 +00003887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003888
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003890
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003891 if( ssl->keep_current_message == 0 )
3892 {
3893 do {
Simon Butcher99000142016-10-13 17:21:01 +01003894
Hanno Becker26994592018-08-15 14:14:59 +01003895 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003896 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003897 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003898
Hanno Beckere74d5562018-08-15 14:26:08 +01003899 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003900 {
Hanno Becker40f50842018-08-15 14:48:01 +01003901#if defined(MBEDTLS_SSL_PROTO_DTLS)
3902 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003903
Hanno Becker40f50842018-08-15 14:48:01 +01003904 /* We only check for buffered messages if the
3905 * current datagram is fully consumed. */
3906 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003907 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003908 {
Hanno Becker40f50842018-08-15 14:48:01 +01003909 if( ssl_load_buffered_message( ssl ) == 0 )
3910 have_buffered = 1;
3911 }
3912
3913 if( have_buffered == 0 )
3914#endif /* MBEDTLS_SSL_PROTO_DTLS */
3915 {
3916 ret = ssl_get_next_record( ssl );
3917 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3918 continue;
3919
3920 if( ret != 0 )
3921 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003922 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003923 return( ret );
3924 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003925 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003926 }
3927
3928 ret = mbedtls_ssl_handle_message_type( ssl );
3929
Hanno Becker40f50842018-08-15 14:48:01 +01003930#if defined(MBEDTLS_SSL_PROTO_DTLS)
3931 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3932 {
3933 /* Buffer future message */
3934 ret = ssl_buffer_message( ssl );
3935 if( ret != 0 )
3936 return( ret );
3937
3938 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3939 }
3940#endif /* MBEDTLS_SSL_PROTO_DTLS */
3941
Hanno Becker90333da2017-10-10 11:27:13 +01003942 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3943 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003944
3945 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003946 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003947 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003948 return( ret );
3949 }
3950
Hanno Becker327c93b2018-08-15 13:56:18 +01003951 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003952 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003953 {
3954 mbedtls_ssl_update_handshake_status( ssl );
3955 }
Simon Butcher99000142016-10-13 17:21:01 +01003956 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003957 else
Simon Butcher99000142016-10-13 17:21:01 +01003958 {
Hanno Becker02f59072018-08-15 14:00:24 +01003959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003960 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003961 }
3962
3963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3964
3965 return( 0 );
3966}
3967
Hanno Becker40f50842018-08-15 14:48:01 +01003968#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003969static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003970{
Hanno Becker40f50842018-08-15 14:48:01 +01003971 if( ssl->in_left > ssl->next_record_offset )
3972 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003973
Hanno Becker40f50842018-08-15 14:48:01 +01003974 return( 0 );
3975}
3976
3977static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3978{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003979 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003980 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003981 int ret = 0;
3982
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003983 if( hs == NULL )
3984 return( -1 );
3985
Hanno Beckere00ae372018-08-20 09:39:42 +01003986 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3987
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003988 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3989 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3990 {
3991 /* Check if we have seen a ChangeCipherSpec before.
3992 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003993 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003994 {
3995 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3996 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003997 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003998 }
3999
Hanno Becker39b8bc92018-08-28 17:17:13 +01004000 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004001 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4002 ssl->in_msglen = 1;
4003 ssl->in_msg[0] = 1;
4004
4005 /* As long as they are equal, the exact value doesn't matter. */
4006 ssl->in_left = 0;
4007 ssl->next_record_offset = 0;
4008
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004009 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004010 goto exit;
4011 }
Hanno Becker37f95322018-08-16 13:55:32 +01004012
Hanno Beckerb8f50142018-08-28 10:01:34 +01004013#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004014 /* Debug only */
4015 {
4016 unsigned offset;
4017 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4018 {
4019 hs_buf = &hs->buffering.hs[offset];
4020 if( hs_buf->is_valid == 1 )
4021 {
4022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4023 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004024 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004025 }
4026 }
4027 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004028#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004029
4030 /* Check if we have buffered and/or fully reassembled the
4031 * next handshake message. */
4032 hs_buf = &hs->buffering.hs[0];
4033 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4034 {
4035 /* Synthesize a record containing the buffered HS message. */
4036 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4037 ( hs_buf->data[2] << 8 ) |
4038 hs_buf->data[3];
4039
4040 /* Double-check that we haven't accidentally buffered
4041 * a message that doesn't fit into the input buffer. */
4042 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4043 {
4044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4045 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4046 }
4047
4048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4049 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4050 hs_buf->data, msg_len + 12 );
4051
4052 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4053 ssl->in_hslen = msg_len + 12;
4054 ssl->in_msglen = msg_len + 12;
4055 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4056
4057 ret = 0;
4058 goto exit;
4059 }
4060 else
4061 {
4062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4063 hs->in_msg_seq ) );
4064 }
4065
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004066 ret = -1;
4067
4068exit:
4069
4070 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4071 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004072}
4073
Hanno Beckera02b0b42018-08-21 17:20:27 +01004074static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4075 size_t desired )
4076{
4077 int offset;
4078 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4080 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004081
Hanno Becker01315ea2018-08-21 17:22:17 +01004082 /* Get rid of future records epoch first, if such exist. */
4083 ssl_free_buffered_record( ssl );
4084
4085 /* Check if we have enough space available now. */
4086 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4087 hs->buffering.total_bytes_buffered ) )
4088 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004089 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004090 return( 0 );
4091 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004092
Hanno Becker4f432ad2018-08-28 10:02:32 +01004093 /* We don't have enough space to buffer the next expected handshake
4094 * message. Remove buffers used for future messages to gain space,
4095 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004096 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4097 offset >= 0; offset-- )
4098 {
4099 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4100 offset ) );
4101
Hanno Beckerb309b922018-08-23 13:18:05 +01004102 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004103
4104 /* Check if we have enough space available now. */
4105 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4106 hs->buffering.total_bytes_buffered ) )
4107 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004109 return( 0 );
4110 }
4111 }
4112
4113 return( -1 );
4114}
4115
Hanno Becker40f50842018-08-15 14:48:01 +01004116static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4117{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004118 int ret = 0;
4119 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4120
4121 if( hs == NULL )
4122 return( 0 );
4123
4124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4125
4126 switch( ssl->in_msgtype )
4127 {
4128 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004130
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004131 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004132 break;
4133
4134 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004135 {
4136 unsigned recv_msg_seq_offset;
4137 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4138 mbedtls_ssl_hs_buffer *hs_buf;
4139 size_t msg_len = ssl->in_hslen - 12;
4140
4141 /* We should never receive an old handshake
4142 * message - double-check nonetheless. */
4143 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4144 {
4145 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4146 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4147 }
4148
4149 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4150 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4151 {
4152 /* Silently ignore -- message too far in the future */
4153 MBEDTLS_SSL_DEBUG_MSG( 2,
4154 ( "Ignore future HS message with sequence number %u, "
4155 "buffering window %u - %u",
4156 recv_msg_seq, ssl->handshake->in_msg_seq,
4157 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4158
4159 goto exit;
4160 }
4161
4162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4163 recv_msg_seq, recv_msg_seq_offset ) );
4164
4165 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4166
4167 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004168 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004169 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004170 size_t reassembly_buf_sz;
4171
Hanno Becker37f95322018-08-16 13:55:32 +01004172 hs_buf->is_fragmented =
4173 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4174
4175 /* We copy the message back into the input buffer
4176 * after reassembly, so check that it's not too large.
4177 * This is an implementation-specific limitation
4178 * and not one from the standard, hence it is not
4179 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004180 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004181 {
4182 /* Ignore message */
4183 goto exit;
4184 }
4185
Hanno Beckere0b150f2018-08-21 15:51:03 +01004186 /* Check if we have enough space to buffer the message. */
4187 if( hs->buffering.total_bytes_buffered >
4188 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4189 {
4190 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4191 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4192 }
4193
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004194 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4195 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004196
4197 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4198 hs->buffering.total_bytes_buffered ) )
4199 {
4200 if( recv_msg_seq_offset > 0 )
4201 {
4202 /* If we can't buffer a future message because
4203 * of space limitations -- ignore. */
4204 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",
4205 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4206 (unsigned) hs->buffering.total_bytes_buffered ) );
4207 goto exit;
4208 }
Hanno Beckere1801392018-08-21 16:51:05 +01004209 else
4210 {
4211 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",
4212 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4213 (unsigned) hs->buffering.total_bytes_buffered ) );
4214 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004215
Hanno Beckera02b0b42018-08-21 17:20:27 +01004216 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004217 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004218 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",
4219 (unsigned) msg_len,
4220 (unsigned) reassembly_buf_sz,
4221 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004222 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004223 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4224 goto exit;
4225 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004226 }
4227
4228 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4229 msg_len ) );
4230
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004231 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4232 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004233 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004234 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004235 goto exit;
4236 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004237 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004238
4239 /* Prepare final header: copy msg_type, length and message_seq,
4240 * then add standardised fragment_offset and fragment_length */
4241 memcpy( hs_buf->data, ssl->in_msg, 6 );
4242 memset( hs_buf->data + 6, 0, 3 );
4243 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4244
4245 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004246
4247 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004248 }
4249 else
4250 {
4251 /* Make sure msg_type and length are consistent */
4252 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4253 {
4254 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4255 /* Ignore */
4256 goto exit;
4257 }
4258 }
4259
Hanno Becker4422bbb2018-08-20 09:40:19 +01004260 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004261 {
4262 size_t frag_len, frag_off;
4263 unsigned char * const msg = hs_buf->data + 12;
4264
4265 /*
4266 * Check and copy current fragment
4267 */
4268
4269 /* Validation of header fields already done in
4270 * mbedtls_ssl_prepare_handshake_record(). */
4271 frag_off = ssl_get_hs_frag_off( ssl );
4272 frag_len = ssl_get_hs_frag_len( ssl );
4273
4274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4275 frag_off, frag_len ) );
4276 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4277
4278 if( hs_buf->is_fragmented )
4279 {
4280 unsigned char * const bitmask = msg + msg_len;
4281 ssl_bitmask_set( bitmask, frag_off, frag_len );
4282 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4283 msg_len ) == 0 );
4284 }
4285 else
4286 {
4287 hs_buf->is_complete = 1;
4288 }
4289
4290 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4291 hs_buf->is_complete ? "" : "not yet " ) );
4292 }
4293
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004294 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004295 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004296
4297 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004298 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004299 break;
4300 }
4301
4302exit:
4303
4304 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4305 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004306}
4307#endif /* MBEDTLS_SSL_PROTO_DTLS */
4308
Hanno Becker1097b342018-08-15 14:09:41 +01004309static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004310{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004311 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004312 * Consume last content-layer message and potentially
4313 * update in_msglen which keeps track of the contents'
4314 * consumption state.
4315 *
4316 * (1) Handshake messages:
4317 * Remove last handshake message, move content
4318 * and adapt in_msglen.
4319 *
4320 * (2) Alert messages:
4321 * Consume whole record content, in_msglen = 0.
4322 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004323 * (3) Change cipher spec:
4324 * Consume whole record content, in_msglen = 0.
4325 *
4326 * (4) Application data:
4327 * Don't do anything - the record layer provides
4328 * the application data as a stream transport
4329 * and consumes through mbedtls_ssl_read only.
4330 *
4331 */
4332
4333 /* Case (1): Handshake messages */
4334 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004335 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004336 /* Hard assertion to be sure that no application data
4337 * is in flight, as corrupting ssl->in_msglen during
4338 * ssl->in_offt != NULL is fatal. */
4339 if( ssl->in_offt != NULL )
4340 {
4341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4342 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4343 }
4344
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004345 /*
4346 * Get next Handshake message in the current record
4347 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004348
Hanno Becker4a810fb2017-05-24 16:27:30 +01004349 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004350 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004351 * current handshake content: If DTLS handshake
4352 * fragmentation is used, that's the fragment
4353 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004354 * size here is faulty and should be changed at
4355 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004356 * (2) While it doesn't seem to cause problems, one
4357 * has to be very careful not to assume that in_hslen
4358 * is always <= in_msglen in a sensible communication.
4359 * Again, it's wrong for DTLS handshake fragmentation.
4360 * The following check is therefore mandatory, and
4361 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004362 * Additionally, ssl->in_hslen might be arbitrarily out of
4363 * bounds after handling a DTLS message with an unexpected
4364 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004365 */
4366 if( ssl->in_hslen < ssl->in_msglen )
4367 {
4368 ssl->in_msglen -= ssl->in_hslen;
4369 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4370 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004371
Hanno Becker4a810fb2017-05-24 16:27:30 +01004372 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4373 ssl->in_msg, ssl->in_msglen );
4374 }
4375 else
4376 {
4377 ssl->in_msglen = 0;
4378 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004379
Hanno Becker4a810fb2017-05-24 16:27:30 +01004380 ssl->in_hslen = 0;
4381 }
4382 /* Case (4): Application data */
4383 else if( ssl->in_offt != NULL )
4384 {
4385 return( 0 );
4386 }
4387 /* Everything else (CCS & Alerts) */
4388 else
4389 {
4390 ssl->in_msglen = 0;
4391 }
4392
Hanno Becker1097b342018-08-15 14:09:41 +01004393 return( 0 );
4394}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004395
Hanno Beckere74d5562018-08-15 14:26:08 +01004396static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4397{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004398 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004399 return( 1 );
4400
4401 return( 0 );
4402}
4403
Hanno Becker5f066e72018-08-16 14:56:31 +01004404#if defined(MBEDTLS_SSL_PROTO_DTLS)
4405
4406static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4407{
4408 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4409 if( hs == NULL )
4410 return;
4411
Hanno Becker01315ea2018-08-21 17:22:17 +01004412 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004413 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004414 hs->buffering.total_bytes_buffered -=
4415 hs->buffering.future_record.len;
4416
4417 mbedtls_free( hs->buffering.future_record.data );
4418 hs->buffering.future_record.data = NULL;
4419 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004420}
4421
4422static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4423{
4424 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4425 unsigned char * rec;
4426 size_t rec_len;
4427 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004428#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4429 size_t in_buf_len = ssl->in_buf_len;
4430#else
4431 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4432#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004433 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4434 return( 0 );
4435
4436 if( hs == NULL )
4437 return( 0 );
4438
Hanno Becker5f066e72018-08-16 14:56:31 +01004439 rec = hs->buffering.future_record.data;
4440 rec_len = hs->buffering.future_record.len;
4441 rec_epoch = hs->buffering.future_record.epoch;
4442
4443 if( rec == NULL )
4444 return( 0 );
4445
Hanno Becker4cb782d2018-08-20 11:19:05 +01004446 /* Only consider loading future records if the
4447 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004448 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004449 return( 0 );
4450
Hanno Becker5f066e72018-08-16 14:56:31 +01004451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4452
4453 if( rec_epoch != ssl->in_epoch )
4454 {
4455 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4456 goto exit;
4457 }
4458
4459 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4460
4461 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004462 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004463 {
4464 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4465 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4466 }
4467
4468 memcpy( ssl->in_hdr, rec, rec_len );
4469 ssl->in_left = rec_len;
4470 ssl->next_record_offset = 0;
4471
4472 ssl_free_buffered_record( ssl );
4473
4474exit:
4475 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4476 return( 0 );
4477}
4478
Hanno Becker519f15d2019-07-11 12:43:20 +01004479static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4480 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004481{
4482 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004483
4484 /* Don't buffer future records outside handshakes. */
4485 if( hs == NULL )
4486 return( 0 );
4487
4488 /* Only buffer handshake records (we are only interested
4489 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004490 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004491 return( 0 );
4492
4493 /* Don't buffer more than one future epoch record. */
4494 if( hs->buffering.future_record.data != NULL )
4495 return( 0 );
4496
Hanno Becker01315ea2018-08-21 17:22:17 +01004497 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004498 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004499 hs->buffering.total_bytes_buffered ) )
4500 {
4501 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 +01004502 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004503 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004504 return( 0 );
4505 }
4506
Hanno Becker5f066e72018-08-16 14:56:31 +01004507 /* Buffer record */
4508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4509 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004510 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004511
4512 /* ssl_parse_record_header() only considers records
4513 * of the next epoch as candidates for buffering. */
4514 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004515 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004516
4517 hs->buffering.future_record.data =
4518 mbedtls_calloc( 1, hs->buffering.future_record.len );
4519 if( hs->buffering.future_record.data == NULL )
4520 {
4521 /* If we run out of RAM trying to buffer a
4522 * record from the next epoch, just ignore. */
4523 return( 0 );
4524 }
4525
Hanno Becker519f15d2019-07-11 12:43:20 +01004526 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004527
Hanno Becker519f15d2019-07-11 12:43:20 +01004528 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004529 return( 0 );
4530}
4531
4532#endif /* MBEDTLS_SSL_PROTO_DTLS */
4533
Hanno Beckere74d5562018-08-15 14:26:08 +01004534static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004535{
Janos Follath865b3eb2019-12-16 11:46:15 +00004536 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004537 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004538
Hanno Becker5f066e72018-08-16 14:56:31 +01004539#if defined(MBEDTLS_SSL_PROTO_DTLS)
4540 /* We might have buffered a future record; if so,
4541 * and if the epoch matches now, load it.
4542 * On success, this call will set ssl->in_left to
4543 * the length of the buffered record, so that
4544 * the calls to ssl_fetch_input() below will
4545 * essentially be no-ops. */
4546 ret = ssl_load_buffered_record( ssl );
4547 if( ret != 0 )
4548 return( ret );
4549#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004550
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004551 /* Ensure that we have enough space available for the default form
4552 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4553 * with no space for CIDs counted in). */
4554 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4555 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004556 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004557 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004558 return( ret );
4559 }
4560
Hanno Beckere5e7e782019-07-11 12:29:35 +01004561 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4562 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004563 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004565 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004566 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004567 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4568 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004569 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004570 if( ret != 0 )
4571 return( ret );
4572
4573 /* Fall through to handling of unexpected records */
4574 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4575 }
4576
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004577 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4578 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004579#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004580 /* Reset in pointers to default state for TLS/DTLS records,
4581 * assuming no CID and no offset between record content and
4582 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004583 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004584
Hanno Becker7ae20e02019-07-12 08:33:49 +01004585 /* Setup internal message pointers from record structure. */
4586 ssl->in_msgtype = rec.type;
4587#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4588 ssl->in_len = ssl->in_cid + rec.cid_len;
4589#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4590 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4591 ssl->in_msglen = rec.data_len;
4592
Hanno Becker2fddd372019-07-10 14:37:41 +01004593 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004594 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004595 if( ret != 0 )
4596 return( ret );
4597#endif
4598
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004599 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004600 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004601
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4603 "(header)" ) );
4604 }
4605 else
4606 {
4607 /* Skip invalid record and the rest of the datagram */
4608 ssl->next_record_offset = 0;
4609 ssl->in_left = 0;
4610
4611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4612 "(header)" ) );
4613 }
4614
4615 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004616 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004617 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004618 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004619#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004620 {
4621 return( ret );
4622 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004623 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004625#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004626 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004627 {
Hanno Beckera8814792019-07-10 15:01:45 +01004628 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004629 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004630 if( ssl->next_record_offset < ssl->in_left )
4631 {
4632 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4633 }
4634 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004635 else
4636#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004637 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004638 /*
4639 * Fetch record contents from underlying transport.
4640 */
Hanno Beckera3175662019-07-11 12:50:29 +01004641 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004642 if( ret != 0 )
4643 {
4644 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4645 return( ret );
4646 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004647
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004648 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004649 }
4650
4651 /*
4652 * Decrypt record contents.
4653 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004654
Hanno Beckerfdf66042019-07-11 13:07:45 +01004655 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004656 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004658 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004659 {
4660 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004661 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004662 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004663 /* Except when waiting for Finished as a bad mac here
4664 * probably means something went wrong in the handshake
4665 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4666 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4667 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4668 {
4669#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4670 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4671 {
4672 mbedtls_ssl_send_alert_message( ssl,
4673 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4674 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4675 }
4676#endif
4677 return( ret );
4678 }
4679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004681 if( ssl->conf->badmac_limit != 0 &&
4682 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004683 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004684 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4685 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004686 }
4687#endif
4688
Hanno Becker4a810fb2017-05-24 16:27:30 +01004689 /* As above, invalid records cause
4690 * dismissal of the whole datagram. */
4691
4692 ssl->next_record_offset = 0;
4693 ssl->in_left = 0;
4694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004696 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004697 }
4698
4699 return( ret );
4700 }
4701 else
4702#endif
4703 {
4704 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004705#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4706 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004707 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708 mbedtls_ssl_send_alert_message( ssl,
4709 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4710 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004711 }
4712#endif
4713 return( ret );
4714 }
4715 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004716
Hanno Becker44d89b22019-07-12 09:40:44 +01004717
4718 /* Reset in pointers to default state for TLS/DTLS records,
4719 * assuming no CID and no offset between record content and
4720 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004721 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004722#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4723 ssl->in_len = ssl->in_cid + rec.cid_len;
4724#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004725 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004726
Hanno Becker8685c822019-07-12 09:37:30 +01004727 /* The record content type may change during decryption,
4728 * so re-read it. */
4729 ssl->in_msgtype = rec.type;
4730 /* Also update the input buffer, because unfortunately
4731 * the server-side ssl_parse_client_hello() reparses the
4732 * record header when receiving a ClientHello initiating
4733 * a renegotiation. */
4734 ssl->in_hdr[0] = rec.type;
4735 ssl->in_msg = rec.buf + rec.data_offset;
4736 ssl->in_msglen = rec.data_len;
4737 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4738 ssl->in_len[1] = (unsigned char)( rec.data_len );
4739
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004740#if defined(MBEDTLS_ZLIB_SUPPORT)
4741 if( ssl->transform_in != NULL &&
4742 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4743 {
4744 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4745 {
4746 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4747 return( ret );
4748 }
4749
4750 /* Check actual (decompress) record content length against
4751 * configured maximum. */
4752 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4753 {
4754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4755 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4756 }
4757 }
4758#endif /* MBEDTLS_ZLIB_SUPPORT */
4759
Simon Butcher99000142016-10-13 17:21:01 +01004760 return( 0 );
4761}
4762
4763int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4764{
Janos Follath865b3eb2019-12-16 11:46:15 +00004765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004766
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004767 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004768 * Handle particular types of records
4769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004770 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004771 {
Simon Butcher99000142016-10-13 17:21:01 +01004772 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4773 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004774 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004775 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004776 }
4777
Hanno Beckere678eaa2018-08-21 14:57:46 +01004778 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004779 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004780 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004781 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4783 ssl->in_msglen ) );
4784 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004785 }
4786
Hanno Beckere678eaa2018-08-21 14:57:46 +01004787 if( ssl->in_msg[0] != 1 )
4788 {
4789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4790 ssl->in_msg[0] ) );
4791 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4792 }
4793
4794#if defined(MBEDTLS_SSL_PROTO_DTLS)
4795 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4796 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4797 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4798 {
4799 if( ssl->handshake == NULL )
4800 {
4801 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4802 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4803 }
4804
4805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4806 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4807 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004808#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004809 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004811 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004812 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004813 if( ssl->in_msglen != 2 )
4814 {
4815 /* Note: Standard allows for more than one 2 byte alert
4816 to be packed in a single message, but Mbed TLS doesn't
4817 currently support this. */
4818 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4819 ssl->in_msglen ) );
4820 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4821 }
4822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004823 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004824 ssl->in_msg[0], ssl->in_msg[1] ) );
4825
4826 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004827 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004829 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004832 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004833 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004834 }
4835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004836 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4837 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004838 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4840 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004841 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004842
4843#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4844 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4845 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4846 {
Hanno Becker90333da2017-10-10 11:27:13 +01004847 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004848 /* Will be handled when trying to parse ServerHello */
4849 return( 0 );
4850 }
4851#endif
4852
4853#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4854 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4855 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4856 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4857 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4858 {
4859 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4860 /* Will be handled in mbedtls_ssl_parse_certificate() */
4861 return( 0 );
4862 }
4863#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4864
4865 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004866 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004867 }
4868
Hanno Beckerc76c6192017-06-06 10:03:17 +01004869#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004870 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004871 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004872 /* Drop unexpected ApplicationData records,
4873 * except at the beginning of renegotiations */
4874 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4875 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4876#if defined(MBEDTLS_SSL_RENEGOTIATION)
4877 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4878 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004879#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004880 )
4881 {
4882 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4883 return( MBEDTLS_ERR_SSL_NON_FATAL );
4884 }
4885
4886 if( ssl->handshake != NULL &&
4887 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4888 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004889 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004890 }
4891 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004892#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004893
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 return( 0 );
4895}
4896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004897int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004898{
irwir6c0da642019-09-26 21:07:41 +03004899 return( mbedtls_ssl_send_alert_message( ssl,
4900 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4901 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004902}
4903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004904int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004905 unsigned char level,
4906 unsigned char message )
4907{
Janos Follath865b3eb2019-12-16 11:46:15 +00004908 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004909
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004910 if( ssl == NULL || ssl->conf == NULL )
4911 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004914 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004916 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004917 ssl->out_msglen = 2;
4918 ssl->out_msg[0] = level;
4919 ssl->out_msg[1] = message;
4920
Hanno Becker67bc7c32018-08-06 11:33:50 +01004921 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004922 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004924 return( ret );
4925 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004927
4928 return( 0 );
4929}
4930
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004931int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004932{
Janos Follath865b3eb2019-12-16 11:46:15 +00004933 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004938 ssl->out_msglen = 1;
4939 ssl->out_msg[0] = 1;
4940
Paul Bakker5121ce52009-01-03 21:22:43 +00004941 ssl->state++;
4942
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004943 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004944 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004945 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004946 return( ret );
4947 }
4948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004949 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004950
4951 return( 0 );
4952}
4953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004954int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004955{
Janos Follath865b3eb2019-12-16 11:46:15 +00004956 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004958 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004959
Hanno Becker327c93b2018-08-15 13:56:18 +01004960 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004961 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004962 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004963 return( ret );
4964 }
4965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004966 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004967 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004968 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004969 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4970 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004971 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004972 }
4973
Hanno Beckere678eaa2018-08-21 14:57:46 +01004974 /* CCS records are only accepted if they have length 1 and content '1',
4975 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004976
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004977 /*
4978 * Switch to our negotiated transform and session parameters for inbound
4979 * data.
4980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004981 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004982 ssl->transform_in = ssl->transform_negotiate;
4983 ssl->session_in = ssl->session_negotiate;
4984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004985#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004986 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004987 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004989 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004990#endif
4991
4992 /* Increment epoch */
4993 if( ++ssl->in_epoch == 0 )
4994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004995 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004996 /* This is highly unlikely to happen for legitimate reasons, so
4997 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004998 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004999 }
5000 }
5001 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005002#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005003 memset( ssl->in_ctr, 0, 8 );
5004
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005005 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005007#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5008 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005009 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005010 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005011 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005012 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005013 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5014 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005015 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005016 }
5017 }
5018#endif
5019
Paul Bakker5121ce52009-01-03 21:22:43 +00005020 ssl->state++;
5021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005023
5024 return( 0 );
5025}
5026
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005027/* Once ssl->out_hdr as the address of the beginning of the
5028 * next outgoing record is set, deduce the other pointers.
5029 *
5030 * Note: For TLS, we save the implicit record sequence number
5031 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5032 * and the caller has to make sure there's space for this.
5033 */
5034
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005035void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5036 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005037{
5038#if defined(MBEDTLS_SSL_PROTO_DTLS)
5039 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5040 {
5041 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005042#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005043 ssl->out_cid = ssl->out_ctr + 8;
5044 ssl->out_len = ssl->out_cid;
5045 if( transform != NULL )
5046 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005047#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005048 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005049#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005050 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005051 }
5052 else
5053#endif
5054 {
5055 ssl->out_ctr = ssl->out_hdr - 8;
5056 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005057#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005058 ssl->out_cid = ssl->out_len;
5059#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005060 ssl->out_iv = ssl->out_hdr + 5;
5061 }
5062
5063 /* Adjust out_msg to make space for explicit IV, if used. */
5064 if( transform != NULL &&
5065 ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
5066 {
5067 ssl->out_msg = ssl->out_iv + transform->ivlen - transform->fixed_ivlen;
5068 }
5069 else
5070 ssl->out_msg = ssl->out_iv;
5071}
5072
5073/* Once ssl->in_hdr as the address of the beginning of the
5074 * next incoming record is set, deduce the other pointers.
5075 *
5076 * Note: For TLS, we save the implicit record sequence number
5077 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5078 * and the caller has to make sure there's space for this.
5079 */
5080
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005081void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005082{
Hanno Becker79594fd2019-05-08 09:38:41 +01005083 /* This function sets the pointers to match the case
5084 * of unprotected TLS/DTLS records, with both ssl->in_iv
5085 * and ssl->in_msg pointing to the beginning of the record
5086 * content.
5087 *
5088 * When decrypting a protected record, ssl->in_msg
5089 * will be shifted to point to the beginning of the
5090 * record plaintext.
5091 */
5092
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005093#if defined(MBEDTLS_SSL_PROTO_DTLS)
5094 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5095 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005096 /* This sets the header pointers to match records
5097 * without CID. When we receive a record containing
5098 * a CID, the fields are shifted accordingly in
5099 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005100 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005101#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005102 ssl->in_cid = ssl->in_ctr + 8;
5103 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005104#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005105 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005106#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005107 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005108 }
5109 else
5110#endif
5111 {
5112 ssl->in_ctr = ssl->in_hdr - 8;
5113 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005114#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005115 ssl->in_cid = ssl->in_len;
5116#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005117 ssl->in_iv = ssl->in_hdr + 5;
5118 }
5119
Hanno Becker79594fd2019-05-08 09:38:41 +01005120 /* This will be adjusted at record decryption time. */
5121 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005122}
5123
Paul Bakker5121ce52009-01-03 21:22:43 +00005124/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005125 * Setup an SSL context
5126 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005127
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005128void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005129{
5130 /* Set the incoming and outgoing record pointers. */
5131#if defined(MBEDTLS_SSL_PROTO_DTLS)
5132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5133 {
5134 ssl->out_hdr = ssl->out_buf;
5135 ssl->in_hdr = ssl->in_buf;
5136 }
5137 else
5138#endif /* MBEDTLS_SSL_PROTO_DTLS */
5139 {
5140 ssl->out_hdr = ssl->out_buf + 8;
5141 ssl->in_hdr = ssl->in_buf + 8;
5142 }
5143
5144 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005145 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5146 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005147}
5148
Paul Bakker5121ce52009-01-03 21:22:43 +00005149/*
5150 * SSL get accessors
5151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005152size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005153{
5154 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5155}
5156
Hanno Becker8b170a02017-10-10 11:51:19 +01005157int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5158{
5159 /*
5160 * Case A: We're currently holding back
5161 * a message for further processing.
5162 */
5163
5164 if( ssl->keep_current_message == 1 )
5165 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005166 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005167 return( 1 );
5168 }
5169
5170 /*
5171 * Case B: Further records are pending in the current datagram.
5172 */
5173
5174#if defined(MBEDTLS_SSL_PROTO_DTLS)
5175 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5176 ssl->in_left > ssl->next_record_offset )
5177 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005178 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005179 return( 1 );
5180 }
5181#endif /* MBEDTLS_SSL_PROTO_DTLS */
5182
5183 /*
5184 * Case C: A handshake message is being processed.
5185 */
5186
Hanno Becker8b170a02017-10-10 11:51:19 +01005187 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5188 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005189 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005190 return( 1 );
5191 }
5192
5193 /*
5194 * Case D: An application data message is being processed
5195 */
5196 if( ssl->in_offt != NULL )
5197 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005198 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005199 return( 1 );
5200 }
5201
5202 /*
5203 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005204 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005205 * we implement support for multiple alerts in single records.
5206 */
5207
5208 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5209 return( 0 );
5210}
5211
Paul Bakker43ca69c2011-01-15 17:35:19 +00005212
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005213int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005214{
Hanno Becker3136ede2018-08-17 15:28:19 +01005215 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005216 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005217 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005218
Hanno Becker5903de42019-05-03 14:46:38 +01005219 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5220
Hanno Becker78640902018-08-13 16:35:15 +01005221 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005222 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005224#if defined(MBEDTLS_ZLIB_SUPPORT)
5225 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5226 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005227#endif
5228
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005230 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005231 case MBEDTLS_MODE_GCM:
5232 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005233 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005234 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005235 transform_expansion = transform->minlen;
5236 break;
5237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005238 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005239
5240 block_size = mbedtls_cipher_get_block_size(
5241 &transform->cipher_ctx_enc );
5242
Hanno Becker3136ede2018-08-17 15:28:19 +01005243 /* Expansion due to the addition of the MAC. */
5244 transform_expansion += transform->maclen;
5245
5246 /* Expansion due to the addition of CBC padding;
5247 * Theoretically up to 256 bytes, but we never use
5248 * more than the block size of the underlying cipher. */
5249 transform_expansion += block_size;
5250
5251 /* For TLS 1.1 or higher, an explicit IV is added
5252 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005253#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5254 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005255 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005256#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005257
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005258 break;
5259
5260 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005262 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005263 }
5264
Hanno Beckera0e20d02019-05-15 14:03:01 +01005265#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005266 if( transform->out_cid_len != 0 )
5267 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005268#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005269
Hanno Becker5903de42019-05-03 14:46:38 +01005270 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005271}
5272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005273#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005274/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005275 * Check record counters and renegotiate if they're above the limit.
5276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005277static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005278{
Hanno Beckerdd772292020-02-05 10:38:31 +00005279 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005280 int in_ctr_cmp;
5281 int out_ctr_cmp;
5282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005283 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5284 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005285 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005286 {
5287 return( 0 );
5288 }
5289
Andres AG2196c7f2016-12-15 17:01:16 +00005290 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5291 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005292 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005293 ssl->conf->renego_period + ep_len, 8 - ep_len );
5294
5295 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005296 {
5297 return( 0 );
5298 }
5299
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005301 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005302}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005303#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005304
5305/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005306 * Receive application data decrypted from the SSL layer
5307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005309{
Janos Follath865b3eb2019-12-16 11:46:15 +00005310 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005311 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005312
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005313 if( ssl == NULL || ssl->conf == NULL )
5314 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005319 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005320 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005322 return( ret );
5323
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005324 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005325 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005326 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005327 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005328 return( ret );
5329 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005330 }
5331#endif
5332
Hanno Becker4a810fb2017-05-24 16:27:30 +01005333 /*
5334 * Check if renegotiation is necessary and/or handshake is
5335 * in process. If yes, perform/continue, and fall through
5336 * if an unexpected packet is received while the client
5337 * is waiting for the ServerHello.
5338 *
5339 * (There is no equivalent to the last condition on
5340 * the server-side as it is not treated as within
5341 * a handshake while waiting for the ClientHello
5342 * after a renegotiation request.)
5343 */
5344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005346 ret = ssl_check_ctr_renegotiate( ssl );
5347 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5348 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005350 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005351 return( ret );
5352 }
5353#endif
5354
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005355 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005358 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5359 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005360 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005361 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005362 return( ret );
5363 }
5364 }
5365
Hanno Beckere41158b2017-10-23 13:30:32 +01005366 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005367 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005368 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005369 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005370 if( ssl->f_get_timer != NULL &&
5371 ssl->f_get_timer( ssl->p_timer ) == -1 )
5372 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005373 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005374 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005375
Hanno Becker327c93b2018-08-15 13:56:18 +01005376 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005377 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005378 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5379 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005380
Hanno Becker4a810fb2017-05-24 16:27:30 +01005381 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5382 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005383 }
5384
5385 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005387 {
5388 /*
5389 * OpenSSL sends empty messages to randomize the IV
5390 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005391 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005394 return( 0 );
5395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005396 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005397 return( ret );
5398 }
5399 }
5400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005401 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005402 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005403 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005404
Hanno Becker4a810fb2017-05-24 16:27:30 +01005405 /*
5406 * - For client-side, expect SERVER_HELLO_REQUEST.
5407 * - For server-side, expect CLIENT_HELLO.
5408 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5409 */
5410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005412 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005413 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005414 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005415 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005416 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005417
5418 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005419#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005420 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005421 {
5422 continue;
5423 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005424#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005425 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005426 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005427#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005428
Hanno Becker4a810fb2017-05-24 16:27:30 +01005429#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005430 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005432 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005433 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005434
5435 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005437 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005438 {
5439 continue;
5440 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005441#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005443 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005444#endif /* MBEDTLS_SSL_SRV_C */
5445
Hanno Becker21df7f92017-10-17 11:03:26 +01005446#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005447 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005448 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5449 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5450 ssl->conf->allow_legacy_renegotiation ==
5451 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5452 {
5453 /*
5454 * Accept renegotiation request
5455 */
Paul Bakker48916f92012-09-16 19:57:18 +00005456
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005457 /* DTLS clients need to know renego is server-initiated */
5458#if defined(MBEDTLS_SSL_PROTO_DTLS)
5459 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5460 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5461 {
5462 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5463 }
5464#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005465 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005466 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5467 ret != 0 )
5468 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005469 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5470 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005471 return( ret );
5472 }
5473 }
5474 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005475#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005476 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005477 /*
5478 * Refuse renegotiation
5479 */
5480
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005481 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005483#if defined(MBEDTLS_SSL_PROTO_SSL3)
5484 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005485 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005486 /* SSLv3 does not have a "no_renegotiation" warning, so
5487 we send a fatal alert and abort the connection. */
5488 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5489 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5490 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005491 }
5492 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005493#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5494#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5495 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5496 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005498 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5499 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5500 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005501 {
5502 return( ret );
5503 }
Paul Bakker48916f92012-09-16 19:57:18 +00005504 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005505 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005506#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5507 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005508 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5510 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005511 }
Paul Bakker48916f92012-09-16 19:57:18 +00005512 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005513
Hanno Becker90333da2017-10-10 11:27:13 +01005514 /* At this point, we don't know whether the renegotiation has been
5515 * completed or not. The cases to consider are the following:
5516 * 1) The renegotiation is complete. In this case, no new record
5517 * has been read yet.
5518 * 2) The renegotiation is incomplete because the client received
5519 * an application data record while awaiting the ServerHello.
5520 * 3) The renegotiation is incomplete because the client received
5521 * a non-handshake, non-application data message while awaiting
5522 * the ServerHello.
5523 * In each of these case, looping will be the proper action:
5524 * - For 1), the next iteration will read a new record and check
5525 * if it's application data.
5526 * - For 2), the loop condition isn't satisfied as application data
5527 * is present, hence continue is the same as break
5528 * - For 3), the loop condition is satisfied and read_record
5529 * will re-deliver the message that was held back by the client
5530 * when expecting the ServerHello.
5531 */
5532 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005533 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005534#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005535 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005536 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005537 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005538 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005539 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005540 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005542 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005543 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005544 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005545 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005546 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005548
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005549 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5550 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005551 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005552 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005553 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005554 }
5555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005556 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005557 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005558 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5559 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005560 }
5561
5562 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005563
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005564 /* We're going to return something now, cancel timer,
5565 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005566 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005567 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005568
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005570 /* If we requested renego but received AppData, resend HelloRequest.
5571 * Do it now, after setting in_offt, to avoid taking this branch
5572 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005573#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005574 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005575 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005576 {
Hanno Becker786300f2020-02-05 10:46:40 +00005577 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005578 {
Hanno Becker786300f2020-02-05 10:46:40 +00005579 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5580 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005581 return( ret );
5582 }
5583 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005584#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005585#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005586 }
5587
5588 n = ( len < ssl->in_msglen )
5589 ? len : ssl->in_msglen;
5590
5591 memcpy( buf, ssl->in_offt, n );
5592 ssl->in_msglen -= n;
5593
5594 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005595 {
5596 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005597 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005598 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005599 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005600 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005601 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005602 /* more data available */
5603 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005604 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005606 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005607
Paul Bakker23986e52011-04-24 08:57:21 +00005608 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005609}
5610
5611/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005612 * Send application data to be encrypted by the SSL layer, taking care of max
5613 * fragment length and buffer size.
5614 *
5615 * According to RFC 5246 Section 6.2.1:
5616 *
5617 * Zero-length fragments of Application data MAY be sent as they are
5618 * potentially useful as a traffic analysis countermeasure.
5619 *
5620 * Therefore, it is possible that the input message length is 0 and the
5621 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005622 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005623static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005624 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005625{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005626 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5627 const size_t max_len = (size_t) ret;
5628
5629 if( ret < 0 )
5630 {
5631 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5632 return( ret );
5633 }
5634
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005635 if( len > max_len )
5636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005637#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005638 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005639 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005641 "maximum fragment length: %d > %d",
5642 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005643 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005644 }
5645 else
5646#endif
5647 len = max_len;
5648 }
Paul Bakker887bd502011-06-08 13:10:54 +00005649
Paul Bakker5121ce52009-01-03 21:22:43 +00005650 if( ssl->out_left != 0 )
5651 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005652 /*
5653 * The user has previously tried to send the data and
5654 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5655 * written. In this case, we expect the high-level write function
5656 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5657 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005658 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005659 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005660 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005661 return( ret );
5662 }
5663 }
Paul Bakker887bd502011-06-08 13:10:54 +00005664 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005665 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005666 /*
5667 * The user is trying to send a message the first time, so we need to
5668 * copy the data into the internal buffers and setup the data structure
5669 * to keep track of partial writes
5670 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005671 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005672 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005673 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005674
Hanno Becker67bc7c32018-08-06 11:33:50 +01005675 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005676 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005678 return( ret );
5679 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005680 }
5681
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005682 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005683}
5684
5685/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005686 * Write application data, doing 1/n-1 splitting if necessary.
5687 *
5688 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005689 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005690 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005692#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005693static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005694 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005695{
Janos Follath865b3eb2019-12-16 11:46:15 +00005696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005697
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005698 if( ssl->conf->cbc_record_splitting ==
5699 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005700 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5702 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5703 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005704 {
5705 return( ssl_write_real( ssl, buf, len ) );
5706 }
5707
5708 if( ssl->split_done == 0 )
5709 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005710 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005711 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005712 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005713 }
5714
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005715 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5716 return( ret );
5717 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005718
5719 return( ret + 1 );
5720}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005721#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005722
5723/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005724 * Write application data (public-facing wrapper)
5725 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005726int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005727{
Janos Follath865b3eb2019-12-16 11:46:15 +00005728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005729
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005730 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005731
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005732 if( ssl == NULL || ssl->conf == NULL )
5733 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5734
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005735#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005736 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5737 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005738 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005739 return( ret );
5740 }
5741#endif
5742
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005743 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005744 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005745 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005746 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005747 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005748 return( ret );
5749 }
5750 }
5751
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005752#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005753 ret = ssl_write_split( ssl, buf, len );
5754#else
5755 ret = ssl_write_real( ssl, buf, len );
5756#endif
5757
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005758 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005759
5760 return( ret );
5761}
5762
5763/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005764 * Notify the peer that the connection is being closed
5765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005767{
Janos Follath865b3eb2019-12-16 11:46:15 +00005768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005769
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005770 if( ssl == NULL || ssl->conf == NULL )
5771 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005773 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005774
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005775 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005778 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005779 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5781 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5782 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005785 return( ret );
5786 }
5787 }
5788
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005790
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005791 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005792}
5793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005794void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005795{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005796 if( transform == NULL )
5797 return;
5798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005799#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005800 deflateEnd( &transform->ctx_deflate );
5801 inflateEnd( &transform->ctx_inflate );
5802#endif
5803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005804 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5805 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005806
Hanno Beckerd56ed242018-01-03 15:32:51 +00005807#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005808 mbedtls_md_free( &transform->md_ctx_enc );
5809 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005810#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005811
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005812 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005813}
5814
Hanno Becker0271f962018-08-16 13:23:47 +01005815#if defined(MBEDTLS_SSL_PROTO_DTLS)
5816
Hanno Becker533ab5f2020-02-05 10:49:13 +00005817void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005818{
5819 unsigned offset;
5820 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5821
5822 if( hs == NULL )
5823 return;
5824
Hanno Becker283f5ef2018-08-24 09:34:47 +01005825 ssl_free_buffered_record( ssl );
5826
Hanno Becker0271f962018-08-16 13:23:47 +01005827 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005828 ssl_buffering_free_slot( ssl, offset );
5829}
5830
5831static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5832 uint8_t slot )
5833{
5834 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5835 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005836
5837 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5838 return;
5839
Hanno Beckere605b192018-08-21 15:59:07 +01005840 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005841 {
Hanno Beckere605b192018-08-21 15:59:07 +01005842 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005843 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005844 mbedtls_free( hs_buf->data );
5845 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005846 }
5847}
5848
5849#endif /* MBEDTLS_SSL_PROTO_DTLS */
5850
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005851/*
5852 * Convert version numbers to/from wire format
5853 * and, for DTLS, to/from TLS equivalent.
5854 *
5855 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005856 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005857 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5858 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005860void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005861 unsigned char ver[2] )
5862{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005863#if defined(MBEDTLS_SSL_PROTO_DTLS)
5864 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005866 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005867 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5868
5869 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5870 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5871 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005872 else
5873#else
5874 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005875#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005876 {
5877 ver[0] = (unsigned char) major;
5878 ver[1] = (unsigned char) minor;
5879 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005880}
5881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005882void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005883 const unsigned char ver[2] )
5884{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005885#if defined(MBEDTLS_SSL_PROTO_DTLS)
5886 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005887 {
5888 *major = 255 - ver[0] + 2;
5889 *minor = 255 - ver[1] + 1;
5890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005891 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005892 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5893 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005894 else
5895#else
5896 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005897#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005898 {
5899 *major = ver[0];
5900 *minor = ver[1];
5901 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005902}
5903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005904#endif /* MBEDTLS_SSL_TLS_C */