blob: 1c56e538f344fa6a0e61c88d5474106bad9e3b83 [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 Becker17263802020-05-28 07:05:48 +0100539static int ssl_transform_aead_dynamic_iv_is_explicit(
540 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100541{
Hanno Becker17263802020-05-28 07:05:48 +0100542 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100543}
544
Hanno Beckerdf8be222020-05-21 15:30:57 +0100545
Hanno Becker17263802020-05-28 07:05:48 +0100546/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
547 *
548 * Concretely, this occurs in two variants:
549 *
550 * a) Fixed and dynamic IV lengths add up to total IV length, giving
551 * IV = fixed_iv || dynamic_iv
552 *
553 * b) Fixed IV lengths matches total IV length, giving
554 * IV = fixed_iv XOR ( 0 || dynamic_iv )
555 */
556static void ssl_build_record_nonce( unsigned char *dst_iv,
557 size_t dst_iv_len,
558 unsigned char const *fixed_iv,
559 size_t fixed_iv_len,
560 unsigned char const *dynamic_iv,
561 size_t dynamic_iv_len )
562{
563 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100564
565 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100566 memset( dst_iv, 0, dst_iv_len );
567 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100568
Hanno Becker17263802020-05-28 07:05:48 +0100569 dst_iv += dst_iv_len - dynamic_iv_len;
570 for( i = 0; i < dynamic_iv_len; i++ )
571 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100572}
573
Hanno Beckera18d1322018-01-03 14:27:32 +0000574int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
575 mbedtls_ssl_transform *transform,
576 mbedtls_record *rec,
577 int (*f_rng)(void *, unsigned char *, size_t),
578 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000579{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100581 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000582 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100583 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100584 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000585 size_t post_avail;
586
587 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000588#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200589 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000590 ((void) ssl);
591#endif
592
593 /* The PRNG is used for dynamic IV generation that's used
594 * for CBC transformations in TLS 1.1 and TLS 1.2. */
595#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
596 ( defined(MBEDTLS_AES_C) || \
597 defined(MBEDTLS_ARIA_C) || \
598 defined(MBEDTLS_CAMELLIA_C) ) && \
599 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
600 ((void) f_rng);
601 ((void) p_rng);
602#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000605
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000606 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100607 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
609 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
610 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100611 if( rec == NULL
612 || rec->buf == NULL
613 || rec->buf_len < rec->data_offset
614 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100615#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100616 || rec->cid_len != 0
617#endif
618 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000619 {
620 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100622 }
623
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000624 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100625 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000627 data, rec->data_len );
628
629 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
630
631 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
632 {
633 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
634 (unsigned) rec->data_len,
635 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
636 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
637 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100638
Hanno Becker92313402020-05-20 13:58:58 +0100639 /* The following two code paths implement the (D)TLSInnerPlaintext
640 * structure present in TLS 1.3 and DTLS 1.2 + CID.
641 *
642 * See ssl_build_inner_plaintext() for more information.
643 *
644 * Note that this changes `rec->data_len`, and hence
645 * `post_avail` needs to be recalculated afterwards.
646 *
647 * Note also that the two code paths cannot occur simultaneously
648 * since they apply to different versions of the protocol. There
649 * is hence no risk of double-addition of the inner plaintext.
650 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100651#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
652 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
653 {
Hanno Beckerccc13d02020-05-04 12:30:04 +0100654 if( ssl_build_inner_plaintext( data,
655 &rec->data_len,
656 post_avail,
657 rec->type ) != 0 )
658 {
659 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
660 }
661
662 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
663 }
664#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
665
Hanno Beckera0e20d02019-05-15 14:03:01 +0100666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100667 /*
668 * Add CID information
669 */
670 rec->cid_len = transform->out_cid_len;
671 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
672 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100673
674 if( rec->cid_len != 0 )
675 {
676 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100677 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100678 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100679 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100680 * Note that this changes `rec->data_len`, and hence
681 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100682 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100683 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100684 &rec->data_len,
685 post_avail,
686 rec->type ) != 0 )
687 {
688 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
689 }
690
691 rec->type = MBEDTLS_SSL_MSG_CID;
692 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100694
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100695 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
696
Paul Bakker5121ce52009-01-03 21:22:43 +0000697 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100698 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000699 */
Hanno Becker52344c22018-01-03 15:24:20 +0000700#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 if( mode == MBEDTLS_MODE_STREAM ||
702 ( mode == MBEDTLS_MODE_CBC
703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000704 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100705#endif
706 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000707 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000708 if( post_avail < transform->maclen )
709 {
710 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
711 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
712 }
713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000715 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200716 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000717 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000718 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
719 data, rec->data_len, rec->ctr, rec->type, mac );
720 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200721 }
722 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200723#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
725 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000726 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200727 {
Hanno Becker992b6872017-11-09 18:57:39 +0000728 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
729
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100730 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
731 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000732
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100734 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000735 mbedtls_md_hmac_update( &transform->md_ctx_enc,
736 data, rec->data_len );
737 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
738 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
739
740 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200741 }
742 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200743#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200744 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200747 }
748
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
750 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200751
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000752 rec->data_len += transform->maclen;
753 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100754 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200755 }
Hanno Becker52344c22018-01-03 15:24:20 +0000756#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000757
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200758 /*
759 * Encrypt
760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
762 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000763 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000765 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000767 "including %d bytes of padding",
768 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000769
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000770 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
771 transform->iv_enc, transform->ivlen,
772 data, rec->data_len,
773 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200776 return( ret );
777 }
778
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200780 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
782 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200783 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 }
Paul Bakker68884e32013-01-07 18:20:04 +0100785 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000787
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200788#if defined(MBEDTLS_GCM_C) || \
789 defined(MBEDTLS_CCM_C) || \
790 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200792 mode == MBEDTLS_MODE_CCM ||
793 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000794 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200796 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797 unsigned char *dynamic_iv;
798 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100799 int dynamic_iv_is_explicit =
800 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000801
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100802 /* Check that there's space for the authentication tag. */
803 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 {
805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
806 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
807 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000808
Paul Bakker68884e32013-01-07 18:20:04 +0100809 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100810 * Build nonce for AEAD encryption.
811 *
812 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
813 * part of the IV is prepended to the ciphertext and
814 * can be chosen freely - in particular, it need not
815 * agree with the record sequence number.
816 * However, since ChaChaPoly as well as all AEAD modes
817 * in TLS 1.3 use the record sequence number as the
818 * dynamic part of the nonce, we uniformly use the
819 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100820 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100821 dynamic_iv = rec->ctr;
822 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200823
Hanno Becker17263802020-05-28 07:05:48 +0100824 ssl_build_record_nonce( iv, sizeof( iv ),
825 transform->iv_enc,
826 transform->fixed_ivlen,
827 dynamic_iv,
828 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100829
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100830 /*
831 * Build additional data for AEAD encryption.
832 * This depends on the TLS version.
833 */
834 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
835 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100836
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200837 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
838 iv, transform->ivlen );
839 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Beckerdf8be222020-05-21 15:30:57 +0100840 data - dynamic_iv_len * dynamic_iv_is_explicit,
841 dynamic_iv_len * dynamic_iv_is_explicit );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100843 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200845 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000847
Paul Bakker68884e32013-01-07 18:20:04 +0100848 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200849 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200850 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000851
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200852 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100854 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000855 data, rec->data_len, /* source */
856 data, &rec->data_len, /* destination */
857 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200858 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200860 return( ret );
861 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000862 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
863 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100864 /* Account for authentication tag. */
865 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000866 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100867
868 /*
869 * Prefix record content with dynamic IV in case it is explicit.
870 */
Hanno Becker17263802020-05-28 07:05:48 +0100871 if( dynamic_iv_is_explicit )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872 {
873 if( rec->data_offset < dynamic_iv_len )
874 {
875 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
876 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
877 }
878
879 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
880 rec->data_offset -= dynamic_iv_len;
881 rec->data_len += dynamic_iv_len;
882 }
883
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100884 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000885 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000886 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
888#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000889 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 size_t padlen, i;
894 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 /* Currently we're always using minimal padding
897 * (up to 255 bytes would be allowed). */
898 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
899 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 padlen = 0;
901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 /* Check there's enough space in the buffer for the padding. */
903 if( post_avail < padlen + 1 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
906 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
907 }
908
Paul Bakker5121ce52009-01-03 21:22:43 +0000909 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 rec->data_len += padlen + 1;
913 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000916 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
918 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000919 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000920 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 if( f_rng == NULL )
923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
926 }
927
928 if( rec->data_offset < transform->ivlen )
929 {
930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
932 }
933
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 /*
935 * Generate IV
936 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000938 if( ret != 0 )
939 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 memcpy( data - transform->ivlen, transform->iv_enc,
942 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000948 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000949 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200950 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
953 transform->iv_enc,
954 transform->ivlen,
955 data, rec->data_len,
956 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200959 return( ret );
960 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200961
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000962 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
965 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200966 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200970 {
971 /*
972 * Save IV in SSL3 and TLS1
973 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000974 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
975 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000976 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000977 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200978#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000979 {
980 data -= transform->ivlen;
981 rec->data_offset -= transform->ivlen;
982 rec->data_len += transform->ivlen;
983 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100986 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100987 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000988 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
989
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100990 /*
991 * MAC(MAC_write_key, seq_num +
992 * TLSCipherText.type +
993 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100994 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100995 * IV + // except for TLS 1.0
996 * ENC(content + padding + padding_length));
997 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000998
999 if( post_avail < transform->maclen)
1000 {
1001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1002 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1003 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001004
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001005 ssl_extract_add_data_from_record( add_data, &add_data_len,
1006 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001009 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001010 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001011
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001013 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001014 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1015 data, rec->data_len );
1016 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1017 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001018
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001019 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001020
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001021 rec->data_len += transform->maclen;
1022 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001023 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001024 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001027 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001029 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1032 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001033 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001034
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001035 /* Make extra sure authentication was performed, exactly once */
1036 if( auth_done != 1 )
1037 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1039 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001040 }
1041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001043
1044 return( 0 );
1045}
1046
Hanno Becker605949f2019-07-12 08:23:59 +01001047int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001048 mbedtls_ssl_transform *transform,
1049 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001050{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001051 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001053 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001054#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001055 size_t padlen = 0, correct = 1;
1056#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001057 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001058 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001059 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001060
Hanno Beckera18d1322018-01-03 14:27:32 +00001061#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001062 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001063 ((void) ssl);
1064#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001067 if( rec == NULL ||
1068 rec->buf == NULL ||
1069 rec->buf_len < rec->data_offset ||
1070 rec->buf_len - rec->data_offset < rec->data_len )
1071 {
1072 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001074 }
1075
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001076 data = rec->buf + rec->data_offset;
1077 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001078
Hanno Beckera0e20d02019-05-15 14:03:01 +01001079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001080 /*
1081 * Match record's CID with incoming CID.
1082 */
Hanno Becker938489a2019-05-08 13:02:22 +01001083 if( rec->cid_len != transform->in_cid_len ||
1084 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1085 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001086 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001087 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001088#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001089
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1091 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001092 {
1093 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001094 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1095 transform->iv_dec,
1096 transform->ivlen,
1097 data, rec->data_len,
1098 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001099 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001101 return( ret );
1102 }
1103
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001104 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001105 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1107 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001108 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001109 }
Paul Bakker68884e32013-01-07 18:20:04 +01001110 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001112#if defined(MBEDTLS_GCM_C) || \
1113 defined(MBEDTLS_CCM_C) || \
1114 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001115 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001116 mode == MBEDTLS_MODE_CCM ||
1117 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001118 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001119 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001120 unsigned char *dynamic_iv;
1121 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001122
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001123 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001124 * Extract dynamic part of nonce for AEAD decryption.
1125 *
1126 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1127 * part of the IV is prepended to the ciphertext and
1128 * can be chosen freely - in particular, it need not
1129 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001130 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001131 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001132 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001133 {
1134 if( rec->data_len < dynamic_iv_len )
1135 {
1136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1137 rec->data_len,
1138 dynamic_iv_len ) );
1139 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1140 }
1141 dynamic_iv = data;
1142
1143 data += dynamic_iv_len;
1144 rec->data_offset += dynamic_iv_len;
1145 rec->data_len -= dynamic_iv_len;
1146 }
Hanno Becker17263802020-05-28 07:05:48 +01001147 else
1148 {
1149 dynamic_iv = rec->ctr;
1150 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001151
1152 /* Check that there's space for the authentication tag. */
1153 if( rec->data_len < transform->taglen )
1154 {
1155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001157 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001158 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001159
Hanno Beckerdf8be222020-05-21 15:30:57 +01001160 /*
1161 * Prepare nonce from dynamic and static parts.
1162 */
Hanno Becker17263802020-05-28 07:05:48 +01001163 ssl_build_record_nonce( iv, sizeof( iv ),
1164 transform->iv_dec,
1165 transform->fixed_ivlen,
1166 dynamic_iv,
1167 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001168
Hanno Beckerdf8be222020-05-21 15:30:57 +01001169 /*
1170 * Build additional data for AEAD encryption.
1171 * This depends on the TLS version.
1172 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001173 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1174 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001175 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001176 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001177
Hanno Beckerd96a6522019-07-10 13:55:25 +01001178 /* Because of the check above, we know that there are
1179 * explicit_iv_len Bytes preceeding data, and taglen
1180 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001181 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001182 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001183
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001184 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001185 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001186 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001187
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001188 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001189 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001190 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001191 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1192 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001193 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001194 data, rec->data_len,
1195 data, &olen,
1196 data + rec->data_len,
1197 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001198 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001200
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1202 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001203
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001204 return( ret );
1205 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001206 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001207
Hanno Beckerd96a6522019-07-10 13:55:25 +01001208 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001209 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001210 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1212 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001213 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001214 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001215 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1217#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001218 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001220 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001221 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001222
Paul Bakker5121ce52009-01-03 21:22:43 +00001223 /*
Paul Bakker45829992013-01-03 14:52:21 +01001224 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001227 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1228 {
1229 /* The ciphertext is prefixed with the CBC IV. */
1230 minlen += transform->ivlen;
1231 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001232#endif
Paul Bakker45829992013-01-03 14:52:21 +01001233
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001234 /* Size considerations:
1235 *
1236 * - The CBC cipher text must not be empty and hence
1237 * at least of size transform->ivlen.
1238 *
1239 * Together with the potential IV-prefix, this explains
1240 * the first of the two checks below.
1241 *
1242 * - The record must contain a MAC, either in plain or
1243 * encrypted, depending on whether Encrypt-then-MAC
1244 * is used or not.
1245 * - If it is, the message contains the IV-prefix,
1246 * the CBC ciphertext, and the MAC.
1247 * - If it is not, the padded plaintext, and hence
1248 * the CBC ciphertext, has at least length maclen + 1
1249 * because there is at least the padding length byte.
1250 *
1251 * As the CBC ciphertext is not empty, both cases give the
1252 * lower bound minlen + maclen + 1 on the record size, which
1253 * we test for in the second check below.
1254 */
1255 if( rec->data_len < minlen + transform->ivlen ||
1256 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001257 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001259 "+ 1 ) ( + expl IV )", rec->data_len,
1260 transform->ivlen,
1261 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001262 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001263 }
1264
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001265 /*
1266 * Authenticate before decrypt if enabled
1267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001269 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001270 {
Hanno Becker992b6872017-11-09 18:57:39 +00001271 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001274
Hanno Beckerd96a6522019-07-10 13:55:25 +01001275 /* Update data_len in tandem with add_data.
1276 *
1277 * The subtraction is safe because of the previous check
1278 * data_len >= minlen + maclen + 1.
1279 *
1280 * Afterwards, we know that data + data_len is followed by at
1281 * least maclen Bytes, which justifies the call to
1282 * mbedtls_ssl_safer_memcmp() below.
1283 *
1284 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001286 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1287 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001288
Hanno Beckerd96a6522019-07-10 13:55:25 +01001289 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001290 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1291 add_data_len );
1292 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1293 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1295 data, rec->data_len );
1296 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1297 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001298
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1300 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001301 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001302 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001303
Hanno Beckerd96a6522019-07-10 13:55:25 +01001304 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001305 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1306 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001310 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001311 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001312 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001314
1315 /*
1316 * Check length sanity
1317 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001318
1319 /* We know from above that data_len > minlen >= 0,
1320 * so the following check in particular implies that
1321 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001325 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001327 }
1328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001330 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001331 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001332 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001333 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001334 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001335 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001336 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001337
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001338 data += transform->ivlen;
1339 rec->data_offset += transform->ivlen;
1340 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001341 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001342#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001343
Hanno Beckerd96a6522019-07-10 13:55:25 +01001344 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1345
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001346 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1347 transform->iv_dec, transform->ivlen,
1348 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001349 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001351 return( ret );
1352 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001353
Hanno Beckerd96a6522019-07-10 13:55:25 +01001354 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001355 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1358 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001359 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001362 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001363 {
1364 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001365 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1366 * records is equivalent to CBC decryption of the concatenation
1367 * of the records; in other words, IVs are maintained across
1368 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001369 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001370 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1371 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001372 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001373#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001374
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001375 /* Safe since data_len >= minlen + maclen + 1, so after having
1376 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001377 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1378 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001379 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001380
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001381 if( auth_done == 1 )
1382 {
1383 correct *= ( rec->data_len >= padlen + 1 );
1384 padlen *= ( rec->data_len >= padlen + 1 );
1385 }
1386 else
Paul Bakker45829992013-01-03 14:52:21 +01001387 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001389 if( rec->data_len < transform->maclen + padlen + 1 )
1390 {
1391 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1392 rec->data_len,
1393 transform->maclen,
1394 padlen + 1 ) );
1395 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001396#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397
1398 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1399 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001400 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001401
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001402 padlen++;
1403
1404 /* Regardless of the validity of the padding,
1405 * we have data_len >= padlen here. */
1406
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001408 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001410 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001411 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412#if defined(MBEDTLS_SSL_DEBUG_ALL)
1413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001414 "should be no more than %d",
1415 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001416#endif
Paul Bakker45829992013-01-03 14:52:21 +01001417 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001418 }
1419 }
1420 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1422#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1423 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001424 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001425 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001426 /* The padding check involves a series of up to 256
1427 * consecutive memory reads at the end of the record
1428 * plaintext buffer. In order to hide the length and
1429 * validity of the padding, always perform exactly
1430 * `min(256,plaintext_len)` reads (but take into account
1431 * only the last `padlen` bytes for the padding check). */
1432 size_t pad_count = 0;
1433 size_t real_count = 0;
1434 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001435
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001436 /* Index of first padding byte; it has been ensured above
1437 * that the subtraction is safe. */
1438 size_t const padding_idx = rec->data_len - padlen;
1439 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1440 size_t const start_idx = rec->data_len - num_checks;
1441 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001442
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001443 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001444 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001445 real_count |= ( idx >= padding_idx );
1446 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001447 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001448 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001451 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001453#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001454 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001455 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001456 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1458 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001459 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1461 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001462 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001463
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001464 /* If the padding was found to be invalid, padlen == 0
1465 * and the subtraction is safe. If the padding was found valid,
1466 * padlen hasn't been changed and the previous assertion
1467 * data_len >= padlen still holds. */
1468 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001469 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001470 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001472 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001473 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1475 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001476 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001477
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001478#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001480 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001481#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001482
1483 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001484 * Authenticate if not done yet.
1485 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001486 */
Hanno Becker52344c22018-01-03 15:24:20 +00001487#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001488 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001489 {
Hanno Becker992b6872017-11-09 18:57:39 +00001490 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001491
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001492 /* If the initial value of padlen was such that
1493 * data_len < maclen + padlen + 1, then padlen
1494 * got reset to 1, and the initial check
1495 * data_len >= minlen + maclen + 1
1496 * guarantees that at this point we still
1497 * have at least data_len >= maclen.
1498 *
1499 * If the initial value of padlen was such that
1500 * data_len >= maclen + padlen + 1, then we have
1501 * subtracted either padlen + 1 (if the padding was correct)
1502 * or 0 (if the padding was incorrect) since then,
1503 * hence data_len >= maclen in any case.
1504 */
1505 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001506 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1507 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001510 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001511 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001512 ssl_mac( &transform->md_ctx_dec,
1513 transform->mac_dec,
1514 data, rec->data_len,
1515 rec->ctr, rec->type,
1516 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001517 }
1518 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1520#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1521 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001522 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001523 {
1524 /*
1525 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001526 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001527 *
1528 * Known timing attacks:
1529 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1530 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001531 * To compensate for different timings for the MAC calculation
1532 * depending on how much padding was removed (which is determined
1533 * by padlen), process extra_run more blocks through the hash
1534 * function.
1535 *
1536 * The formula in the paper is
1537 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1538 * where L1 is the size of the header plus the decrypted message
1539 * plus CBC padding and L2 is the size of the header plus the
1540 * decrypted message. This is for an underlying hash function
1541 * with 64-byte blocks.
1542 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1543 * correctly. We round down instead of up, so -56 is the correct
1544 * value for our calculations instead of -55.
1545 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001546 * Repeat the formula rather than defining a block_size variable.
1547 * This avoids requiring division by a variable at runtime
1548 * (which would be marginally less efficient and would require
1549 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001550 */
1551 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001552 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001553
1554 /*
1555 * The next two sizes are the minimum and maximum values of
1556 * in_msglen over all padlen values.
1557 *
1558 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001559 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001560 *
1561 * Note that max_len + maclen is never more than the buffer
1562 * length, as we previously did in_msglen -= maclen too.
1563 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001564 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001565 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1566
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001567 memset( tmp, 0, sizeof( tmp ) );
1568
1569 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001570 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001571#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1572 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001573 case MBEDTLS_MD_MD5:
1574 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001575 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001576 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001577 extra_run =
1578 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1579 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001580 break;
1581#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001582#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001583 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001584 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001585 extra_run =
1586 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1587 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001588 break;
1589#endif
1590 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001592 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1593 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001594
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001595 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001596
Hanno Beckercab87e62019-04-29 13:52:53 +01001597 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1598 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001599 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1600 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001601 /* Make sure we access everything even when padlen > 0. This
1602 * makes the synchronisation requirements for just-in-time
1603 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001604 ssl_read_memory( data + rec->data_len, padlen );
1605 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001606
1607 /* Call mbedtls_md_process at least once due to cache attacks
1608 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001609 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001610 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001611
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001613
1614 /* Make sure we access all the memory that could contain the MAC,
1615 * before we check it in the next code block. This makes the
1616 * synchronisation requirements for just-in-time Prime+Probe
1617 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618 ssl_read_memory( data + min_len,
1619 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001620 }
1621 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1623 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001624 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1626 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001627 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001628
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001629#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001630 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1631 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001632#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001633
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001634 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1635 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_DEBUG_ALL)
1638 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001639#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001640 correct = 0;
1641 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001642 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001643 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001644
1645 /*
1646 * Finally check the correct flag
1647 */
1648 if( correct == 0 )
1649 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001650#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001651
1652 /* Make extra sure authentication was performed, exactly once */
1653 if( auth_done != 1 )
1654 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001655 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1656 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001657 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001658
Hanno Beckerccc13d02020-05-04 12:30:04 +01001659#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1660 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1661 {
1662 /* Remove inner padding and infer true content type. */
1663 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1664 &rec->type );
1665
1666 if( ret != 0 )
1667 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1668 }
1669#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1670
Hanno Beckera0e20d02019-05-15 14:03:01 +01001671#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001672 if( rec->cid_len != 0 )
1673 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001674 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1675 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001676 if( ret != 0 )
1677 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1678 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001679#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001680
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001682
1683 return( 0 );
1684}
1685
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001686#undef MAC_NONE
1687#undef MAC_PLAINTEXT
1688#undef MAC_CIPHERTEXT
1689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001691/*
1692 * Compression/decompression functions
1693 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001695{
Janos Follath865b3eb2019-12-16 11:46:15 +00001696 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001697 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001698 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001699 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001700 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001701#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1702 size_t out_buf_len = ssl->out_buf_len;
1703#else
1704 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1705#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001708
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001709 if( len_pre == 0 )
1710 return( 0 );
1711
Paul Bakker2770fbd2012-07-03 13:30:23 +00001712 memcpy( msg_pre, ssl->out_msg, len_pre );
1713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001715 ssl->out_msglen ) );
1716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001718 ssl->out_msg, ssl->out_msglen );
1719
Paul Bakker48916f92012-09-16 19:57:18 +00001720 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1721 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1722 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001723 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001724
Paul Bakker48916f92012-09-16 19:57:18 +00001725 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001726 if( ret != Z_OK )
1727 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1729 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001730 }
1731
Darryl Greenb33cc762019-11-28 14:29:44 +00001732 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001733 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001734
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001736 ssl->out_msglen ) );
1737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001739 ssl->out_msg, ssl->out_msglen );
1740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001742
1743 return( 0 );
1744}
1745
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001747{
Janos Follath865b3eb2019-12-16 11:46:15 +00001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001749 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001750 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001751 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001752 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001753#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1754 size_t in_buf_len = ssl->in_buf_len;
1755#else
1756 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1757#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001760
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001761 if( len_pre == 0 )
1762 return( 0 );
1763
Paul Bakker2770fbd2012-07-03 13:30:23 +00001764 memcpy( msg_pre, ssl->in_msg, len_pre );
1765
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001767 ssl->in_msglen ) );
1768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001769 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001770 ssl->in_msg, ssl->in_msglen );
1771
Paul Bakker48916f92012-09-16 19:57:18 +00001772 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1773 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1774 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001775 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001776
Paul Bakker48916f92012-09-16 19:57:18 +00001777 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001778 if( ret != Z_OK )
1779 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1781 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001782 }
1783
Darryl Greenb33cc762019-11-28 14:29:44 +00001784 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001785 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001788 ssl->in_msglen ) );
1789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001791 ssl->in_msg, ssl->in_msglen );
1792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001794
1795 return( 0 );
1796}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798
Paul Bakker5121ce52009-01-03 21:22:43 +00001799/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001800 * Fill the input message buffer by appending data to it.
1801 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001802 *
1803 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1804 * available (from this read and/or a previous one). Otherwise, an error code
1805 * is returned (possibly EOF or WANT_READ).
1806 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001807 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1808 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1809 * since we always read a whole datagram at once.
1810 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001811 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001812 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001815{
Janos Follath865b3eb2019-12-16 11:46:15 +00001816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001817 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001818#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1819 size_t in_buf_len = ssl->in_buf_len;
1820#else
1821 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1822#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001823
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001825
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001826 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1827 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001829 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001831 }
1832
Darryl Greenb33cc762019-11-28 14:29:44 +00001833 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001834 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1836 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001837 }
1838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001840 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001841 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001842 uint32_t timeout;
1843
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001844 /* Just to be sure */
1845 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1846 {
1847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1848 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1849 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1850 }
1851
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001852 /*
1853 * The point is, we need to always read a full datagram at once, so we
1854 * sometimes read more then requested, and handle the additional data.
1855 * It could be the rest of the current record (while fetching the
1856 * header) and/or some other records in the same datagram.
1857 */
1858
1859 /*
1860 * Move to the next record in the already read datagram if applicable
1861 */
1862 if( ssl->next_record_offset != 0 )
1863 {
1864 if( ssl->in_left < ssl->next_record_offset )
1865 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1867 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001868 }
1869
1870 ssl->in_left -= ssl->next_record_offset;
1871
1872 if( ssl->in_left != 0 )
1873 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001875 ssl->next_record_offset ) );
1876 memmove( ssl->in_hdr,
1877 ssl->in_hdr + ssl->next_record_offset,
1878 ssl->in_left );
1879 }
1880
1881 ssl->next_record_offset = 0;
1882 }
1883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001885 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001886
1887 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001888 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001889 */
1890 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001891 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001893 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001894 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001895
1896 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001897 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898 * are not at the beginning of a new record, the caller did something
1899 * wrong.
1900 */
1901 if( ssl->in_left != 0 )
1902 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1904 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001905 }
1906
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001907 /*
1908 * Don't even try to read if time's out already.
1909 * This avoids by-passing the timer when repeatedly receiving messages
1910 * that will end up being dropped.
1911 */
Hanno Becker7876d122020-02-05 10:39:31 +00001912 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001913 {
1914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001915 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001916 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001917 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001918 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001919 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001922 timeout = ssl->handshake->retransmit_timeout;
1923 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001924 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001925
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001926 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001927
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001928 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001929 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1930 timeout );
1931 else
1932 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1933
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001935
1936 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001938 }
1939
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001940 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001941 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001943 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001946 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001947 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1948 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001950 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001951 }
1952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001954 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001956 return( ret );
1957 }
1958
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001959 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001960 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001962 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001964 {
Hanno Becker786300f2020-02-05 10:46:40 +00001965 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001966 {
Hanno Becker786300f2020-02-05 10:46:40 +00001967 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1968 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001969 return( ret );
1970 }
1971
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001972 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001973 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001975 }
1976
Paul Bakker5121ce52009-01-03 21:22:43 +00001977 if( ret < 0 )
1978 return( ret );
1979
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001980 ssl->in_left = ret;
1981 }
1982 else
1983#endif
1984 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001986 ssl->in_left, nb_want ) );
1987
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001988 while( ssl->in_left < nb_want )
1989 {
1990 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001991
Hanno Becker7876d122020-02-05 10:39:31 +00001992 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001993 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1994 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001995 {
1996 if( ssl->f_recv_timeout != NULL )
1997 {
1998 ret = ssl->f_recv_timeout( ssl->p_bio,
1999 ssl->in_hdr + ssl->in_left, len,
2000 ssl->conf->read_timeout );
2001 }
2002 else
2003 {
2004 ret = ssl->f_recv( ssl->p_bio,
2005 ssl->in_hdr + ssl->in_left, len );
2006 }
2007 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002008
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002010 ssl->in_left, nb_want ) );
2011 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002012
2013 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002015
2016 if( ret < 0 )
2017 return( ret );
2018
mohammad160352aecb92018-03-28 23:41:40 -07002019 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002020 {
Darryl Green11999bb2018-03-13 15:22:58 +00002021 MBEDTLS_SSL_DEBUG_MSG( 1,
2022 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002023 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002024 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2025 }
2026
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002027 ssl->in_left += ret;
2028 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002029 }
2030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002032
2033 return( 0 );
2034}
2035
2036/*
2037 * Flush any data not yet written
2038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002040{
Janos Follath865b3eb2019-12-16 11:46:15 +00002041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002042 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002045
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002046 if( ssl->f_send == NULL )
2047 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002049 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002051 }
2052
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002053 /* Avoid incrementing counter if data is flushed */
2054 if( ssl->out_left == 0 )
2055 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002057 return( 0 );
2058 }
2059
Paul Bakker5121ce52009-01-03 21:22:43 +00002060 while( ssl->out_left > 0 )
2061 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002063 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002064
Hanno Becker2b1e3542018-08-06 11:19:13 +01002065 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002066 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002069
2070 if( ret <= 0 )
2071 return( ret );
2072
mohammad160352aecb92018-03-28 23:41:40 -07002073 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002074 {
Darryl Green11999bb2018-03-13 15:22:58 +00002075 MBEDTLS_SSL_DEBUG_MSG( 1,
2076 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002077 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002078 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2079 }
2080
Paul Bakker5121ce52009-01-03 21:22:43 +00002081 ssl->out_left -= ret;
2082 }
2083
Hanno Becker2b1e3542018-08-06 11:19:13 +01002084#if defined(MBEDTLS_SSL_PROTO_DTLS)
2085 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002086 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002087 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002088 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002089 else
2090#endif
2091 {
2092 ssl->out_hdr = ssl->out_buf + 8;
2093 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002094 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
2098 return( 0 );
2099}
2100
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002101/*
2102 * Functions to handle the DTLS retransmission state machine
2103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002105/*
2106 * Append current handshake message to current outgoing flight
2107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002109{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2112 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2113 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002114
2115 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002116 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002117 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002118 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002120 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121 }
2122
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002123 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002124 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002125 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002127 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002128 }
2129
2130 /* Copy current handshake message with headers */
2131 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2132 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002133 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002134 msg->next = NULL;
2135
2136 /* Append to the current flight */
2137 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002138 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002139 else
2140 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002142 while( cur->next != NULL )
2143 cur = cur->next;
2144 cur->next = msg;
2145 }
2146
Hanno Becker3b235902018-08-06 09:54:53 +01002147 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148 return( 0 );
2149}
2150
2151/*
2152 * Free the current flight of handshake messages
2153 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002154void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002155{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 mbedtls_ssl_flight_item *cur = flight;
2157 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002158
2159 while( cur != NULL )
2160 {
2161 next = cur->next;
2162
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 mbedtls_free( cur->p );
2164 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165
2166 cur = next;
2167 }
2168}
2169
2170/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171 * Swap transform_out and out_ctr with the alternative ones
2172 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002173static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002174{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002176 unsigned char tmp_out_ctr[8];
2177
2178 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2179 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002181 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002182 }
2183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002185
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002186 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002187 tmp_transform = ssl->transform_out;
2188 ssl->transform_out = ssl->handshake->alt_transform_out;
2189 ssl->handshake->alt_transform_out = tmp_transform;
2190
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002191 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002192 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2193 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002194 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002195
2196 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002197 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2200 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002201 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002202 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2203 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002204 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2206 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002207 }
2208 }
2209#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002210
2211 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002212}
2213
2214/*
2215 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002216 */
2217int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2218{
2219 int ret = 0;
2220
2221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2222
2223 ret = mbedtls_ssl_flight_transmit( ssl );
2224
2225 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2226
2227 return( ret );
2228}
2229
2230/*
2231 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002232 *
2233 * Need to remember the current message in case flush_output returns
2234 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002235 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002236 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002237int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002238{
Janos Follath865b3eb2019-12-16 11:46:15 +00002239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002240 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002243 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002244 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002245
2246 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002247 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002248 ret = ssl_swap_epochs( ssl );
2249 if( ret != 0 )
2250 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002253 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254
2255 while( ssl->handshake->cur_msg != NULL )
2256 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002257 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002258 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002259
Hanno Beckere1dcb032018-08-17 16:47:58 +01002260 int const is_finished =
2261 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2262 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2263
Hanno Becker04da1892018-08-14 13:22:10 +01002264 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2265 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2266
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002267 /* Swap epochs before sending Finished: we can't do it after
2268 * sending ChangeCipherSpec, in case write returns WANT_READ.
2269 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002270 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002271 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002272 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002273 ret = ssl_swap_epochs( ssl );
2274 if( ret != 0 )
2275 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002276 }
2277
Hanno Becker67bc7c32018-08-06 11:33:50 +01002278 ret = ssl_get_remaining_payload_in_datagram( ssl );
2279 if( ret < 0 )
2280 return( ret );
2281 max_frag_len = (size_t) ret;
2282
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002283 /* CCS is copied as is, while HS messages may need fragmentation */
2284 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2285 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002286 if( max_frag_len == 0 )
2287 {
2288 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2289 return( ret );
2290
2291 continue;
2292 }
2293
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002294 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002295 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002296 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002297
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002298 /* Update position inside current message */
2299 ssl->handshake->cur_msg_p += cur->len;
2300 }
2301 else
2302 {
2303 const unsigned char * const p = ssl->handshake->cur_msg_p;
2304 const size_t hs_len = cur->len - 12;
2305 const size_t frag_off = p - ( cur->p + 12 );
2306 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002307 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002308
Hanno Beckere1dcb032018-08-17 16:47:58 +01002309 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002310 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002311 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002312 {
2313 ret = ssl_swap_epochs( ssl );
2314 if( ret != 0 )
2315 return( ret );
2316 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002317
Hanno Becker67bc7c32018-08-06 11:33:50 +01002318 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2319 return( ret );
2320
2321 continue;
2322 }
2323 max_hs_frag_len = max_frag_len - 12;
2324
2325 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2326 max_hs_frag_len : rem_len;
2327
2328 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002329 {
2330 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002331 (unsigned) cur_hs_frag_len,
2332 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002333 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002334
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002335 /* Messages are stored with handshake headers as if not fragmented,
2336 * copy beginning of headers then fill fragmentation fields.
2337 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2338 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002339
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002340 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2341 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2342 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2343
Hanno Becker67bc7c32018-08-06 11:33:50 +01002344 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2345 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2346 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002347
2348 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2349
Hanno Becker3f7b9732018-08-28 09:53:25 +01002350 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002351 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2352 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002353 ssl->out_msgtype = cur->type;
2354
2355 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002356 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002357 }
2358
2359 /* If done with the current message move to the next one if any */
2360 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2361 {
2362 if( cur->next != NULL )
2363 {
2364 ssl->handshake->cur_msg = cur->next;
2365 ssl->handshake->cur_msg_p = cur->next->p + 12;
2366 }
2367 else
2368 {
2369 ssl->handshake->cur_msg = NULL;
2370 ssl->handshake->cur_msg_p = NULL;
2371 }
2372 }
2373
2374 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002375 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002376 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002378 return( ret );
2379 }
2380 }
2381
Hanno Becker67bc7c32018-08-06 11:33:50 +01002382 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2383 return( ret );
2384
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002385 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2387 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002388 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002389 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002391 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002392 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002393
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002395
2396 return( 0 );
2397}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002398
2399/*
2400 * To be called when the last message of an incoming flight is received.
2401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002403{
2404 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002405 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002406 ssl->handshake->flight = NULL;
2407 ssl->handshake->cur_msg = NULL;
2408
2409 /* The next incoming flight will start with this msg_seq */
2410 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2411
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002412 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002413 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002414
Hanno Becker0271f962018-08-16 13:23:47 +01002415 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002416 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002417
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002418 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002419 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2422 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002425 }
2426 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002428}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002429
2430/*
2431 * To be called when the last message of an outgoing flight is send.
2432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002434{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002435 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002436 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2439 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002440 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002442 }
2443 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002445}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447
Paul Bakker5121ce52009-01-03 21:22:43 +00002448/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002449 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002450 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002451
2452/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002453 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002454 *
2455 * - fill in handshake headers
2456 * - update handshake checksum
2457 * - DTLS: save message for resending
2458 * - then pass to the record layer
2459 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002460 * DTLS: except for HelloRequest, messages are only queued, and will only be
2461 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002462 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002463 * Inputs:
2464 * - ssl->out_msglen: 4 + actual handshake message len
2465 * (4 is the size of handshake headers for TLS)
2466 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2467 * - ssl->out_msg + 4: the handshake message body
2468 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002469 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002470 * - ssl->out_msglen: the length of the record contents
2471 * (including handshake headers but excluding record headers)
2472 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002473 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002474int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002475{
Janos Follath865b3eb2019-12-16 11:46:15 +00002476 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002477 const size_t hs_len = ssl->out_msglen - 4;
2478 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002479
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2481
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002482 /*
2483 * Sanity checks
2484 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002485 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002486 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2487 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002488 /* In SSLv3, the client might send a NoCertificate alert. */
2489#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2490 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2491 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2492 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2493#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2494 {
2495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2496 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2497 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002498 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002499
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002500 /* Whenever we send anything different from a
2501 * HelloRequest we should be in a handshake - double check. */
2502 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2503 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002504 ssl->handshake == NULL )
2505 {
2506 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2507 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2508 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002511 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002512 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002514 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002515 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2516 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002517 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002519
Hanno Beckerb50a2532018-08-06 11:52:54 +01002520 /* Double-check that we did not exceed the bounds
2521 * of the outgoing record buffer.
2522 * This should never fail as the various message
2523 * writing functions must obey the bounds of the
2524 * outgoing record buffer, but better be safe.
2525 *
2526 * Note: We deliberately do not check for the MTU or MFL here.
2527 */
2528 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2529 {
2530 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2531 "size %u, maximum %u",
2532 (unsigned) ssl->out_msglen,
2533 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2534 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2535 }
2536
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002537 /*
2538 * Fill handshake headers
2539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002541 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002542 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2543 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2544 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002545
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002546 /*
2547 * DTLS has additional fields in the Handshake layer,
2548 * between the length field and the actual payload:
2549 * uint16 message_seq;
2550 * uint24 fragment_offset;
2551 * uint24 fragment_length;
2552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002554 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002555 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002556 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002557 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002558 {
2559 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2560 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002561 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002562 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002563 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2564 }
2565
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002566 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002567 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002568
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002569 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002570 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002571 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002572 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2573 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2574 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002575 }
2576 else
2577 {
2578 ssl->out_msg[4] = 0;
2579 ssl->out_msg[5] = 0;
2580 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002581
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002582 /* Handshake hashes are computed without fragmentation,
2583 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002584 memset( ssl->out_msg + 6, 0x00, 3 );
2585 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002586 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002588
Hanno Becker0207e532018-08-28 10:28:28 +01002589 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002590 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2591 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002592 }
2593
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002594 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002596 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002597 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2598 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002599 {
2600 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2601 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002603 return( ret );
2604 }
2605 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002606 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002607#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002608 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002609 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 {
2611 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2612 return( ret );
2613 }
2614 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002615
2616 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2617
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002618 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002619}
2620
2621/*
2622 * Record layer functions
2623 */
2624
2625/*
2626 * Write current record.
2627 *
2628 * Uses:
2629 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2630 * - ssl->out_msglen: length of the record content (excl headers)
2631 * - ssl->out_msg: record content
2632 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002633int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002634{
2635 int ret, done = 0;
2636 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002637 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002638
2639 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002642 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002644 {
2645 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2646 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002647 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002648 return( ret );
2649 }
2650
2651 len = ssl->out_msglen;
2652 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2656 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002657 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 ret = mbedtls_ssl_hw_record_write( ssl );
2661 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2664 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002665 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002666
2667 if( ret == 0 )
2668 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002669 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002671 if( !done )
2672 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002673 unsigned i;
2674 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002675#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2676 size_t out_buf_len = ssl->out_buf_len;
2677#else
2678 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2679#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002680 /* Skip writing the record content type to after the encryption,
2681 * as it may change when using the CID extension. */
2682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002684 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002685
Hanno Becker19859472018-08-06 09:40:20 +01002686 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002687 ssl->out_len[0] = (unsigned char)( len >> 8 );
2688 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002689
Paul Bakker48916f92012-09-16 19:57:18 +00002690 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002691 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002692 mbedtls_record rec;
2693
2694 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002695 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002696 rec.data_len = ssl->out_msglen;
2697 rec.data_offset = ssl->out_msg - rec.buf;
2698
2699 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2700 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2701 ssl->conf->transport, rec.ver );
2702 rec.type = ssl->out_msgtype;
2703
Hanno Beckera0e20d02019-05-15 14:03:01 +01002704#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002705 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002706 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002707#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002708
Hanno Beckera18d1322018-01-03 14:27:32 +00002709 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002710 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002711 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002713 return( ret );
2714 }
2715
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002716 if( rec.data_offset != 0 )
2717 {
2718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2719 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2720 }
2721
Hanno Becker6430faf2019-05-08 11:57:13 +01002722 /* Update the record content type and CID. */
2723 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002724#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002725 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002726#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002727 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002728 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2729 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002730 }
2731
Hanno Becker5903de42019-05-03 14:46:38 +01002732 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002733
2734#if defined(MBEDTLS_SSL_PROTO_DTLS)
2735 /* In case of DTLS, double-check that we don't exceed
2736 * the remaining space in the datagram. */
2737 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2738 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002739 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002740 if( ret < 0 )
2741 return( ret );
2742
2743 if( protected_record_size > (size_t) ret )
2744 {
2745 /* Should never happen */
2746 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2747 }
2748 }
2749#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002750
Hanno Becker6430faf2019-05-08 11:57:13 +01002751 /* Now write the potentially updated record content type. */
2752 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2753
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002755 "version = [%d:%d], msglen = %d",
2756 ssl->out_hdr[0], ssl->out_hdr[1],
2757 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002758
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002760 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002761
2762 ssl->out_left += protected_record_size;
2763 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002764 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002765
Hanno Beckerdd772292020-02-05 10:38:31 +00002766 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002767 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2768 break;
2769
2770 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002771 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002772 {
2773 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2774 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2775 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002776 }
2777
Hanno Becker67bc7c32018-08-06 11:33:50 +01002778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002779 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2780 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002781 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002782 size_t remaining;
2783 ret = ssl_get_remaining_payload_in_datagram( ssl );
2784 if( ret < 0 )
2785 {
2786 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2787 ret );
2788 return( ret );
2789 }
2790
2791 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002792 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002793 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002794 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002795 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002796 else
2797 {
Hanno Becker513815a2018-08-20 11:56:09 +01002798 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002799 }
2800 }
2801#endif /* MBEDTLS_SSL_PROTO_DTLS */
2802
2803 if( ( flush == SSL_FORCE_FLUSH ) &&
2804 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002805 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002807 return( ret );
2808 }
2809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002811
2812 return( 0 );
2813}
2814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002816
2817static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2818{
2819 if( ssl->in_msglen < ssl->in_hslen ||
2820 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2821 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2822 {
2823 return( 1 );
2824 }
2825 return( 0 );
2826}
Hanno Becker44650b72018-08-16 12:51:11 +01002827
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002828static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002829{
2830 return( ( ssl->in_msg[9] << 16 ) |
2831 ( ssl->in_msg[10] << 8 ) |
2832 ssl->in_msg[11] );
2833}
2834
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002835static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002836{
2837 return( ( ssl->in_msg[6] << 16 ) |
2838 ( ssl->in_msg[7] << 8 ) |
2839 ssl->in_msg[8] );
2840}
2841
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002842static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002843{
2844 uint32_t msg_len, frag_off, frag_len;
2845
2846 msg_len = ssl_get_hs_total_len( ssl );
2847 frag_off = ssl_get_hs_frag_off( ssl );
2848 frag_len = ssl_get_hs_frag_len( ssl );
2849
2850 if( frag_off > msg_len )
2851 return( -1 );
2852
2853 if( frag_len > msg_len - frag_off )
2854 return( -1 );
2855
2856 if( frag_len + 12 > ssl->in_msglen )
2857 return( -1 );
2858
2859 return( 0 );
2860}
2861
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002862/*
2863 * Mark bits in bitmask (used for DTLS HS reassembly)
2864 */
2865static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2866{
2867 unsigned int start_bits, end_bits;
2868
2869 start_bits = 8 - ( offset % 8 );
2870 if( start_bits != 8 )
2871 {
2872 size_t first_byte_idx = offset / 8;
2873
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002874 /* Special case */
2875 if( len <= start_bits )
2876 {
2877 for( ; len != 0; len-- )
2878 mask[first_byte_idx] |= 1 << ( start_bits - len );
2879
2880 /* Avoid potential issues with offset or len becoming invalid */
2881 return;
2882 }
2883
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002884 offset += start_bits; /* Now offset % 8 == 0 */
2885 len -= start_bits;
2886
2887 for( ; start_bits != 0; start_bits-- )
2888 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2889 }
2890
2891 end_bits = len % 8;
2892 if( end_bits != 0 )
2893 {
2894 size_t last_byte_idx = ( offset + len ) / 8;
2895
2896 len -= end_bits; /* Now len % 8 == 0 */
2897
2898 for( ; end_bits != 0; end_bits-- )
2899 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2900 }
2901
2902 memset( mask + offset / 8, 0xFF, len / 8 );
2903}
2904
2905/*
2906 * Check that bitmask is full
2907 */
2908static int ssl_bitmask_check( unsigned char *mask, size_t len )
2909{
2910 size_t i;
2911
2912 for( i = 0; i < len / 8; i++ )
2913 if( mask[i] != 0xFF )
2914 return( -1 );
2915
2916 for( i = 0; i < len % 8; i++ )
2917 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2918 return( -1 );
2919
2920 return( 0 );
2921}
2922
Hanno Becker56e205e2018-08-16 09:06:12 +01002923/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002924static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002925 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002926{
Hanno Becker56e205e2018-08-16 09:06:12 +01002927 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002928
Hanno Becker56e205e2018-08-16 09:06:12 +01002929 alloc_len = 12; /* Handshake header */
2930 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002931
Hanno Beckerd07df862018-08-16 09:14:58 +01002932 if( add_bitmap )
2933 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002934
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002935 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002936}
Hanno Becker56e205e2018-08-16 09:06:12 +01002937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002939
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002940static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002941{
2942 return( ( ssl->in_msg[1] << 16 ) |
2943 ( ssl->in_msg[2] << 8 ) |
2944 ssl->in_msg[3] );
2945}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002946
Simon Butcher99000142016-10-13 17:21:01 +01002947int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002948{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002950 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002952 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002954 }
2955
Hanno Becker12555c62018-08-16 12:47:53 +01002956 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002959 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002960 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002963 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002964 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002966 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002967
Hanno Becker44650b72018-08-16 12:51:11 +01002968 if( ssl_check_hs_header( ssl ) != 0 )
2969 {
2970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2971 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2972 }
2973
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002974 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002975 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2976 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2977 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2978 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002979 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002980 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2981 {
2982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2983 recv_msg_seq,
2984 ssl->handshake->in_msg_seq ) );
2985 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2986 }
2987
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002988 /* Retransmit only on last message from previous flight, to avoid
2989 * too many retransmissions.
2990 * Besides, No sane server ever retransmits HelloVerifyRequest */
2991 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002993 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002995 "message_seq = %d, start_of_flight = %d",
2996 recv_msg_seq,
2997 ssl->handshake->in_flight_start_seq ) );
2998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003002 return( ret );
3003 }
3004 }
3005 else
3006 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003008 "message_seq = %d, expected = %d",
3009 recv_msg_seq,
3010 ssl->handshake->in_msg_seq ) );
3011 }
3012
Hanno Becker90333da2017-10-10 11:27:13 +01003013 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003014 }
3015 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003016
Hanno Becker6d97ef52018-08-16 13:09:04 +01003017 /* Message reassembly is handled alongside buffering of future
3018 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003019 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003020 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003021 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003022 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003024 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003025 }
3026 }
3027 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003029 /* With TLS we don't handle fragmentation (for now) */
3030 if( ssl->in_msglen < ssl->in_hslen )
3031 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3033 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003034 }
3035
Simon Butcher99000142016-10-13 17:21:01 +01003036 return( 0 );
3037}
3038
3039void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3040{
Hanno Becker0271f962018-08-16 13:23:47 +01003041 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003042
Hanno Becker0271f962018-08-16 13:23:47 +01003043 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003044 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003045 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003046 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003047
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003048 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003050 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003051 ssl->handshake != NULL )
3052 {
Hanno Becker0271f962018-08-16 13:23:47 +01003053 unsigned offset;
3054 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003055
Hanno Becker0271f962018-08-16 13:23:47 +01003056 /* Increment handshake sequence number */
3057 hs->in_msg_seq++;
3058
3059 /*
3060 * Clear up handshake buffering and reassembly structure.
3061 */
3062
3063 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003064 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003065
3066 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003067 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3068 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003069 offset++, hs_buf++ )
3070 {
3071 *hs_buf = *(hs_buf + 1);
3072 }
3073
3074 /* Create a fresh last entry */
3075 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003076 }
3077#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003078}
3079
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003080/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003081 * DTLS anti-replay: RFC 6347 4.1.2.6
3082 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003083 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3084 * Bit n is set iff record number in_window_top - n has been seen.
3085 *
3086 * Usually, in_window_top is the last record number seen and the lsb of
3087 * in_window is set. The only exception is the initial state (record number 0
3088 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003091void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003092{
3093 ssl->in_window_top = 0;
3094 ssl->in_window = 0;
3095}
3096
3097static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3098{
3099 return( ( (uint64_t) buf[0] << 40 ) |
3100 ( (uint64_t) buf[1] << 32 ) |
3101 ( (uint64_t) buf[2] << 24 ) |
3102 ( (uint64_t) buf[3] << 16 ) |
3103 ( (uint64_t) buf[4] << 8 ) |
3104 ( (uint64_t) buf[5] ) );
3105}
3106
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003107static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3108{
Janos Follath865b3eb2019-12-16 11:46:15 +00003109 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003110 unsigned char *original_in_ctr;
3111
3112 // save original in_ctr
3113 original_in_ctr = ssl->in_ctr;
3114
3115 // use counter from record
3116 ssl->in_ctr = record_in_ctr;
3117
3118 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3119
3120 // restore the counter
3121 ssl->in_ctr = original_in_ctr;
3122
3123 return ret;
3124}
3125
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003126/*
3127 * Return 0 if sequence number is acceptable, -1 otherwise
3128 */
Hanno Becker0183d692019-07-12 08:50:37 +01003129int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003130{
3131 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3132 uint64_t bit;
3133
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003134 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003135 return( 0 );
3136
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003137 if( rec_seqnum > ssl->in_window_top )
3138 return( 0 );
3139
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003140 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003141
3142 if( bit >= 64 )
3143 return( -1 );
3144
3145 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3146 return( -1 );
3147
3148 return( 0 );
3149}
3150
3151/*
3152 * Update replay window on new validated record
3153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003155{
3156 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3157
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003158 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003159 return;
3160
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003161 if( rec_seqnum > ssl->in_window_top )
3162 {
3163 /* Update window_top and the contents of the window */
3164 uint64_t shift = rec_seqnum - ssl->in_window_top;
3165
3166 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003167 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003168 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003169 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003170 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003171 ssl->in_window |= 1;
3172 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003173
3174 ssl->in_window_top = rec_seqnum;
3175 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003176 else
3177 {
3178 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003179 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003180
3181 if( bit < 64 ) /* Always true, but be extra sure */
3182 ssl->in_window |= (uint64_t) 1 << bit;
3183 }
3184}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003186
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003187#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003188/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003189 * Without any SSL context, check if a datagram looks like a ClientHello with
3190 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003191 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003192 *
3193 * - if cookie is valid, return 0
3194 * - if ClientHello looks superficially valid but cookie is not,
3195 * fill obuf and set olen, then
3196 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3197 * - otherwise return a specific error code
3198 */
3199static int ssl_check_dtls_clihlo_cookie(
3200 mbedtls_ssl_cookie_write_t *f_cookie_write,
3201 mbedtls_ssl_cookie_check_t *f_cookie_check,
3202 void *p_cookie,
3203 const unsigned char *cli_id, size_t cli_id_len,
3204 const unsigned char *in, size_t in_len,
3205 unsigned char *obuf, size_t buf_len, size_t *olen )
3206{
3207 size_t sid_len, cookie_len;
3208 unsigned char *p;
3209
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003210 /*
3211 * Structure of ClientHello with record and handshake headers,
3212 * and expected values. We don't need to check a lot, more checks will be
3213 * done when actually parsing the ClientHello - skipping those checks
3214 * avoids code duplication and does not make cookie forging any easier.
3215 *
3216 * 0-0 ContentType type; copied, must be handshake
3217 * 1-2 ProtocolVersion version; copied
3218 * 3-4 uint16 epoch; copied, must be 0
3219 * 5-10 uint48 sequence_number; copied
3220 * 11-12 uint16 length; (ignored)
3221 *
3222 * 13-13 HandshakeType msg_type; (ignored)
3223 * 14-16 uint24 length; (ignored)
3224 * 17-18 uint16 message_seq; copied
3225 * 19-21 uint24 fragment_offset; copied, must be 0
3226 * 22-24 uint24 fragment_length; (ignored)
3227 *
3228 * 25-26 ProtocolVersion client_version; (ignored)
3229 * 27-58 Random random; (ignored)
3230 * 59-xx SessionID session_id; 1 byte len + sid_len content
3231 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3232 * ...
3233 *
3234 * Minimum length is 61 bytes.
3235 */
3236 if( in_len < 61 ||
3237 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3238 in[3] != 0 || in[4] != 0 ||
3239 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3240 {
3241 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3242 }
3243
3244 sid_len = in[59];
3245 if( sid_len > in_len - 61 )
3246 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3247
3248 cookie_len = in[60 + sid_len];
3249 if( cookie_len > in_len - 60 )
3250 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3251
3252 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3253 cli_id, cli_id_len ) == 0 )
3254 {
3255 /* Valid cookie */
3256 return( 0 );
3257 }
3258
3259 /*
3260 * If we get here, we've got an invalid cookie, let's prepare HVR.
3261 *
3262 * 0-0 ContentType type; copied
3263 * 1-2 ProtocolVersion version; copied
3264 * 3-4 uint16 epoch; copied
3265 * 5-10 uint48 sequence_number; copied
3266 * 11-12 uint16 length; olen - 13
3267 *
3268 * 13-13 HandshakeType msg_type; hello_verify_request
3269 * 14-16 uint24 length; olen - 25
3270 * 17-18 uint16 message_seq; copied
3271 * 19-21 uint24 fragment_offset; copied
3272 * 22-24 uint24 fragment_length; olen - 25
3273 *
3274 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3275 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3276 *
3277 * Minimum length is 28.
3278 */
3279 if( buf_len < 28 )
3280 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3281
3282 /* Copy most fields and adapt others */
3283 memcpy( obuf, in, 25 );
3284 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3285 obuf[25] = 0xfe;
3286 obuf[26] = 0xff;
3287
3288 /* Generate and write actual cookie */
3289 p = obuf + 28;
3290 if( f_cookie_write( p_cookie,
3291 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3292 {
3293 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3294 }
3295
3296 *olen = p - obuf;
3297
3298 /* Go back and fill length fields */
3299 obuf[27] = (unsigned char)( *olen - 28 );
3300
3301 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3302 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3303 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3304
3305 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3306 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3307
3308 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3309}
3310
3311/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003312 * Handle possible client reconnect with the same UDP quadruplet
3313 * (RFC 6347 Section 4.2.8).
3314 *
3315 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3316 * that looks like a ClientHello.
3317 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003318 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003319 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003320 * - if the input looks like a ClientHello with a valid cookie,
3321 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003322 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003323 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003324 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003325 * This function is called (through ssl_check_client_reconnect()) when an
3326 * unexpected record is found in ssl_get_next_record(), which will discard the
3327 * record if we return 0, and bubble up the return value otherwise (this
3328 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3329 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003330 */
3331static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3332{
Janos Follath865b3eb2019-12-16 11:46:15 +00003333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003334 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003335
Hanno Becker2fddd372019-07-10 14:37:41 +01003336 if( ssl->conf->f_cookie_write == NULL ||
3337 ssl->conf->f_cookie_check == NULL )
3338 {
3339 /* If we can't use cookies to verify reachability of the peer,
3340 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003341 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3342 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003343 return( 0 );
3344 }
3345
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003346 ret = ssl_check_dtls_clihlo_cookie(
3347 ssl->conf->f_cookie_write,
3348 ssl->conf->f_cookie_check,
3349 ssl->conf->p_cookie,
3350 ssl->cli_id, ssl->cli_id_len,
3351 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003352 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003353
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003354 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3355
3356 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003357 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003358 int send_ret;
3359 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3360 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3361 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003362 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003363 * If the error is permanent we'll catch it later,
3364 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003365 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3366 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3367 (void) send_ret;
3368
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003369 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003370 }
3371
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003372 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003373 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003374 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003375 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003376 {
3377 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3378 return( ret );
3379 }
3380
3381 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003382 }
3383
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003384 return( ret );
3385}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003386#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003387
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003388static int ssl_check_record_type( uint8_t record_type )
3389{
3390 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3391 record_type != MBEDTLS_SSL_MSG_ALERT &&
3392 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3393 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3394 {
3395 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3396 }
3397
3398 return( 0 );
3399}
3400
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003401/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003402 * ContentType type;
3403 * ProtocolVersion version;
3404 * uint16 epoch; // DTLS only
3405 * uint48 sequence_number; // DTLS only
3406 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003407 *
3408 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003409 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003410 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3411 *
3412 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003413 * 1. proceed with the record if this function returns 0
3414 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3415 * 3. return CLIENT_RECONNECT if this function return that value
3416 * 4. drop the whole datagram if this function returns anything else.
3417 * Point 2 is needed when the peer is resending, and we have already received
3418 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003419 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003420static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003421 unsigned char *buf,
3422 size_t len,
3423 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003424{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003425 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003426
Hanno Beckere5e7e782019-07-11 12:29:35 +01003427 size_t const rec_hdr_type_offset = 0;
3428 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003429
Hanno Beckere5e7e782019-07-11 12:29:35 +01003430 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3431 rec_hdr_type_len;
3432 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003433
Hanno Beckere5e7e782019-07-11 12:29:35 +01003434 size_t const rec_hdr_ctr_len = 8;
3435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003436 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003437 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3438 rec_hdr_version_len;
3439
Hanno Beckera0e20d02019-05-15 14:03:01 +01003440#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003441 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3442 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003443 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003444#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3445#endif /* MBEDTLS_SSL_PROTO_DTLS */
3446
3447 size_t rec_hdr_len_offset; /* To be determined */
3448 size_t const rec_hdr_len_len = 2;
3449
3450 /*
3451 * Check minimum lengths for record header.
3452 */
3453
3454#if defined(MBEDTLS_SSL_PROTO_DTLS)
3455 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3456 {
3457 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3458 }
3459 else
3460#endif /* MBEDTLS_SSL_PROTO_DTLS */
3461 {
3462 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3463 }
3464
3465 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3466 {
3467 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3468 (unsigned) len,
3469 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3470 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3471 }
3472
3473 /*
3474 * Parse and validate record content type
3475 */
3476
3477 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003478
3479 /* Check record content type */
3480#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3481 rec->cid_len = 0;
3482
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003483 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003484 ssl->conf->cid_len != 0 &&
3485 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003486 {
3487 /* Shift pointers to account for record header including CID
3488 * struct {
3489 * ContentType special_type = tls12_cid;
3490 * ProtocolVersion version;
3491 * uint16 epoch;
3492 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003493 * opaque cid[cid_length]; // Additional field compared to
3494 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003495 * uint16 length;
3496 * opaque enc_content[DTLSCiphertext.length];
3497 * } DTLSCiphertext;
3498 */
3499
3500 /* So far, we only support static CID lengths
3501 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003502 rec_hdr_cid_len = ssl->conf->cid_len;
3503 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003504
Hanno Beckere5e7e782019-07-11 12:29:35 +01003505 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003506 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003507 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3508 (unsigned) len,
3509 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003510 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003511 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003512
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003513 /* configured CID len is guaranteed at most 255, see
3514 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3515 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003516 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003517 }
3518 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003519#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003520 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 if( ssl_check_record_type( rec->type ) )
3522 {
Hanno Becker54229812019-07-12 14:40:00 +01003523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3524 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003525 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3526 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003527 }
3528
Hanno Beckere5e7e782019-07-11 12:29:35 +01003529 /*
3530 * Parse and validate record version
3531 */
3532
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003533 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3534 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003535 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3536 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003537 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003538
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003539 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003540 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3542 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003543 }
3544
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003545 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3548 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003549 }
3550
Hanno Beckere5e7e782019-07-11 12:29:35 +01003551 /*
3552 * Parse/Copy record sequence number.
3553 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003554
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555#if defined(MBEDTLS_SSL_PROTO_DTLS)
3556 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003557 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003558 /* Copy explicit record sequence number from input buffer. */
3559 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3560 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003561 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562 else
3563#endif /* MBEDTLS_SSL_PROTO_DTLS */
3564 {
3565 /* Copy implicit record sequence number from SSL context structure. */
3566 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3567 }
Paul Bakker40e46942009-01-03 21:51:57 +00003568
Hanno Beckere5e7e782019-07-11 12:29:35 +01003569 /*
3570 * Parse record length.
3571 */
3572
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003574 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3575 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003576 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003577
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003578 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003579 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580 rec->type,
3581 major_ver, minor_ver, rec->data_len ) );
3582
3583 rec->buf = buf;
3584 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003585
Hanno Beckerd417cc92019-07-26 08:20:27 +01003586 if( rec->data_len == 0 )
3587 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003588
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003589 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003590 * DTLS-related tests.
3591 * Check epoch before checking length constraint because
3592 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3593 * message gets duplicated before the corresponding Finished message,
3594 * the second ChangeCipherSpec should be discarded because it belongs
3595 * to an old epoch, but not because its length is shorter than
3596 * the minimum record length for packets using the new record transform.
3597 * Note that these two kinds of failures are handled differently,
3598 * as an unexpected record is silently skipped but an invalid
3599 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003600 */
3601#if defined(MBEDTLS_SSL_PROTO_DTLS)
3602 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3603 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003604 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003605
Hanno Becker955a5c92019-07-10 17:12:07 +01003606 /* Check that the datagram is large enough to contain a record
3607 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003608 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003609 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3611 (unsigned) len,
3612 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003613 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3614 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003615
Hanno Becker37cfe732019-07-10 17:20:01 +01003616 /* Records from other, non-matching epochs are silently discarded.
3617 * (The case of same-port Client reconnects must be considered in
3618 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003619 if( rec_epoch != ssl->in_epoch )
3620 {
3621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3622 "expected %d, received %d",
3623 ssl->in_epoch, rec_epoch ) );
3624
Hanno Becker552f7472019-07-19 10:59:12 +01003625 /* Records from the next epoch are considered for buffering
3626 * (concretely: early Finished messages). */
3627 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003628 {
Hanno Becker552f7472019-07-19 10:59:12 +01003629 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3630 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003631 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003632
Hanno Becker2fddd372019-07-10 14:37:41 +01003633 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003634 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003635#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003636 /* For records from the correct epoch, check whether their
3637 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003638 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3639 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003640 {
3641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3642 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3643 }
3644#endif
3645 }
3646#endif /* MBEDTLS_SSL_PROTO_DTLS */
3647
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003648 return( 0 );
3649}
Paul Bakker5121ce52009-01-03 21:22:43 +00003650
Paul Bakker5121ce52009-01-03 21:22:43 +00003651
Hanno Becker2fddd372019-07-10 14:37:41 +01003652#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3653static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3654{
3655 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3656
3657 /*
3658 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3659 * access the first byte of record content (handshake type), as we
3660 * have an active transform (possibly iv_len != 0), so use the
3661 * fact that the record header len is 13 instead.
3662 */
3663 if( rec_epoch == 0 &&
3664 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3665 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3666 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3667 ssl->in_left > 13 &&
3668 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3669 {
3670 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3671 "from the same port" ) );
3672 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003673 }
3674
3675 return( 0 );
3676}
Hanno Becker2fddd372019-07-10 14:37:41 +01003677#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003678
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003679/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003680 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003681 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003682static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3683 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003684{
3685 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003686
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003687 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003688 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003689
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003690#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3691 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003693 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003695 ret = mbedtls_ssl_hw_record_read( ssl );
3696 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003697 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003698 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3699 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003700 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003701
3702 if( ret == 0 )
3703 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003704 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003705#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003706 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003707 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003708 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003709
Hanno Beckera18d1322018-01-03 14:27:32 +00003710 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003711 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003712 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003713 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003714
Hanno Beckera0e20d02019-05-15 14:03:01 +01003715#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003716 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3717 ssl->conf->ignore_unexpected_cid
3718 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3719 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003720 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003721 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003722 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003723#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003724
Paul Bakker5121ce52009-01-03 21:22:43 +00003725 return( ret );
3726 }
3727
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003728 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003729 {
3730 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003731 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003732 }
3733
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003734 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003735 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003736
Hanno Beckera0e20d02019-05-15 14:03:01 +01003737#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003738 /* We have already checked the record content type
3739 * in ssl_parse_record_header(), failing or silently
3740 * dropping the record in the case of an unknown type.
3741 *
3742 * Since with the use of CIDs, the record content type
3743 * might change during decryption, re-check the record
3744 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003745 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003746 {
3747 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3748 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3749 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003750#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003751
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003752 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003753 {
3754#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3755 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003756 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003757 {
3758 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3760 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3761 }
3762#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3763
3764 ssl->nb_zero++;
3765
3766 /*
3767 * Three or more empty messages may be a DoS attack
3768 * (excessive CPU consumption).
3769 */
3770 if( ssl->nb_zero > 3 )
3771 {
3772 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003773 "messages, possible DoS attack" ) );
3774 /* Treat the records as if they were not properly authenticated,
3775 * thereby failing the connection if we see more than allowed
3776 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003777 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3778 }
3779 }
3780 else
3781 ssl->nb_zero = 0;
3782
3783#if defined(MBEDTLS_SSL_PROTO_DTLS)
3784 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3785 {
3786 ; /* in_ctr read from peer, not maintained internally */
3787 }
3788 else
3789#endif
3790 {
3791 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003792 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003793 if( ++ssl->in_ctr[i - 1] != 0 )
3794 break;
3795
3796 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003797 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003798 {
3799 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3800 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3801 }
3802 }
3803
Paul Bakker5121ce52009-01-03 21:22:43 +00003804 }
3805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003806#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003807 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003808 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003809 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003810 }
3811#endif
3812
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003813 /* Check actual (decrypted) record content length against
3814 * configured maximum. */
3815 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3816 {
3817 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3818 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3819 }
3820
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003821 return( 0 );
3822}
3823
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003824/*
3825 * Read a record.
3826 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003827 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3828 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3829 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003830 */
Hanno Becker1097b342018-08-15 14:09:41 +01003831
3832/* Helper functions for mbedtls_ssl_read_record(). */
3833static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003834static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3835static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003836
Hanno Becker327c93b2018-08-15 13:56:18 +01003837int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003838 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003839{
Janos Follath865b3eb2019-12-16 11:46:15 +00003840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003842 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003843
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003844 if( ssl->keep_current_message == 0 )
3845 {
3846 do {
Simon Butcher99000142016-10-13 17:21:01 +01003847
Hanno Becker26994592018-08-15 14:14:59 +01003848 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003849 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003850 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003851
Hanno Beckere74d5562018-08-15 14:26:08 +01003852 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003853 {
Hanno Becker40f50842018-08-15 14:48:01 +01003854#if defined(MBEDTLS_SSL_PROTO_DTLS)
3855 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003856
Hanno Becker40f50842018-08-15 14:48:01 +01003857 /* We only check for buffered messages if the
3858 * current datagram is fully consumed. */
3859 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003860 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003861 {
Hanno Becker40f50842018-08-15 14:48:01 +01003862 if( ssl_load_buffered_message( ssl ) == 0 )
3863 have_buffered = 1;
3864 }
3865
3866 if( have_buffered == 0 )
3867#endif /* MBEDTLS_SSL_PROTO_DTLS */
3868 {
3869 ret = ssl_get_next_record( ssl );
3870 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3871 continue;
3872
3873 if( ret != 0 )
3874 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003875 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003876 return( ret );
3877 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003878 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003879 }
3880
3881 ret = mbedtls_ssl_handle_message_type( ssl );
3882
Hanno Becker40f50842018-08-15 14:48:01 +01003883#if defined(MBEDTLS_SSL_PROTO_DTLS)
3884 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3885 {
3886 /* Buffer future message */
3887 ret = ssl_buffer_message( ssl );
3888 if( ret != 0 )
3889 return( ret );
3890
3891 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3892 }
3893#endif /* MBEDTLS_SSL_PROTO_DTLS */
3894
Hanno Becker90333da2017-10-10 11:27:13 +01003895 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3896 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003897
3898 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003899 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003900 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003901 return( ret );
3902 }
3903
Hanno Becker327c93b2018-08-15 13:56:18 +01003904 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003905 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003906 {
3907 mbedtls_ssl_update_handshake_status( ssl );
3908 }
Simon Butcher99000142016-10-13 17:21:01 +01003909 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003910 else
Simon Butcher99000142016-10-13 17:21:01 +01003911 {
Hanno Becker02f59072018-08-15 14:00:24 +01003912 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003913 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003914 }
3915
3916 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3917
3918 return( 0 );
3919}
3920
Hanno Becker40f50842018-08-15 14:48:01 +01003921#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003922static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003923{
Hanno Becker40f50842018-08-15 14:48:01 +01003924 if( ssl->in_left > ssl->next_record_offset )
3925 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003926
Hanno Becker40f50842018-08-15 14:48:01 +01003927 return( 0 );
3928}
3929
3930static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3931{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003932 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003933 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003934 int ret = 0;
3935
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003936 if( hs == NULL )
3937 return( -1 );
3938
Hanno Beckere00ae372018-08-20 09:39:42 +01003939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3940
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003941 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3942 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3943 {
3944 /* Check if we have seen a ChangeCipherSpec before.
3945 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003946 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003947 {
3948 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3949 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003950 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003951 }
3952
Hanno Becker39b8bc92018-08-28 17:17:13 +01003953 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003954 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3955 ssl->in_msglen = 1;
3956 ssl->in_msg[0] = 1;
3957
3958 /* As long as they are equal, the exact value doesn't matter. */
3959 ssl->in_left = 0;
3960 ssl->next_record_offset = 0;
3961
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003962 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003963 goto exit;
3964 }
Hanno Becker37f95322018-08-16 13:55:32 +01003965
Hanno Beckerb8f50142018-08-28 10:01:34 +01003966#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003967 /* Debug only */
3968 {
3969 unsigned offset;
3970 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3971 {
3972 hs_buf = &hs->buffering.hs[offset];
3973 if( hs_buf->is_valid == 1 )
3974 {
3975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3976 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003977 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003978 }
3979 }
3980 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003981#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003982
3983 /* Check if we have buffered and/or fully reassembled the
3984 * next handshake message. */
3985 hs_buf = &hs->buffering.hs[0];
3986 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3987 {
3988 /* Synthesize a record containing the buffered HS message. */
3989 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3990 ( hs_buf->data[2] << 8 ) |
3991 hs_buf->data[3];
3992
3993 /* Double-check that we haven't accidentally buffered
3994 * a message that doesn't fit into the input buffer. */
3995 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3996 {
3997 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3998 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3999 }
4000
4001 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4002 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4003 hs_buf->data, msg_len + 12 );
4004
4005 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4006 ssl->in_hslen = msg_len + 12;
4007 ssl->in_msglen = msg_len + 12;
4008 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4009
4010 ret = 0;
4011 goto exit;
4012 }
4013 else
4014 {
4015 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4016 hs->in_msg_seq ) );
4017 }
4018
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004019 ret = -1;
4020
4021exit:
4022
4023 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4024 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004025}
4026
Hanno Beckera02b0b42018-08-21 17:20:27 +01004027static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4028 size_t desired )
4029{
4030 int offset;
4031 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4033 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004034
Hanno Becker01315ea2018-08-21 17:22:17 +01004035 /* Get rid of future records epoch first, if such exist. */
4036 ssl_free_buffered_record( ssl );
4037
4038 /* Check if we have enough space available now. */
4039 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4040 hs->buffering.total_bytes_buffered ) )
4041 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004043 return( 0 );
4044 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004045
Hanno Becker4f432ad2018-08-28 10:02:32 +01004046 /* We don't have enough space to buffer the next expected handshake
4047 * message. Remove buffers used for future messages to gain space,
4048 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004049 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4050 offset >= 0; offset-- )
4051 {
4052 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4053 offset ) );
4054
Hanno Beckerb309b922018-08-23 13:18:05 +01004055 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004056
4057 /* Check if we have enough space available now. */
4058 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4059 hs->buffering.total_bytes_buffered ) )
4060 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004062 return( 0 );
4063 }
4064 }
4065
4066 return( -1 );
4067}
4068
Hanno Becker40f50842018-08-15 14:48:01 +01004069static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4070{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004071 int ret = 0;
4072 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4073
4074 if( hs == NULL )
4075 return( 0 );
4076
4077 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4078
4079 switch( ssl->in_msgtype )
4080 {
4081 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004083
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004084 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004085 break;
4086
4087 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004088 {
4089 unsigned recv_msg_seq_offset;
4090 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4091 mbedtls_ssl_hs_buffer *hs_buf;
4092 size_t msg_len = ssl->in_hslen - 12;
4093
4094 /* We should never receive an old handshake
4095 * message - double-check nonetheless. */
4096 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4097 {
4098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4099 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4100 }
4101
4102 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4103 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4104 {
4105 /* Silently ignore -- message too far in the future */
4106 MBEDTLS_SSL_DEBUG_MSG( 2,
4107 ( "Ignore future HS message with sequence number %u, "
4108 "buffering window %u - %u",
4109 recv_msg_seq, ssl->handshake->in_msg_seq,
4110 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4111
4112 goto exit;
4113 }
4114
4115 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4116 recv_msg_seq, recv_msg_seq_offset ) );
4117
4118 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4119
4120 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004121 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004122 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004123 size_t reassembly_buf_sz;
4124
Hanno Becker37f95322018-08-16 13:55:32 +01004125 hs_buf->is_fragmented =
4126 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4127
4128 /* We copy the message back into the input buffer
4129 * after reassembly, so check that it's not too large.
4130 * This is an implementation-specific limitation
4131 * and not one from the standard, hence it is not
4132 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004133 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004134 {
4135 /* Ignore message */
4136 goto exit;
4137 }
4138
Hanno Beckere0b150f2018-08-21 15:51:03 +01004139 /* Check if we have enough space to buffer the message. */
4140 if( hs->buffering.total_bytes_buffered >
4141 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4142 {
4143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4144 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4145 }
4146
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004147 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4148 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004149
4150 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4151 hs->buffering.total_bytes_buffered ) )
4152 {
4153 if( recv_msg_seq_offset > 0 )
4154 {
4155 /* If we can't buffer a future message because
4156 * of space limitations -- ignore. */
4157 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",
4158 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4159 (unsigned) hs->buffering.total_bytes_buffered ) );
4160 goto exit;
4161 }
Hanno Beckere1801392018-08-21 16:51:05 +01004162 else
4163 {
4164 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",
4165 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4166 (unsigned) hs->buffering.total_bytes_buffered ) );
4167 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004168
Hanno Beckera02b0b42018-08-21 17:20:27 +01004169 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004170 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004171 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",
4172 (unsigned) msg_len,
4173 (unsigned) reassembly_buf_sz,
4174 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004175 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004176 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4177 goto exit;
4178 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004179 }
4180
4181 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4182 msg_len ) );
4183
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004184 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4185 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004186 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004187 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004188 goto exit;
4189 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004190 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004191
4192 /* Prepare final header: copy msg_type, length and message_seq,
4193 * then add standardised fragment_offset and fragment_length */
4194 memcpy( hs_buf->data, ssl->in_msg, 6 );
4195 memset( hs_buf->data + 6, 0, 3 );
4196 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4197
4198 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004199
4200 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004201 }
4202 else
4203 {
4204 /* Make sure msg_type and length are consistent */
4205 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4206 {
4207 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4208 /* Ignore */
4209 goto exit;
4210 }
4211 }
4212
Hanno Becker4422bbb2018-08-20 09:40:19 +01004213 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004214 {
4215 size_t frag_len, frag_off;
4216 unsigned char * const msg = hs_buf->data + 12;
4217
4218 /*
4219 * Check and copy current fragment
4220 */
4221
4222 /* Validation of header fields already done in
4223 * mbedtls_ssl_prepare_handshake_record(). */
4224 frag_off = ssl_get_hs_frag_off( ssl );
4225 frag_len = ssl_get_hs_frag_len( ssl );
4226
4227 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4228 frag_off, frag_len ) );
4229 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4230
4231 if( hs_buf->is_fragmented )
4232 {
4233 unsigned char * const bitmask = msg + msg_len;
4234 ssl_bitmask_set( bitmask, frag_off, frag_len );
4235 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4236 msg_len ) == 0 );
4237 }
4238 else
4239 {
4240 hs_buf->is_complete = 1;
4241 }
4242
4243 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4244 hs_buf->is_complete ? "" : "not yet " ) );
4245 }
4246
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004247 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004248 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004249
4250 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004251 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004252 break;
4253 }
4254
4255exit:
4256
4257 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4258 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004259}
4260#endif /* MBEDTLS_SSL_PROTO_DTLS */
4261
Hanno Becker1097b342018-08-15 14:09:41 +01004262static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004263{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004264 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004265 * Consume last content-layer message and potentially
4266 * update in_msglen which keeps track of the contents'
4267 * consumption state.
4268 *
4269 * (1) Handshake messages:
4270 * Remove last handshake message, move content
4271 * and adapt in_msglen.
4272 *
4273 * (2) Alert messages:
4274 * Consume whole record content, in_msglen = 0.
4275 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004276 * (3) Change cipher spec:
4277 * Consume whole record content, in_msglen = 0.
4278 *
4279 * (4) Application data:
4280 * Don't do anything - the record layer provides
4281 * the application data as a stream transport
4282 * and consumes through mbedtls_ssl_read only.
4283 *
4284 */
4285
4286 /* Case (1): Handshake messages */
4287 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004288 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004289 /* Hard assertion to be sure that no application data
4290 * is in flight, as corrupting ssl->in_msglen during
4291 * ssl->in_offt != NULL is fatal. */
4292 if( ssl->in_offt != NULL )
4293 {
4294 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4295 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4296 }
4297
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004298 /*
4299 * Get next Handshake message in the current record
4300 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004301
Hanno Becker4a810fb2017-05-24 16:27:30 +01004302 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004303 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004304 * current handshake content: If DTLS handshake
4305 * fragmentation is used, that's the fragment
4306 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004307 * size here is faulty and should be changed at
4308 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004309 * (2) While it doesn't seem to cause problems, one
4310 * has to be very careful not to assume that in_hslen
4311 * is always <= in_msglen in a sensible communication.
4312 * Again, it's wrong for DTLS handshake fragmentation.
4313 * The following check is therefore mandatory, and
4314 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004315 * Additionally, ssl->in_hslen might be arbitrarily out of
4316 * bounds after handling a DTLS message with an unexpected
4317 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004318 */
4319 if( ssl->in_hslen < ssl->in_msglen )
4320 {
4321 ssl->in_msglen -= ssl->in_hslen;
4322 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4323 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004324
Hanno Becker4a810fb2017-05-24 16:27:30 +01004325 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4326 ssl->in_msg, ssl->in_msglen );
4327 }
4328 else
4329 {
4330 ssl->in_msglen = 0;
4331 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004332
Hanno Becker4a810fb2017-05-24 16:27:30 +01004333 ssl->in_hslen = 0;
4334 }
4335 /* Case (4): Application data */
4336 else if( ssl->in_offt != NULL )
4337 {
4338 return( 0 );
4339 }
4340 /* Everything else (CCS & Alerts) */
4341 else
4342 {
4343 ssl->in_msglen = 0;
4344 }
4345
Hanno Becker1097b342018-08-15 14:09:41 +01004346 return( 0 );
4347}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004348
Hanno Beckere74d5562018-08-15 14:26:08 +01004349static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4350{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004351 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004352 return( 1 );
4353
4354 return( 0 );
4355}
4356
Hanno Becker5f066e72018-08-16 14:56:31 +01004357#if defined(MBEDTLS_SSL_PROTO_DTLS)
4358
4359static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4360{
4361 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4362 if( hs == NULL )
4363 return;
4364
Hanno Becker01315ea2018-08-21 17:22:17 +01004365 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004366 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004367 hs->buffering.total_bytes_buffered -=
4368 hs->buffering.future_record.len;
4369
4370 mbedtls_free( hs->buffering.future_record.data );
4371 hs->buffering.future_record.data = NULL;
4372 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004373}
4374
4375static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4376{
4377 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4378 unsigned char * rec;
4379 size_t rec_len;
4380 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004381#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4382 size_t in_buf_len = ssl->in_buf_len;
4383#else
4384 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4385#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004386 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4387 return( 0 );
4388
4389 if( hs == NULL )
4390 return( 0 );
4391
Hanno Becker5f066e72018-08-16 14:56:31 +01004392 rec = hs->buffering.future_record.data;
4393 rec_len = hs->buffering.future_record.len;
4394 rec_epoch = hs->buffering.future_record.epoch;
4395
4396 if( rec == NULL )
4397 return( 0 );
4398
Hanno Becker4cb782d2018-08-20 11:19:05 +01004399 /* Only consider loading future records if the
4400 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004401 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004402 return( 0 );
4403
Hanno Becker5f066e72018-08-16 14:56:31 +01004404 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4405
4406 if( rec_epoch != ssl->in_epoch )
4407 {
4408 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4409 goto exit;
4410 }
4411
4412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4413
4414 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004415 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004416 {
4417 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4418 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4419 }
4420
4421 memcpy( ssl->in_hdr, rec, rec_len );
4422 ssl->in_left = rec_len;
4423 ssl->next_record_offset = 0;
4424
4425 ssl_free_buffered_record( ssl );
4426
4427exit:
4428 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4429 return( 0 );
4430}
4431
Hanno Becker519f15d2019-07-11 12:43:20 +01004432static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4433 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004434{
4435 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004436
4437 /* Don't buffer future records outside handshakes. */
4438 if( hs == NULL )
4439 return( 0 );
4440
4441 /* Only buffer handshake records (we are only interested
4442 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004443 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004444 return( 0 );
4445
4446 /* Don't buffer more than one future epoch record. */
4447 if( hs->buffering.future_record.data != NULL )
4448 return( 0 );
4449
Hanno Becker01315ea2018-08-21 17:22:17 +01004450 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004451 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004452 hs->buffering.total_bytes_buffered ) )
4453 {
4454 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 +01004455 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004456 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004457 return( 0 );
4458 }
4459
Hanno Becker5f066e72018-08-16 14:56:31 +01004460 /* Buffer record */
4461 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4462 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004463 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004464
4465 /* ssl_parse_record_header() only considers records
4466 * of the next epoch as candidates for buffering. */
4467 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004468 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004469
4470 hs->buffering.future_record.data =
4471 mbedtls_calloc( 1, hs->buffering.future_record.len );
4472 if( hs->buffering.future_record.data == NULL )
4473 {
4474 /* If we run out of RAM trying to buffer a
4475 * record from the next epoch, just ignore. */
4476 return( 0 );
4477 }
4478
Hanno Becker519f15d2019-07-11 12:43:20 +01004479 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004480
Hanno Becker519f15d2019-07-11 12:43:20 +01004481 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004482 return( 0 );
4483}
4484
4485#endif /* MBEDTLS_SSL_PROTO_DTLS */
4486
Hanno Beckere74d5562018-08-15 14:26:08 +01004487static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004488{
Janos Follath865b3eb2019-12-16 11:46:15 +00004489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004490 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004491
Hanno Becker5f066e72018-08-16 14:56:31 +01004492#if defined(MBEDTLS_SSL_PROTO_DTLS)
4493 /* We might have buffered a future record; if so,
4494 * and if the epoch matches now, load it.
4495 * On success, this call will set ssl->in_left to
4496 * the length of the buffered record, so that
4497 * the calls to ssl_fetch_input() below will
4498 * essentially be no-ops. */
4499 ret = ssl_load_buffered_record( ssl );
4500 if( ret != 0 )
4501 return( ret );
4502#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004503
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004504 /* Ensure that we have enough space available for the default form
4505 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4506 * with no space for CIDs counted in). */
4507 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4508 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004509 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004510 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004511 return( ret );
4512 }
4513
Hanno Beckere5e7e782019-07-11 12:29:35 +01004514 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4515 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004516 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004517#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004518 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004519 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004520 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4521 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004522 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004523 if( ret != 0 )
4524 return( ret );
4525
4526 /* Fall through to handling of unexpected records */
4527 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4528 }
4529
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004530 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4531 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004532#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004533 /* Reset in pointers to default state for TLS/DTLS records,
4534 * assuming no CID and no offset between record content and
4535 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004536 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004537
Hanno Becker7ae20e02019-07-12 08:33:49 +01004538 /* Setup internal message pointers from record structure. */
4539 ssl->in_msgtype = rec.type;
4540#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4541 ssl->in_len = ssl->in_cid + rec.cid_len;
4542#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4543 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4544 ssl->in_msglen = rec.data_len;
4545
Hanno Becker2fddd372019-07-10 14:37:41 +01004546 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004547 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004548 if( ret != 0 )
4549 return( ret );
4550#endif
4551
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004552 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004553 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004554
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4556 "(header)" ) );
4557 }
4558 else
4559 {
4560 /* Skip invalid record and the rest of the datagram */
4561 ssl->next_record_offset = 0;
4562 ssl->in_left = 0;
4563
4564 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4565 "(header)" ) );
4566 }
4567
4568 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004569 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004570 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004571 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004572#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004573 {
4574 return( ret );
4575 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004576 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004579 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004580 {
Hanno Beckera8814792019-07-10 15:01:45 +01004581 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004582 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004583 if( ssl->next_record_offset < ssl->in_left )
4584 {
4585 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4586 }
4587 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004588 else
4589#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004590 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004591 /*
4592 * Fetch record contents from underlying transport.
4593 */
Hanno Beckera3175662019-07-11 12:50:29 +01004594 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004595 if( ret != 0 )
4596 {
4597 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4598 return( ret );
4599 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004600
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004601 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004602 }
4603
4604 /*
4605 * Decrypt record contents.
4606 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004607
Hanno Beckerfdf66042019-07-11 13:07:45 +01004608 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004609 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004610#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004611 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004612 {
4613 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004614 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004615 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004616 /* Except when waiting for Finished as a bad mac here
4617 * probably means something went wrong in the handshake
4618 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4619 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4620 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4621 {
4622#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4623 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4624 {
4625 mbedtls_ssl_send_alert_message( ssl,
4626 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4627 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4628 }
4629#endif
4630 return( ret );
4631 }
4632
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004634 if( ssl->conf->badmac_limit != 0 &&
4635 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004636 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4638 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004639 }
4640#endif
4641
Hanno Becker4a810fb2017-05-24 16:27:30 +01004642 /* As above, invalid records cause
4643 * dismissal of the whole datagram. */
4644
4645 ssl->next_record_offset = 0;
4646 ssl->in_left = 0;
4647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004649 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004650 }
4651
4652 return( ret );
4653 }
4654 else
4655#endif
4656 {
4657 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4659 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004660 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 mbedtls_ssl_send_alert_message( ssl,
4662 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4663 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004664 }
4665#endif
4666 return( ret );
4667 }
4668 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004669
Hanno Becker44d89b22019-07-12 09:40:44 +01004670
4671 /* Reset in pointers to default state for TLS/DTLS records,
4672 * assuming no CID and no offset between record content and
4673 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004674 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004675#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4676 ssl->in_len = ssl->in_cid + rec.cid_len;
4677#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004678 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004679
Hanno Becker8685c822019-07-12 09:37:30 +01004680 /* The record content type may change during decryption,
4681 * so re-read it. */
4682 ssl->in_msgtype = rec.type;
4683 /* Also update the input buffer, because unfortunately
4684 * the server-side ssl_parse_client_hello() reparses the
4685 * record header when receiving a ClientHello initiating
4686 * a renegotiation. */
4687 ssl->in_hdr[0] = rec.type;
4688 ssl->in_msg = rec.buf + rec.data_offset;
4689 ssl->in_msglen = rec.data_len;
4690 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4691 ssl->in_len[1] = (unsigned char)( rec.data_len );
4692
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004693#if defined(MBEDTLS_ZLIB_SUPPORT)
4694 if( ssl->transform_in != NULL &&
4695 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4696 {
4697 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4698 {
4699 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4700 return( ret );
4701 }
4702
4703 /* Check actual (decompress) record content length against
4704 * configured maximum. */
4705 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4706 {
4707 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4708 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4709 }
4710 }
4711#endif /* MBEDTLS_ZLIB_SUPPORT */
4712
Simon Butcher99000142016-10-13 17:21:01 +01004713 return( 0 );
4714}
4715
4716int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4717{
Janos Follath865b3eb2019-12-16 11:46:15 +00004718 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004719
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004720 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004721 * Handle particular types of records
4722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004724 {
Simon Butcher99000142016-10-13 17:21:01 +01004725 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4726 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004727 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004728 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004729 }
4730
Hanno Beckere678eaa2018-08-21 14:57:46 +01004731 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004732 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004733 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004734 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4736 ssl->in_msglen ) );
4737 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004738 }
4739
Hanno Beckere678eaa2018-08-21 14:57:46 +01004740 if( ssl->in_msg[0] != 1 )
4741 {
4742 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4743 ssl->in_msg[0] ) );
4744 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4745 }
4746
4747#if defined(MBEDTLS_SSL_PROTO_DTLS)
4748 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4749 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4750 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4751 {
4752 if( ssl->handshake == NULL )
4753 {
4754 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4755 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4756 }
4757
4758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4759 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4760 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004761#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004762 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004765 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004766 if( ssl->in_msglen != 2 )
4767 {
4768 /* Note: Standard allows for more than one 2 byte alert
4769 to be packed in a single message, but Mbed TLS doesn't
4770 currently support this. */
4771 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4772 ssl->in_msglen ) );
4773 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4774 }
4775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004777 ssl->in_msg[0], ssl->in_msg[1] ) );
4778
4779 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004780 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004782 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004783 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004785 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004786 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004787 }
4788
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4790 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004791 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004792 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4793 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004794 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004795
4796#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4797 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4798 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4799 {
Hanno Becker90333da2017-10-10 11:27:13 +01004800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004801 /* Will be handled when trying to parse ServerHello */
4802 return( 0 );
4803 }
4804#endif
4805
4806#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4807 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4808 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4809 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4810 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4811 {
4812 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4813 /* Will be handled in mbedtls_ssl_parse_certificate() */
4814 return( 0 );
4815 }
4816#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4817
4818 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004819 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004820 }
4821
Hanno Beckerc76c6192017-06-06 10:03:17 +01004822#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004823 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004824 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004825 /* Drop unexpected ApplicationData records,
4826 * except at the beginning of renegotiations */
4827 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4828 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4829#if defined(MBEDTLS_SSL_RENEGOTIATION)
4830 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4831 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004832#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004833 )
4834 {
4835 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4836 return( MBEDTLS_ERR_SSL_NON_FATAL );
4837 }
4838
4839 if( ssl->handshake != NULL &&
4840 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4841 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004842 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004843 }
4844 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004845#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004846
Paul Bakker5121ce52009-01-03 21:22:43 +00004847 return( 0 );
4848}
4849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004850int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004851{
irwir6c0da642019-09-26 21:07:41 +03004852 return( mbedtls_ssl_send_alert_message( ssl,
4853 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4854 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004855}
4856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004857int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004858 unsigned char level,
4859 unsigned char message )
4860{
Janos Follath865b3eb2019-12-16 11:46:15 +00004861 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004862
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004863 if( ssl == NULL || ssl->conf == NULL )
4864 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004867 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004870 ssl->out_msglen = 2;
4871 ssl->out_msg[0] = level;
4872 ssl->out_msg[1] = message;
4873
Hanno Becker67bc7c32018-08-06 11:33:50 +01004874 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004875 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004876 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004877 return( ret );
4878 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004879 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004880
4881 return( 0 );
4882}
4883
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004884int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004885{
Janos Follath865b3eb2019-12-16 11:46:15 +00004886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004889
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004890 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004891 ssl->out_msglen = 1;
4892 ssl->out_msg[0] = 1;
4893
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 ssl->state++;
4895
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004896 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004897 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004898 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004899 return( ret );
4900 }
4901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004903
4904 return( 0 );
4905}
4906
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004908{
Janos Follath865b3eb2019-12-16 11:46:15 +00004909 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004910
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004911 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004912
Hanno Becker327c93b2018-08-15 13:56:18 +01004913 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004915 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004916 return( ret );
4917 }
4918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004919 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004920 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004921 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004922 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4923 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004925 }
4926
Hanno Beckere678eaa2018-08-21 14:57:46 +01004927 /* CCS records are only accepted if they have length 1 and content '1',
4928 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004929
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004930 /*
4931 * Switch to our negotiated transform and session parameters for inbound
4932 * data.
4933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004934 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004935 ssl->transform_in = ssl->transform_negotiate;
4936 ssl->session_in = ssl->session_negotiate;
4937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004938#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004940 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004941#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004942 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004943#endif
4944
4945 /* Increment epoch */
4946 if( ++ssl->in_epoch == 0 )
4947 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004948 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004949 /* This is highly unlikely to happen for legitimate reasons, so
4950 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004951 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004952 }
4953 }
4954 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004955#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004956 memset( ssl->in_ctr, 0, 8 );
4957
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004958 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004960#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4961 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004962 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004963 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004964 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004965 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004966 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4967 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004968 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004969 }
4970 }
4971#endif
4972
Paul Bakker5121ce52009-01-03 21:22:43 +00004973 ssl->state++;
4974
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004975 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004976
4977 return( 0 );
4978}
4979
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004980/* Once ssl->out_hdr as the address of the beginning of the
4981 * next outgoing record is set, deduce the other pointers.
4982 *
4983 * Note: For TLS, we save the implicit record sequence number
4984 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4985 * and the caller has to make sure there's space for this.
4986 */
4987
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004988void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4989 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004990{
4991#if defined(MBEDTLS_SSL_PROTO_DTLS)
4992 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4993 {
4994 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004995#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004996 ssl->out_cid = ssl->out_ctr + 8;
4997 ssl->out_len = ssl->out_cid;
4998 if( transform != NULL )
4999 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005000#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005001 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005002#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005003 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005004 }
5005 else
5006#endif
5007 {
5008 ssl->out_ctr = ssl->out_hdr - 8;
5009 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005010#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005011 ssl->out_cid = ssl->out_len;
5012#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005013 ssl->out_iv = ssl->out_hdr + 5;
5014 }
5015
5016 /* Adjust out_msg to make space for explicit IV, if used. */
5017 if( transform != NULL &&
5018 ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
5019 {
5020 ssl->out_msg = ssl->out_iv + transform->ivlen - transform->fixed_ivlen;
5021 }
5022 else
5023 ssl->out_msg = ssl->out_iv;
5024}
5025
5026/* Once ssl->in_hdr as the address of the beginning of the
5027 * next incoming record is set, deduce the other pointers.
5028 *
5029 * Note: For TLS, we save the implicit record sequence number
5030 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5031 * and the caller has to make sure there's space for this.
5032 */
5033
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005034void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005035{
Hanno Becker79594fd2019-05-08 09:38:41 +01005036 /* This function sets the pointers to match the case
5037 * of unprotected TLS/DTLS records, with both ssl->in_iv
5038 * and ssl->in_msg pointing to the beginning of the record
5039 * content.
5040 *
5041 * When decrypting a protected record, ssl->in_msg
5042 * will be shifted to point to the beginning of the
5043 * record plaintext.
5044 */
5045
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005046#if defined(MBEDTLS_SSL_PROTO_DTLS)
5047 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5048 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005049 /* This sets the header pointers to match records
5050 * without CID. When we receive a record containing
5051 * a CID, the fields are shifted accordingly in
5052 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005053 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005054#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005055 ssl->in_cid = ssl->in_ctr + 8;
5056 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005057#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005058 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005059#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005060 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005061 }
5062 else
5063#endif
5064 {
5065 ssl->in_ctr = ssl->in_hdr - 8;
5066 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005067#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005068 ssl->in_cid = ssl->in_len;
5069#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005070 ssl->in_iv = ssl->in_hdr + 5;
5071 }
5072
Hanno Becker79594fd2019-05-08 09:38:41 +01005073 /* This will be adjusted at record decryption time. */
5074 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005075}
5076
Paul Bakker5121ce52009-01-03 21:22:43 +00005077/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005078 * Setup an SSL context
5079 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005080
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005081void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005082{
5083 /* Set the incoming and outgoing record pointers. */
5084#if defined(MBEDTLS_SSL_PROTO_DTLS)
5085 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5086 {
5087 ssl->out_hdr = ssl->out_buf;
5088 ssl->in_hdr = ssl->in_buf;
5089 }
5090 else
5091#endif /* MBEDTLS_SSL_PROTO_DTLS */
5092 {
5093 ssl->out_hdr = ssl->out_buf + 8;
5094 ssl->in_hdr = ssl->in_buf + 8;
5095 }
5096
5097 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005098 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5099 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005100}
5101
Paul Bakker5121ce52009-01-03 21:22:43 +00005102/*
5103 * SSL get accessors
5104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005106{
5107 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5108}
5109
Hanno Becker8b170a02017-10-10 11:51:19 +01005110int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5111{
5112 /*
5113 * Case A: We're currently holding back
5114 * a message for further processing.
5115 */
5116
5117 if( ssl->keep_current_message == 1 )
5118 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005120 return( 1 );
5121 }
5122
5123 /*
5124 * Case B: Further records are pending in the current datagram.
5125 */
5126
5127#if defined(MBEDTLS_SSL_PROTO_DTLS)
5128 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5129 ssl->in_left > ssl->next_record_offset )
5130 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005131 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005132 return( 1 );
5133 }
5134#endif /* MBEDTLS_SSL_PROTO_DTLS */
5135
5136 /*
5137 * Case C: A handshake message is being processed.
5138 */
5139
Hanno Becker8b170a02017-10-10 11:51:19 +01005140 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5141 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005142 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005143 return( 1 );
5144 }
5145
5146 /*
5147 * Case D: An application data message is being processed
5148 */
5149 if( ssl->in_offt != NULL )
5150 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005151 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005152 return( 1 );
5153 }
5154
5155 /*
5156 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005157 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005158 * we implement support for multiple alerts in single records.
5159 */
5160
5161 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5162 return( 0 );
5163}
5164
Paul Bakker43ca69c2011-01-15 17:35:19 +00005165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005167{
Hanno Becker3136ede2018-08-17 15:28:19 +01005168 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005169 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005170 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005171
Hanno Becker5903de42019-05-03 14:46:38 +01005172 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5173
Hanno Becker78640902018-08-13 16:35:15 +01005174 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005175 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005177#if defined(MBEDTLS_ZLIB_SUPPORT)
5178 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5179 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005180#endif
5181
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005182 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005183 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005184 case MBEDTLS_MODE_GCM:
5185 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005186 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005187 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005188 transform_expansion = transform->minlen;
5189 break;
5190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005192
5193 block_size = mbedtls_cipher_get_block_size(
5194 &transform->cipher_ctx_enc );
5195
Hanno Becker3136ede2018-08-17 15:28:19 +01005196 /* Expansion due to the addition of the MAC. */
5197 transform_expansion += transform->maclen;
5198
5199 /* Expansion due to the addition of CBC padding;
5200 * Theoretically up to 256 bytes, but we never use
5201 * more than the block size of the underlying cipher. */
5202 transform_expansion += block_size;
5203
5204 /* For TLS 1.1 or higher, an explicit IV is added
5205 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005206#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5207 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005208 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005209#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005210
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005211 break;
5212
5213 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005214 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005215 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005216 }
5217
Hanno Beckera0e20d02019-05-15 14:03:01 +01005218#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005219 if( transform->out_cid_len != 0 )
5220 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005221#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005222
Hanno Becker5903de42019-05-03 14:46:38 +01005223 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005224}
5225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005226#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005227/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005228 * Check record counters and renegotiate if they're above the limit.
5229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005230static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005231{
Hanno Beckerdd772292020-02-05 10:38:31 +00005232 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005233 int in_ctr_cmp;
5234 int out_ctr_cmp;
5235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005236 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5237 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005238 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005239 {
5240 return( 0 );
5241 }
5242
Andres AG2196c7f2016-12-15 17:01:16 +00005243 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5244 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005245 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005246 ssl->conf->renego_period + ep_len, 8 - ep_len );
5247
5248 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005249 {
5250 return( 0 );
5251 }
5252
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005254 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005255}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005256#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005257
5258/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005259 * Receive application data decrypted from the SSL layer
5260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005262{
Janos Follath865b3eb2019-12-16 11:46:15 +00005263 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005264 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005265
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005266 if( ssl == NULL || ssl->conf == NULL )
5267 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005269 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005271#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005272 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005273 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005274 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005275 return( ret );
5276
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005277 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005278 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005279 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005280 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005281 return( ret );
5282 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005283 }
5284#endif
5285
Hanno Becker4a810fb2017-05-24 16:27:30 +01005286 /*
5287 * Check if renegotiation is necessary and/or handshake is
5288 * in process. If yes, perform/continue, and fall through
5289 * if an unexpected packet is received while the client
5290 * is waiting for the ServerHello.
5291 *
5292 * (There is no equivalent to the last condition on
5293 * the server-side as it is not treated as within
5294 * a handshake while waiting for the ClientHello
5295 * after a renegotiation request.)
5296 */
5297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005298#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005299 ret = ssl_check_ctr_renegotiate( ssl );
5300 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5301 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005302 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005303 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005304 return( ret );
5305 }
5306#endif
5307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005309 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005310 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005311 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5312 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005313 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005314 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005315 return( ret );
5316 }
5317 }
5318
Hanno Beckere41158b2017-10-23 13:30:32 +01005319 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005320 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005321 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005322 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005323 if( ssl->f_get_timer != NULL &&
5324 ssl->f_get_timer( ssl->p_timer ) == -1 )
5325 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005326 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005327 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005328
Hanno Becker327c93b2018-08-15 13:56:18 +01005329 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005330 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005331 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5332 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005333
Hanno Becker4a810fb2017-05-24 16:27:30 +01005334 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5335 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005336 }
5337
5338 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005340 {
5341 /*
5342 * OpenSSL sends empty messages to randomize the IV
5343 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005344 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005345 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005347 return( 0 );
5348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005349 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005350 return( ret );
5351 }
5352 }
5353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005357
Hanno Becker4a810fb2017-05-24 16:27:30 +01005358 /*
5359 * - For client-side, expect SERVER_HELLO_REQUEST.
5360 * - For server-side, expect CLIENT_HELLO.
5361 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5362 */
5363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005365 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005366 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005367 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005368 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005369 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005370
5371 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005373 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005374 {
5375 continue;
5376 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005377#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005378 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005379 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005380#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005381
Hanno Becker4a810fb2017-05-24 16:27:30 +01005382#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005383 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005384 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005385 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005386 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005387
5388 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005389#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005390 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005391 {
5392 continue;
5393 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005394#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005396 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005397#endif /* MBEDTLS_SSL_SRV_C */
5398
Hanno Becker21df7f92017-10-17 11:03:26 +01005399#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005400 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005401 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5402 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5403 ssl->conf->allow_legacy_renegotiation ==
5404 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5405 {
5406 /*
5407 * Accept renegotiation request
5408 */
Paul Bakker48916f92012-09-16 19:57:18 +00005409
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005410 /* DTLS clients need to know renego is server-initiated */
5411#if defined(MBEDTLS_SSL_PROTO_DTLS)
5412 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5413 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5414 {
5415 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5416 }
5417#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005418 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005419 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5420 ret != 0 )
5421 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005422 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5423 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005424 return( ret );
5425 }
5426 }
5427 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005428#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005429 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005430 /*
5431 * Refuse renegotiation
5432 */
5433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005436#if defined(MBEDTLS_SSL_PROTO_SSL3)
5437 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005438 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005439 /* SSLv3 does not have a "no_renegotiation" warning, so
5440 we send a fatal alert and abort the connection. */
5441 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5442 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5443 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005444 }
5445 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005446#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5447#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5448 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5449 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005450 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5452 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5453 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005454 {
5455 return( ret );
5456 }
Paul Bakker48916f92012-09-16 19:57:18 +00005457 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005458 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005459#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5460 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005461 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5463 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005464 }
Paul Bakker48916f92012-09-16 19:57:18 +00005465 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005466
Hanno Becker90333da2017-10-10 11:27:13 +01005467 /* At this point, we don't know whether the renegotiation has been
5468 * completed or not. The cases to consider are the following:
5469 * 1) The renegotiation is complete. In this case, no new record
5470 * has been read yet.
5471 * 2) The renegotiation is incomplete because the client received
5472 * an application data record while awaiting the ServerHello.
5473 * 3) The renegotiation is incomplete because the client received
5474 * a non-handshake, non-application data message while awaiting
5475 * the ServerHello.
5476 * In each of these case, looping will be the proper action:
5477 * - For 1), the next iteration will read a new record and check
5478 * if it's application data.
5479 * - For 2), the loop condition isn't satisfied as application data
5480 * is present, hence continue is the same as break
5481 * - For 3), the loop condition is satisfied and read_record
5482 * will re-deliver the message that was held back by the client
5483 * when expecting the ServerHello.
5484 */
5485 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005486 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005487#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005488 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005489 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005490 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005491 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005492 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005493 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005495 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005497 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005498 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005499 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005500#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005502 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5503 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005505 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005506 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005507 }
5508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005509 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005510 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005511 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5512 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005513 }
5514
5515 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005516
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005517 /* We're going to return something now, cancel timer,
5518 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005520 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005521
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005522#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005523 /* If we requested renego but received AppData, resend HelloRequest.
5524 * Do it now, after setting in_offt, to avoid taking this branch
5525 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005526#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005527 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005529 {
Hanno Becker786300f2020-02-05 10:46:40 +00005530 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005531 {
Hanno Becker786300f2020-02-05 10:46:40 +00005532 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5533 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005534 return( ret );
5535 }
5536 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005538#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005539 }
5540
5541 n = ( len < ssl->in_msglen )
5542 ? len : ssl->in_msglen;
5543
5544 memcpy( buf, ssl->in_offt, n );
5545 ssl->in_msglen -= n;
5546
5547 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005548 {
5549 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005550 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005551 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005552 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005553 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005554 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005555 /* more data available */
5556 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005557 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005558
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005559 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005560
Paul Bakker23986e52011-04-24 08:57:21 +00005561 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005562}
5563
5564/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005565 * Send application data to be encrypted by the SSL layer, taking care of max
5566 * fragment length and buffer size.
5567 *
5568 * According to RFC 5246 Section 6.2.1:
5569 *
5570 * Zero-length fragments of Application data MAY be sent as they are
5571 * potentially useful as a traffic analysis countermeasure.
5572 *
5573 * Therefore, it is possible that the input message length is 0 and the
5574 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005575 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005576static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005577 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005578{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005579 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5580 const size_t max_len = (size_t) ret;
5581
5582 if( ret < 0 )
5583 {
5584 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5585 return( ret );
5586 }
5587
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005588 if( len > max_len )
5589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005591 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005592 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005593 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005594 "maximum fragment length: %d > %d",
5595 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005596 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005597 }
5598 else
5599#endif
5600 len = max_len;
5601 }
Paul Bakker887bd502011-06-08 13:10:54 +00005602
Paul Bakker5121ce52009-01-03 21:22:43 +00005603 if( ssl->out_left != 0 )
5604 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005605 /*
5606 * The user has previously tried to send the data and
5607 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5608 * written. In this case, we expect the high-level write function
5609 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005612 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005614 return( ret );
5615 }
5616 }
Paul Bakker887bd502011-06-08 13:10:54 +00005617 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005618 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005619 /*
5620 * The user is trying to send a message the first time, so we need to
5621 * copy the data into the internal buffers and setup the data structure
5622 * to keep track of partial writes
5623 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005624 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005626 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005627
Hanno Becker67bc7c32018-08-06 11:33:50 +01005628 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005629 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005631 return( ret );
5632 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005633 }
5634
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005635 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005636}
5637
5638/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005639 * Write application data, doing 1/n-1 splitting if necessary.
5640 *
5641 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005642 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005643 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005645#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005646static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005647 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005648{
Janos Follath865b3eb2019-12-16 11:46:15 +00005649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005650
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005651 if( ssl->conf->cbc_record_splitting ==
5652 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005653 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005654 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5655 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5656 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005657 {
5658 return( ssl_write_real( ssl, buf, len ) );
5659 }
5660
5661 if( ssl->split_done == 0 )
5662 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005663 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005664 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005665 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005666 }
5667
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005668 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5669 return( ret );
5670 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005671
5672 return( ret + 1 );
5673}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005674#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005675
5676/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005677 * Write application data (public-facing wrapper)
5678 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005679int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005680{
Janos Follath865b3eb2019-12-16 11:46:15 +00005681 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005682
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005683 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005684
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005685 if( ssl == NULL || ssl->conf == NULL )
5686 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5687
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005688#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005689 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5690 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005691 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005692 return( ret );
5693 }
5694#endif
5695
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005696 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005697 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005698 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005699 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005700 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005701 return( ret );
5702 }
5703 }
5704
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005705#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005706 ret = ssl_write_split( ssl, buf, len );
5707#else
5708 ret = ssl_write_real( ssl, buf, len );
5709#endif
5710
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005712
5713 return( ret );
5714}
5715
5716/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005717 * Notify the peer that the connection is being closed
5718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005720{
Janos Follath865b3eb2019-12-16 11:46:15 +00005721 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005722
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005723 if( ssl == NULL || ssl->conf == NULL )
5724 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005726 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005727
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005728 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005729 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005730
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005731 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005732 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5734 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5735 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005736 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005738 return( ret );
5739 }
5740 }
5741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005742 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005743
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005744 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005745}
5746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005747void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005748{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005749 if( transform == NULL )
5750 return;
5751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005752#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005753 deflateEnd( &transform->ctx_deflate );
5754 inflateEnd( &transform->ctx_inflate );
5755#endif
5756
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005757 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5758 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005759
Hanno Beckerd56ed242018-01-03 15:32:51 +00005760#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761 mbedtls_md_free( &transform->md_ctx_enc );
5762 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005763#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005764
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005765 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005766}
5767
Hanno Becker0271f962018-08-16 13:23:47 +01005768#if defined(MBEDTLS_SSL_PROTO_DTLS)
5769
Hanno Becker533ab5f2020-02-05 10:49:13 +00005770void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005771{
5772 unsigned offset;
5773 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5774
5775 if( hs == NULL )
5776 return;
5777
Hanno Becker283f5ef2018-08-24 09:34:47 +01005778 ssl_free_buffered_record( ssl );
5779
Hanno Becker0271f962018-08-16 13:23:47 +01005780 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005781 ssl_buffering_free_slot( ssl, offset );
5782}
5783
5784static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5785 uint8_t slot )
5786{
5787 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5788 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005789
5790 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5791 return;
5792
Hanno Beckere605b192018-08-21 15:59:07 +01005793 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005794 {
Hanno Beckere605b192018-08-21 15:59:07 +01005795 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005796 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005797 mbedtls_free( hs_buf->data );
5798 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005799 }
5800}
5801
5802#endif /* MBEDTLS_SSL_PROTO_DTLS */
5803
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005804/*
5805 * Convert version numbers to/from wire format
5806 * and, for DTLS, to/from TLS equivalent.
5807 *
5808 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005809 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005810 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5811 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005813void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005814 unsigned char ver[2] )
5815{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005816#if defined(MBEDTLS_SSL_PROTO_DTLS)
5817 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005818 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005819 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005820 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5821
5822 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5823 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5824 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005825 else
5826#else
5827 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005828#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005829 {
5830 ver[0] = (unsigned char) major;
5831 ver[1] = (unsigned char) minor;
5832 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005833}
5834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005835void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005836 const unsigned char ver[2] )
5837{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005838#if defined(MBEDTLS_SSL_PROTO_DTLS)
5839 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005840 {
5841 *major = 255 - ver[0] + 2;
5842 *minor = 255 - ver[1] + 1;
5843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005844 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005845 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5846 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005847 else
5848#else
5849 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005850#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005851 {
5852 *major = ver[0];
5853 *minor = ver[1];
5854 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005855}
5856
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005857#endif /* MBEDTLS_SSL_TLS_C */