blob: e5331a74685dcbbf99c2a60c229d1fba01968f97 [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 Beckera0e20d02019-05-15 14:03:01 +0100344#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker581bc1b2020-05-04 12:20:03 +0100345/* This functions transforms a (D)TLS plaintext fragment and a record content
346 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
347 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
348 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100349 *
350 * struct {
351 * opaque content[DTLSPlaintext.length];
352 * ContentType real_type;
353 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100354 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100355 *
356 * Input:
357 * - `content`: The beginning of the buffer holding the
358 * plaintext to be wrapped.
359 * - `*content_size`: The length of the plaintext in Bytes.
360 * - `max_len`: The number of Bytes available starting from
361 * `content`. This must be `>= *content_size`.
362 * - `rec_type`: The desired record content type.
363 *
364 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100365 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
366 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100367 *
368 * Returns:
369 * - `0` on success.
370 * - A negative error code if `max_len` didn't offer enough space
371 * for the expansion.
372 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100373static int ssl_build_inner_plaintext( unsigned char *content,
374 size_t *content_size,
375 size_t remaining,
376 uint8_t rec_type )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100377{
378 size_t len = *content_size;
Hanno Beckerb9ec44f2019-05-13 15:31:17 +0100379 size_t pad = ( MBEDTLS_SSL_CID_PADDING_GRANULARITY -
380 ( len + 1 ) % MBEDTLS_SSL_CID_PADDING_GRANULARITY ) %
381 MBEDTLS_SSL_CID_PADDING_GRANULARITY;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
383 /* Write real content type */
384 if( remaining == 0 )
385 return( -1 );
386 content[ len ] = rec_type;
387 len++;
388 remaining--;
389
390 if( remaining < pad )
391 return( -1 );
392 memset( content + len, 0, pad );
393 len += pad;
394 remaining -= pad;
395
396 *content_size = len;
397 return( 0 );
398}
399
Hanno Becker581bc1b2020-05-04 12:20:03 +0100400/* This function parses a (D)TLSInnerPlaintext structure.
401 * See ssl_build_inner_plaintext() for details. */
402static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100403 size_t *content_size,
404 uint8_t *rec_type )
405{
406 size_t remaining = *content_size;
407
408 /* Determine length of padding by skipping zeroes from the back. */
409 do
410 {
411 if( remaining == 0 )
412 return( -1 );
413 remaining--;
414 } while( content[ remaining ] == 0 );
415
416 *content_size = remaining;
417 *rec_type = content[ remaining ];
418
419 return( 0 );
420}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100421#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100422
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100423/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100424 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000425static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100426 size_t *add_data_len,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000427 mbedtls_record *rec )
428{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100429 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100430 *
431 * additional_data = seq_num + TLSCompressed.type +
432 * TLSCompressed.version + TLSCompressed.length;
433 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100434 * For the CID extension, this is extended as follows
435 * (quoting draft-ietf-tls-dtls-connection-id-05,
436 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100437 *
438 * additional_data = seq_num + DTLSPlaintext.type +
439 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100440 * cid +
441 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100442 * length_of_DTLSInnerPlaintext;
443 */
444
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000445 memcpy( add_data, rec->ctr, sizeof( rec->ctr ) );
446 add_data[8] = rec->type;
Hanno Beckeredb24f82019-05-20 15:01:46 +0100447 memcpy( add_data + 9, rec->ver, sizeof( rec->ver ) );
Hanno Beckercab87e62019-04-29 13:52:53 +0100448
Hanno Beckera0e20d02019-05-15 14:03:01 +0100449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100450 if( rec->cid_len != 0 )
451 {
452 memcpy( add_data + 11, rec->cid, rec->cid_len );
453 add_data[11 + rec->cid_len + 0] = rec->cid_len;
454 add_data[11 + rec->cid_len + 1] = ( rec->data_len >> 8 ) & 0xFF;
455 add_data[11 + rec->cid_len + 2] = ( rec->data_len >> 0 ) & 0xFF;
456 *add_data_len = 13 + 1 + rec->cid_len;
457 }
458 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 {
461 add_data[11 + 0] = ( rec->data_len >> 8 ) & 0xFF;
462 add_data[11 + 1] = ( rec->data_len >> 0 ) & 0xFF;
463 *add_data_len = 13;
464 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000465}
466
Hanno Becker9d062f92020-02-07 10:26:36 +0000467#if defined(MBEDTLS_SSL_PROTO_SSL3)
468
469#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
470
471/*
472 * SSLv3.0 MAC functions
473 */
474static void ssl_mac( mbedtls_md_context_t *md_ctx,
475 const unsigned char *secret,
476 const unsigned char *buf, size_t len,
477 const unsigned char *ctr, int type,
478 unsigned char out[SSL3_MAC_MAX_BYTES] )
479{
480 unsigned char header[11];
481 unsigned char padding[48];
482 int padlen;
483 int md_size = mbedtls_md_get_size( md_ctx->md_info );
484 int md_type = mbedtls_md_get_type( md_ctx->md_info );
485
486 /* Only MD5 and SHA-1 supported */
487 if( md_type == MBEDTLS_MD_MD5 )
488 padlen = 48;
489 else
490 padlen = 40;
491
492 memcpy( header, ctr, 8 );
493 header[ 8] = (unsigned char) type;
494 header[ 9] = (unsigned char)( len >> 8 );
495 header[10] = (unsigned char)( len );
496
497 memset( padding, 0x36, padlen );
498 mbedtls_md_starts( md_ctx );
499 mbedtls_md_update( md_ctx, secret, md_size );
500 mbedtls_md_update( md_ctx, padding, padlen );
501 mbedtls_md_update( md_ctx, header, 11 );
502 mbedtls_md_update( md_ctx, buf, len );
503 mbedtls_md_finish( md_ctx, out );
504
505 memset( padding, 0x5C, padlen );
506 mbedtls_md_starts( md_ctx );
507 mbedtls_md_update( md_ctx, secret, md_size );
508 mbedtls_md_update( md_ctx, padding, padlen );
509 mbedtls_md_update( md_ctx, out, md_size );
510 mbedtls_md_finish( md_ctx, out );
511}
512#endif /* MBEDTLS_SSL_PROTO_SSL3 */
513
Hanno Beckera18d1322018-01-03 14:27:32 +0000514int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
515 mbedtls_ssl_transform *transform,
516 mbedtls_record *rec,
517 int (*f_rng)(void *, unsigned char *, size_t),
518 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000519{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100521 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000522 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100523 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100524 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000525 size_t post_avail;
526
527 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000528#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200529 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000530 ((void) ssl);
531#endif
532
533 /* The PRNG is used for dynamic IV generation that's used
534 * for CBC transformations in TLS 1.1 and TLS 1.2. */
535#if !( defined(MBEDTLS_CIPHER_MODE_CBC) && \
536 ( defined(MBEDTLS_AES_C) || \
537 defined(MBEDTLS_ARIA_C) || \
538 defined(MBEDTLS_CAMELLIA_C) ) && \
539 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
540 ((void) f_rng);
541 ((void) p_rng);
542#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000545
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000546 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100547 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000548 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
549 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
550 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100551 if( rec == NULL
552 || rec->buf == NULL
553 || rec->buf_len < rec->data_offset
554 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100555#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100556 || rec->cid_len != 0
557#endif
558 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000559 {
560 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100562 }
563
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000564 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100565 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000567 data, rec->data_len );
568
569 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
570
571 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
572 {
573 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
574 (unsigned) rec->data_len,
575 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
576 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
577 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100578
Hanno Beckera0e20d02019-05-15 14:03:01 +0100579#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100580 /*
581 * Add CID information
582 */
583 rec->cid_len = transform->out_cid_len;
584 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
585 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100586
587 if( rec->cid_len != 0 )
588 {
589 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100590 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100591 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100592 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100593 * Note that this changes `rec->data_len`, and hence
594 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100595 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100596 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100597 &rec->data_len,
598 post_avail,
599 rec->type ) != 0 )
600 {
601 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
602 }
603
604 rec->type = MBEDTLS_SSL_MSG_CID;
605 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100606#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100607
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100608 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
609
Paul Bakker5121ce52009-01-03 21:22:43 +0000610 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100611 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000612 */
Hanno Becker52344c22018-01-03 15:24:20 +0000613#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 if( mode == MBEDTLS_MODE_STREAM ||
615 ( mode == MBEDTLS_MODE_CBC
616#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000617 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100618#endif
619 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000620 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000621 if( post_avail < transform->maclen )
622 {
623 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
624 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
625 }
626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000628 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200629 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000630 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000631 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
632 data, rec->data_len, rec->ctr, rec->type, mac );
633 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200634 }
635 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200636#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
638 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000639 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200640 {
Hanno Becker992b6872017-11-09 18:57:39 +0000641 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
642
Hanno Beckercab87e62019-04-29 13:52:53 +0100643 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker992b6872017-11-09 18:57:39 +0000644
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000645 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100646 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000647 mbedtls_md_hmac_update( &transform->md_ctx_enc,
648 data, rec->data_len );
649 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
650 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
651
652 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200653 }
654 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200655#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200656 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200657 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
658 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200659 }
660
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000661 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
662 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200663
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000664 rec->data_len += transform->maclen;
665 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100666 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200667 }
Hanno Becker52344c22018-01-03 15:24:20 +0000668#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200670 /*
671 * Encrypt
672 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
674 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000675 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000677 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000679 "including %d bytes of padding",
680 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000681
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000682 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
683 transform->iv_enc, transform->ivlen,
684 data, rec->data_len,
685 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200686 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200688 return( ret );
689 }
690
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000691 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200692 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200693 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
694 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200695 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000696 }
Paul Bakker68884e32013-01-07 18:20:04 +0100697 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200698#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000699
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200700#if defined(MBEDTLS_GCM_C) || \
701 defined(MBEDTLS_CCM_C) || \
702 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200704 mode == MBEDTLS_MODE_CCM ||
705 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000706 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000707 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200708 unsigned char iv[12];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000709 size_t explicit_iv_len = transform->ivlen - transform->fixed_ivlen;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000710
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000711 /* Check that there's space for both the authentication tag
712 * and the explicit IV before and after the record content. */
713 if( post_avail < transform->taglen ||
714 rec->data_offset < explicit_iv_len )
715 {
716 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
717 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
718 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000719
Paul Bakker68884e32013-01-07 18:20:04 +0100720 /*
721 * Generate IV
722 */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200723 if( transform->ivlen == 12 && transform->fixed_ivlen == 4 )
724 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +0200725 /* GCM and CCM: fixed || explicit (=seqnum) */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200726 memcpy( iv, transform->iv_enc, transform->fixed_ivlen );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000727 memcpy( iv + transform->fixed_ivlen, rec->ctr,
728 explicit_iv_len );
729 /* Prefix record content with explicit IV. */
730 memcpy( data - explicit_iv_len, rec->ctr, explicit_iv_len );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200731 }
732 else if( transform->ivlen == 12 && transform->fixed_ivlen == 12 )
733 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +0200734 /* ChachaPoly: fixed XOR sequence number */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200735 unsigned char i;
736
737 memcpy( iv, transform->iv_enc, transform->fixed_ivlen );
738
739 for( i = 0; i < 8; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000740 iv[i+4] ^= rec->ctr[i];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200741 }
742 else
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100743 {
744 /* Reminder if we ever add an AEAD mode with a different size */
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é-Gonnardd056ce02014-10-29 22:29:20 +0100747 }
748
Hanno Beckercab87e62019-04-29 13:52:53 +0100749 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker1f10d762019-04-26 13:34:37 +0100750
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200751 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
752 iv, transform->ivlen );
753 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000754 data - explicit_iv_len, explicit_iv_len );
755 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100756 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200758 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000759 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000760
Paul Bakker68884e32013-01-07 18:20:04 +0100761 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200762 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200763 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000764
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200765 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000766 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100767 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 data, rec->data_len, /* source */
769 data, &rec->data_len, /* destination */
770 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200771 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200773 return( ret );
774 }
775
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000776 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
777 data + rec->data_len, transform->taglen );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200778
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000779 rec->data_len += transform->taglen + explicit_iv_len;
780 rec->data_offset -= explicit_iv_len;
781 post_avail -= transform->taglen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100782 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000783 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
786#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000787 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000789 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000791 size_t padlen, i;
792 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000793
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000794 /* Currently we're always using minimal padding
795 * (up to 255 bytes would be allowed). */
796 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
797 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000798 padlen = 0;
799
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000800 /* Check there's enough space in the buffer for the padding. */
801 if( post_avail < padlen + 1 )
802 {
803 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
804 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
805 }
806
Paul Bakker5121ce52009-01-03 21:22:43 +0000807 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000808 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000809
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000810 rec->data_len += padlen + 1;
811 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000814 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000815 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
816 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000817 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000819 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000820 if( f_rng == NULL )
821 {
822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
823 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
824 }
825
826 if( rec->data_offset < transform->ivlen )
827 {
828 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
829 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
830 }
831
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000832 /*
833 * Generate IV
834 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000835 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000836 if( ret != 0 )
837 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000838
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000839 memcpy( data - transform->ivlen, transform->iv_enc,
840 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000841
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000842 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200843#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000846 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200848 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000849
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000850 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
851 transform->iv_enc,
852 transform->ivlen,
853 data, rec->data_len,
854 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200855 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200857 return( ret );
858 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200859
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000860 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200861 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
863 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200864 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200865
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200868 {
869 /*
870 * Save IV in SSL3 and TLS1
871 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000872 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
873 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000874 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200876#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000877 {
878 data -= transform->ivlen;
879 rec->data_offset -= transform->ivlen;
880 rec->data_len += transform->ivlen;
881 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100882
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100884 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100885 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000886 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
887
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100888 /*
889 * MAC(MAC_write_key, seq_num +
890 * TLSCipherText.type +
891 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100892 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100893 * IV + // except for TLS 1.0
894 * ENC(content + padding + padding_length));
895 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896
897 if( post_avail < transform->maclen)
898 {
899 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
900 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
901 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100902
Hanno Beckercab87e62019-04-29 13:52:53 +0100903 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker1f10d762019-04-26 13:34:37 +0100904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000906 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100907 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100908
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000909 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100910 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 mbedtls_md_hmac_update( &transform->md_ctx_enc,
912 data, rec->data_len );
913 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
914 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100915
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000916 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100917
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000918 rec->data_len += transform->maclen;
919 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100920 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100921 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000923 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200924 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +0000926 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200927 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
929 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200930 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000931
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100932 /* Make extra sure authentication was performed, exactly once */
933 if( auth_done != 1 )
934 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
936 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100937 }
938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000940
941 return( 0 );
942}
943
Hanno Becker605949f2019-07-12 08:23:59 +0100944int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +0000945 mbedtls_ssl_transform *transform,
946 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +0000947{
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000948 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000950 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +0000951#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +0100952 size_t padlen = 0, correct = 1;
953#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000954 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100955 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100956 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000957
Hanno Beckera18d1322018-01-03 14:27:32 +0000958#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200959 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000960 ((void) ssl);
961#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000962
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000964 if( rec == NULL ||
965 rec->buf == NULL ||
966 rec->buf_len < rec->data_offset ||
967 rec->buf_len - rec->data_offset < rec->data_len )
968 {
969 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100971 }
972
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000973 data = rec->buf + rec->data_offset;
974 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +0000975
Hanno Beckera0e20d02019-05-15 14:03:01 +0100976#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100977 /*
978 * Match record's CID with incoming CID.
979 */
Hanno Becker938489a2019-05-08 13:02:22 +0100980 if( rec->cid_len != transform->in_cid_len ||
981 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
982 {
Hanno Becker8367ccc2019-05-14 11:30:10 +0100983 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +0100984 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100985#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
988 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +0100989 {
990 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000991 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
992 transform->iv_dec,
993 transform->ivlen,
994 data, rec->data_len,
995 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200996 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200998 return( ret );
999 }
1000
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001001 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001002 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1004 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001005 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001006 }
Paul Bakker68884e32013-01-07 18:20:04 +01001007 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001009#if defined(MBEDTLS_GCM_C) || \
1010 defined(MBEDTLS_CCM_C) || \
1011 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001013 mode == MBEDTLS_MODE_CCM ||
1014 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001015 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001016 unsigned char iv[12];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001017 size_t explicit_iv_len = transform->ivlen - transform->fixed_ivlen;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001018
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001019 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001020 * Prepare IV from explicit and implicit data.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001021 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001022
1023 /* Check that there's enough space for the explicit IV
1024 * (at the beginning of the record) and the MAC (at the
1025 * end of the record). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001026 if( rec->data_len < explicit_iv_len + transform->taglen )
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001027 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001029 "+ taglen (%d)", rec->data_len,
1030 explicit_iv_len, transform->taglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001032 }
Paul Bakker68884e32013-01-07 18:20:04 +01001033
Hanno Beckerd96a6522019-07-10 13:55:25 +01001034#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CCM_C)
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001035 if( transform->ivlen == 12 && transform->fixed_ivlen == 4 )
1036 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001037 /* GCM and CCM: fixed || explicit */
Paul Bakker68884e32013-01-07 18:20:04 +01001038
Hanno Beckerd96a6522019-07-10 13:55:25 +01001039 /* Fixed */
1040 memcpy( iv, transform->iv_dec, transform->fixed_ivlen );
1041 /* Explicit */
1042 memcpy( iv + transform->fixed_ivlen, data, 8 );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001043 }
Hanno Beckerd96a6522019-07-10 13:55:25 +01001044 else
1045#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1046#if defined(MBEDTLS_CHACHAPOLY_C)
1047 if( transform->ivlen == 12 && transform->fixed_ivlen == 12 )
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001048 {
Manuel Pégourié-Gonnard8744a022018-07-11 12:30:40 +02001049 /* ChachaPoly: fixed XOR sequence number */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001050 unsigned char i;
1051
1052 memcpy( iv, transform->iv_dec, transform->fixed_ivlen );
1053
1054 for( i = 0; i < 8; i++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001055 iv[i+4] ^= rec->ctr[i];
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001056 }
1057 else
Hanno Beckerd96a6522019-07-10 13:55:25 +01001058#endif /* MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001059 {
1060 /* Reminder if we ever add an AEAD mode with a different size */
1061 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1062 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1063 }
1064
Hanno Beckerd96a6522019-07-10 13:55:25 +01001065 /* Group changes to data, data_len, and add_data, because
1066 * add_data depends on data_len. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001067 data += explicit_iv_len;
1068 rec->data_offset += explicit_iv_len;
1069 rec->data_len -= explicit_iv_len + transform->taglen;
1070
Hanno Beckercab87e62019-04-29 13:52:53 +01001071 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001072 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001073 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001074
Hanno Beckerd96a6522019-07-10 13:55:25 +01001075 /* Because of the check above, we know that there are
1076 * explicit_iv_len Bytes preceeding data, and taglen
1077 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001078 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001079 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001080
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001081 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001082 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001083 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001084
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001085 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001086 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001087 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001088 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1089 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001090 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001091 data, rec->data_len,
1092 data, &olen,
1093 data + rec->data_len,
1094 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001095 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1099 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001100
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001101 return( ret );
1102 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001103 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001104
Hanno Beckerd96a6522019-07-10 13:55:25 +01001105 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001106 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001107 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1109 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001110 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001111 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001112 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
1114#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001115 ( defined(MBEDTLS_AES_C) || defined(MBEDTLS_CAMELLIA_C) || defined(MBEDTLS_ARIA_C) )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001117 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001118 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001119
Paul Bakker5121ce52009-01-03 21:22:43 +00001120 /*
Paul Bakker45829992013-01-03 14:52:21 +01001121 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001124 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1125 {
1126 /* The ciphertext is prefixed with the CBC IV. */
1127 minlen += transform->ivlen;
1128 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001129#endif
Paul Bakker45829992013-01-03 14:52:21 +01001130
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001131 /* Size considerations:
1132 *
1133 * - The CBC cipher text must not be empty and hence
1134 * at least of size transform->ivlen.
1135 *
1136 * Together with the potential IV-prefix, this explains
1137 * the first of the two checks below.
1138 *
1139 * - The record must contain a MAC, either in plain or
1140 * encrypted, depending on whether Encrypt-then-MAC
1141 * is used or not.
1142 * - If it is, the message contains the IV-prefix,
1143 * the CBC ciphertext, and the MAC.
1144 * - If it is not, the padded plaintext, and hence
1145 * the CBC ciphertext, has at least length maclen + 1
1146 * because there is at least the padding length byte.
1147 *
1148 * As the CBC ciphertext is not empty, both cases give the
1149 * lower bound minlen + maclen + 1 on the record size, which
1150 * we test for in the second check below.
1151 */
1152 if( rec->data_len < minlen + transform->ivlen ||
1153 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001154 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001156 "+ 1 ) ( + expl IV )", rec->data_len,
1157 transform->ivlen,
1158 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001160 }
1161
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001162 /*
1163 * Authenticate before decrypt if enabled
1164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001166 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001167 {
Hanno Becker992b6872017-11-09 18:57:39 +00001168 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001171
Hanno Beckerd96a6522019-07-10 13:55:25 +01001172 /* Update data_len in tandem with add_data.
1173 *
1174 * The subtraction is safe because of the previous check
1175 * data_len >= minlen + maclen + 1.
1176 *
1177 * Afterwards, we know that data + data_len is followed by at
1178 * least maclen Bytes, which justifies the call to
1179 * mbedtls_ssl_safer_memcmp() below.
1180 *
1181 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001182 rec->data_len -= transform->maclen;
Hanno Beckercab87e62019-04-29 13:52:53 +01001183 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001184
Hanno Beckerd96a6522019-07-10 13:55:25 +01001185 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001186 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1187 add_data_len );
1188 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1189 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001190 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1191 data, rec->data_len );
1192 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1193 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001194
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001195 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1196 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001197 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001198 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001199
Hanno Beckerd96a6522019-07-10 13:55:25 +01001200 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001201 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1202 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001203 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001206 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001207 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001208 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001210
1211 /*
1212 * Check length sanity
1213 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001214
1215 /* We know from above that data_len > minlen >= 0,
1216 * so the following check in particular implies that
1217 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001218 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001219 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001221 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001223 }
1224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001226 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001227 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001228 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001229 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001230 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001231 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001232 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001233
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001234 data += transform->ivlen;
1235 rec->data_offset += transform->ivlen;
1236 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001237 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001238#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001239
Hanno Beckerd96a6522019-07-10 13:55:25 +01001240 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1241
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001242 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1243 transform->iv_dec, transform->ivlen,
1244 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001245 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001247 return( ret );
1248 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001249
Hanno Beckerd96a6522019-07-10 13:55:25 +01001250 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001251 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001252 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001253 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1254 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001255 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001258 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001259 {
1260 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001261 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1262 * records is equivalent to CBC decryption of the concatenation
1263 * of the records; in other words, IVs are maintained across
1264 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001265 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001266 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1267 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001268 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001269#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001270
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001271 /* Safe since data_len >= minlen + maclen + 1, so after having
1272 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001273 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1274 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001275 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001276
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001277 if( auth_done == 1 )
1278 {
1279 correct *= ( rec->data_len >= padlen + 1 );
1280 padlen *= ( rec->data_len >= padlen + 1 );
1281 }
1282 else
Paul Bakker45829992013-01-03 14:52:21 +01001283 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001285 if( rec->data_len < transform->maclen + padlen + 1 )
1286 {
1287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1288 rec->data_len,
1289 transform->maclen,
1290 padlen + 1 ) );
1291 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001292#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001293
1294 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1295 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001296 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001297
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001298 padlen++;
1299
1300 /* Regardless of the validity of the padding,
1301 * we have data_len >= padlen here. */
1302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001304 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001305 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001306 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308#if defined(MBEDTLS_SSL_DEBUG_ALL)
1309 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001310 "should be no more than %d",
1311 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001312#endif
Paul Bakker45829992013-01-03 14:52:21 +01001313 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001314 }
1315 }
1316 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1318#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1319 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001320 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001321 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 /* The padding check involves a series of up to 256
1323 * consecutive memory reads at the end of the record
1324 * plaintext buffer. In order to hide the length and
1325 * validity of the padding, always perform exactly
1326 * `min(256,plaintext_len)` reads (but take into account
1327 * only the last `padlen` bytes for the padding check). */
1328 size_t pad_count = 0;
1329 size_t real_count = 0;
1330 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001331
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332 /* Index of first padding byte; it has been ensured above
1333 * that the subtraction is safe. */
1334 size_t const padding_idx = rec->data_len - padlen;
1335 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1336 size_t const start_idx = rec->data_len - num_checks;
1337 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001338
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001339 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001340 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001341 real_count |= ( idx >= padding_idx );
1342 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001343 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001344 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001347 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001349#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001350 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001351 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001352 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1354 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001355 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1357 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001358 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001359
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001360 /* If the padding was found to be invalid, padlen == 0
1361 * and the subtraction is safe. If the padding was found valid,
1362 * padlen hasn't been changed and the previous assertion
1363 * data_len >= padlen still holds. */
1364 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001365 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001366 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367#endif /* MBEDTLS_CIPHER_MODE_CBC &&
Markku-Juhani O. Saarinenc06e1012017-12-07 11:51:13 +00001368 ( MBEDTLS_AES_C || MBEDTLS_CAMELLIA_C || MBEDTLS_ARIA_C ) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001369 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1371 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001372 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001373
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001374#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001376 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001377#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001378
1379 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001380 * Authenticate if not done yet.
1381 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001382 */
Hanno Becker52344c22018-01-03 15:24:20 +00001383#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001384 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001385 {
Hanno Becker992b6872017-11-09 18:57:39 +00001386 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001387
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001388 /* If the initial value of padlen was such that
1389 * data_len < maclen + padlen + 1, then padlen
1390 * got reset to 1, and the initial check
1391 * data_len >= minlen + maclen + 1
1392 * guarantees that at this point we still
1393 * have at least data_len >= maclen.
1394 *
1395 * If the initial value of padlen was such that
1396 * data_len >= maclen + padlen + 1, then we have
1397 * subtracted either padlen + 1 (if the padding was correct)
1398 * or 0 (if the padding was incorrect) since then,
1399 * hence data_len >= maclen in any case.
1400 */
1401 rec->data_len -= transform->maclen;
Hanno Beckercab87e62019-04-29 13:52:53 +01001402 ssl_extract_add_data_from_record( add_data, &add_data_len, rec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001405 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001406 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 ssl_mac( &transform->md_ctx_dec,
1408 transform->mac_dec,
1409 data, rec->data_len,
1410 rec->ctr, rec->type,
1411 mac_expect );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001412 }
1413 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1415#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1416 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001417 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001418 {
1419 /*
1420 * Process MAC and always update for padlen afterwards to make
Gilles Peskine20b44082018-05-29 14:06:49 +02001421 * total time independent of padlen.
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001422 *
1423 * Known timing attacks:
1424 * - Lucky Thirteen (http://www.isg.rhul.ac.uk/tls/TLStiming.pdf)
1425 *
Gilles Peskine20b44082018-05-29 14:06:49 +02001426 * To compensate for different timings for the MAC calculation
1427 * depending on how much padding was removed (which is determined
1428 * by padlen), process extra_run more blocks through the hash
1429 * function.
1430 *
1431 * The formula in the paper is
1432 * extra_run = ceil( (L1-55) / 64 ) - ceil( (L2-55) / 64 )
1433 * where L1 is the size of the header plus the decrypted message
1434 * plus CBC padding and L2 is the size of the header plus the
1435 * decrypted message. This is for an underlying hash function
1436 * with 64-byte blocks.
1437 * We use ( (Lx+8) / 64 ) to handle 'negative Lx' values
1438 * correctly. We round down instead of up, so -56 is the correct
1439 * value for our calculations instead of -55.
1440 *
Gilles Peskine1bd9d582018-06-04 11:58:44 +02001441 * Repeat the formula rather than defining a block_size variable.
1442 * This avoids requiring division by a variable at runtime
1443 * (which would be marginally less efficient and would require
1444 * linking an extra division function in some builds).
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001445 */
1446 size_t j, extra_run = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001447 unsigned char tmp[MBEDTLS_MD_MAX_BLOCK_SIZE];
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001448
1449 /*
1450 * The next two sizes are the minimum and maximum values of
1451 * in_msglen over all padlen values.
1452 *
1453 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001454 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001455 *
1456 * Note that max_len + maclen is never more than the buffer
1457 * length, as we previously did in_msglen -= maclen too.
1458 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001459 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001460 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1461
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001462 memset( tmp, 0, sizeof( tmp ) );
1463
1464 switch( mbedtls_md_get_type( transform->md_ctx_dec.md_info ) )
Gilles Peskine20b44082018-05-29 14:06:49 +02001465 {
Gilles Peskined0e55a42018-06-04 12:03:30 +02001466#if defined(MBEDTLS_MD5_C) || defined(MBEDTLS_SHA1_C) || \
1467 defined(MBEDTLS_SHA256_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001468 case MBEDTLS_MD_MD5:
1469 case MBEDTLS_MD_SHA1:
Gilles Peskine20b44082018-05-29 14:06:49 +02001470 case MBEDTLS_MD_SHA256:
Gilles Peskine20b44082018-05-29 14:06:49 +02001471 /* 8 bytes of message size, 64-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001472 extra_run =
1473 ( add_data_len + rec->data_len + padlen + 8 ) / 64 -
1474 ( add_data_len + rec->data_len + 8 ) / 64;
Gilles Peskine20b44082018-05-29 14:06:49 +02001475 break;
1476#endif
Gilles Peskinea7fe25d2018-06-04 12:01:18 +02001477#if defined(MBEDTLS_SHA512_C)
Gilles Peskine20b44082018-05-29 14:06:49 +02001478 case MBEDTLS_MD_SHA384:
Gilles Peskine20b44082018-05-29 14:06:49 +02001479 /* 16 bytes of message size, 128-byte compression blocks */
Hanno Beckercab87e62019-04-29 13:52:53 +01001480 extra_run =
1481 ( add_data_len + rec->data_len + padlen + 16 ) / 128 -
1482 ( add_data_len + rec->data_len + 16 ) / 128;
Gilles Peskine20b44082018-05-29 14:06:49 +02001483 break;
1484#endif
1485 default:
Gilles Peskine5c389842018-06-04 12:02:43 +02001486 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Gilles Peskine20b44082018-05-29 14:06:49 +02001487 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1488 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001489
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001490 extra_run &= correct * 0xFF;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001491
Hanno Beckercab87e62019-04-29 13:52:53 +01001492 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1493 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 mbedtls_md_hmac_update( &transform->md_ctx_dec, data,
1495 rec->data_len );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001496 /* Make sure we access everything even when padlen > 0. This
1497 * makes the synchronisation requirements for just-in-time
1498 * Prime+Probe attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001499 ssl_read_memory( data + rec->data_len, padlen );
1500 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001501
1502 /* Call mbedtls_md_process at least once due to cache attacks
1503 * that observe whether md_process() was called of not */
Manuel Pégourié-Gonnard47fede02015-04-29 01:35:48 +02001504 for( j = 0; j < extra_run + 1; j++ )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001505 mbedtls_md_process( &transform->md_ctx_dec, tmp );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001506
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001507 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001508
1509 /* Make sure we access all the memory that could contain the MAC,
1510 * before we check it in the next code block. This makes the
1511 * synchronisation requirements for just-in-time Prime+Probe
1512 * attacks much tighter and hopefully impractical. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001513 ssl_read_memory( data + min_len,
1514 max_len - min_len + transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001515 }
1516 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1518 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1521 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001522 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001523
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001524#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001525 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
1526 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001527#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001528
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1530 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001531 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532#if defined(MBEDTLS_SSL_DEBUG_ALL)
1533 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001534#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001535 correct = 0;
1536 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001537 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001538 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001539
1540 /*
1541 * Finally check the correct flag
1542 */
1543 if( correct == 0 )
1544 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001545#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001546
1547 /* Make extra sure authentication was performed, exactly once */
1548 if( auth_done != 1 )
1549 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1551 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001552 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001553
Hanno Beckera0e20d02019-05-15 14:03:01 +01001554#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001555 if( rec->cid_len != 0 )
1556 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001557 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1558 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001559 if( ret != 0 )
1560 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1561 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001562#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001565
1566 return( 0 );
1567}
1568
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001569#undef MAC_NONE
1570#undef MAC_PLAINTEXT
1571#undef MAC_CIPHERTEXT
1572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001574/*
1575 * Compression/decompression functions
1576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001578{
Janos Follath865b3eb2019-12-16 11:46:15 +00001579 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001580 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001581 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001582 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001583 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001584#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1585 size_t out_buf_len = ssl->out_buf_len;
1586#else
1587 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1588#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001590 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001591
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001592 if( len_pre == 0 )
1593 return( 0 );
1594
Paul Bakker2770fbd2012-07-03 13:30:23 +00001595 memcpy( msg_pre, ssl->out_msg, len_pre );
1596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001598 ssl->out_msglen ) );
1599
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001601 ssl->out_msg, ssl->out_msglen );
1602
Paul Bakker48916f92012-09-16 19:57:18 +00001603 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1604 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1605 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001606 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001607
Paul Bakker48916f92012-09-16 19:57:18 +00001608 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001609 if( ret != Z_OK )
1610 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001611 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1612 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001613 }
1614
Darryl Greenb33cc762019-11-28 14:29:44 +00001615 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001616 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001618 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001619 ssl->out_msglen ) );
1620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001622 ssl->out_msg, ssl->out_msglen );
1623
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001624 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001625
1626 return( 0 );
1627}
1628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001630{
Janos Follath865b3eb2019-12-16 11:46:15 +00001631 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001632 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001633 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001634 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001635 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001636#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1637 size_t in_buf_len = ssl->in_buf_len;
1638#else
1639 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1640#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001643
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001644 if( len_pre == 0 )
1645 return( 0 );
1646
Paul Bakker2770fbd2012-07-03 13:30:23 +00001647 memcpy( msg_pre, ssl->in_msg, len_pre );
1648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001650 ssl->in_msglen ) );
1651
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001653 ssl->in_msg, ssl->in_msglen );
1654
Paul Bakker48916f92012-09-16 19:57:18 +00001655 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1656 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1657 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001658 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001659
Paul Bakker48916f92012-09-16 19:57:18 +00001660 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001661 if( ret != Z_OK )
1662 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1664 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001665 }
1666
Darryl Greenb33cc762019-11-28 14:29:44 +00001667 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001668 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001671 ssl->in_msglen ) );
1672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001674 ssl->in_msg, ssl->in_msglen );
1675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001677
1678 return( 0 );
1679}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001680#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001681
Paul Bakker5121ce52009-01-03 21:22:43 +00001682/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001683 * Fill the input message buffer by appending data to it.
1684 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001685 *
1686 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1687 * available (from this read and/or a previous one). Otherwise, an error code
1688 * is returned (possibly EOF or WANT_READ).
1689 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001690 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1691 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1692 * since we always read a whole datagram at once.
1693 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001694 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001695 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001696 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001698{
Janos Follath865b3eb2019-12-16 11:46:15 +00001699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001700 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001701#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1702 size_t in_buf_len = ssl->in_buf_len;
1703#else
1704 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1705#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001708
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001709 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1710 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001712 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001714 }
1715
Darryl Greenb33cc762019-11-28 14:29:44 +00001716 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001717 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1719 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001720 }
1721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001723 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001724 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001725 uint32_t timeout;
1726
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001727 /* Just to be sure */
1728 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1729 {
1730 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1731 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1732 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1733 }
1734
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001735 /*
1736 * The point is, we need to always read a full datagram at once, so we
1737 * sometimes read more then requested, and handle the additional data.
1738 * It could be the rest of the current record (while fetching the
1739 * header) and/or some other records in the same datagram.
1740 */
1741
1742 /*
1743 * Move to the next record in the already read datagram if applicable
1744 */
1745 if( ssl->next_record_offset != 0 )
1746 {
1747 if( ssl->in_left < ssl->next_record_offset )
1748 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1750 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001751 }
1752
1753 ssl->in_left -= ssl->next_record_offset;
1754
1755 if( ssl->in_left != 0 )
1756 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001758 ssl->next_record_offset ) );
1759 memmove( ssl->in_hdr,
1760 ssl->in_hdr + ssl->next_record_offset,
1761 ssl->in_left );
1762 }
1763
1764 ssl->next_record_offset = 0;
1765 }
1766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001768 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001769
1770 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001771 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001772 */
1773 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001774 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001776 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001777 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001778
1779 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001780 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001781 * are not at the beginning of a new record, the caller did something
1782 * wrong.
1783 */
1784 if( ssl->in_left != 0 )
1785 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1787 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001788 }
1789
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001790 /*
1791 * Don't even try to read if time's out already.
1792 * This avoids by-passing the timer when repeatedly receiving messages
1793 * that will end up being dropped.
1794 */
Hanno Becker7876d122020-02-05 10:39:31 +00001795 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001796 {
1797 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001798 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001799 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001800 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001801 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001802 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001803
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001805 timeout = ssl->handshake->retransmit_timeout;
1806 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001807 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001810
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001811 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001812 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
1813 timeout );
1814 else
1815 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
1816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001818
1819 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001821 }
1822
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001823 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001824 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00001826 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001827
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001829 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001830 if( ssl_double_retransmit_timeout( ssl ) != 0 )
1831 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001833 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001834 }
1835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001836 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001837 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001838 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001839 return( ret );
1840 }
1841
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001842 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001843 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001845 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001847 {
Hanno Becker786300f2020-02-05 10:46:40 +00001848 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001849 {
Hanno Becker786300f2020-02-05 10:46:40 +00001850 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
1851 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001852 return( ret );
1853 }
1854
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001855 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001856 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001858 }
1859
Paul Bakker5121ce52009-01-03 21:22:43 +00001860 if( ret < 0 )
1861 return( ret );
1862
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001863 ssl->in_left = ret;
1864 }
1865 else
1866#endif
1867 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001869 ssl->in_left, nb_want ) );
1870
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001871 while( ssl->in_left < nb_want )
1872 {
1873 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001874
Hanno Becker7876d122020-02-05 10:39:31 +00001875 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001876 ret = MBEDTLS_ERR_SSL_TIMEOUT;
1877 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001878 {
1879 if( ssl->f_recv_timeout != NULL )
1880 {
1881 ret = ssl->f_recv_timeout( ssl->p_bio,
1882 ssl->in_hdr + ssl->in_left, len,
1883 ssl->conf->read_timeout );
1884 }
1885 else
1886 {
1887 ret = ssl->f_recv( ssl->p_bio,
1888 ssl->in_hdr + ssl->in_left, len );
1889 }
1890 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001891
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02001893 ssl->in_left, nb_want ) );
1894 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001895
1896 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898
1899 if( ret < 0 )
1900 return( ret );
1901
mohammad160352aecb92018-03-28 23:41:40 -07001902 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08001903 {
Darryl Green11999bb2018-03-13 15:22:58 +00001904 MBEDTLS_SSL_DEBUG_MSG( 1,
1905 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07001906 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08001907 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1908 }
1909
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001910 ssl->in_left += ret;
1911 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001912 }
1913
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001915
1916 return( 0 );
1917}
1918
1919/*
1920 * Flush any data not yet written
1921 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00001923{
Janos Follath865b3eb2019-12-16 11:46:15 +00001924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01001925 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00001926
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001928
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001929 if( ssl->f_send == NULL )
1930 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001932 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001934 }
1935
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001936 /* Avoid incrementing counter if data is flushed */
1937 if( ssl->out_left == 0 )
1938 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001940 return( 0 );
1941 }
1942
Paul Bakker5121ce52009-01-03 21:22:43 +00001943 while( ssl->out_left > 0 )
1944 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01001946 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001947
Hanno Becker2b1e3542018-08-06 11:19:13 +01001948 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001949 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00001950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00001952
1953 if( ret <= 0 )
1954 return( ret );
1955
mohammad160352aecb92018-03-28 23:41:40 -07001956 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08001957 {
Darryl Green11999bb2018-03-13 15:22:58 +00001958 MBEDTLS_SSL_DEBUG_MSG( 1,
1959 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07001960 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08001961 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1962 }
1963
Paul Bakker5121ce52009-01-03 21:22:43 +00001964 ssl->out_left -= ret;
1965 }
1966
Hanno Becker2b1e3542018-08-06 11:19:13 +01001967#if defined(MBEDTLS_SSL_PROTO_DTLS)
1968 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001969 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01001970 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001971 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01001972 else
1973#endif
1974 {
1975 ssl->out_hdr = ssl->out_buf + 8;
1976 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001977 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001980
1981 return( 0 );
1982}
1983
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001984/*
1985 * Functions to handle the DTLS retransmission state machine
1986 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001988/*
1989 * Append current handshake message to current outgoing flight
1990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001992{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01001994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
1995 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
1996 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02001997
1998 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02001999 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002000 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002003 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002004 }
2005
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002006 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002007 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002008 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002010 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002011 }
2012
2013 /* Copy current handshake message with headers */
2014 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2015 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002016 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002017 msg->next = NULL;
2018
2019 /* Append to the current flight */
2020 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002021 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002022 else
2023 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002025 while( cur->next != NULL )
2026 cur = cur->next;
2027 cur->next = msg;
2028 }
2029
Hanno Becker3b235902018-08-06 09:54:53 +01002030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002031 return( 0 );
2032}
2033
2034/*
2035 * Free the current flight of handshake messages
2036 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002037void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002038{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 mbedtls_ssl_flight_item *cur = flight;
2040 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002041
2042 while( cur != NULL )
2043 {
2044 next = cur->next;
2045
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 mbedtls_free( cur->p );
2047 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002048
2049 cur = next;
2050 }
2051}
2052
2053/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002054 * Swap transform_out and out_ctr with the alternative ones
2055 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002056static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002057{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002059 unsigned char tmp_out_ctr[8];
2060
2061 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2062 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002064 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002065 }
2066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002067 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002068
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002069 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002070 tmp_transform = ssl->transform_out;
2071 ssl->transform_out = ssl->handshake->alt_transform_out;
2072 ssl->handshake->alt_transform_out = tmp_transform;
2073
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002074 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002075 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2076 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002077 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002078
2079 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002080 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2083 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002084 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002085 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2086 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002087 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2089 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002090 }
2091 }
2092#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002093
2094 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002095}
2096
2097/*
2098 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002099 */
2100int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2101{
2102 int ret = 0;
2103
2104 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2105
2106 ret = mbedtls_ssl_flight_transmit( ssl );
2107
2108 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2109
2110 return( ret );
2111}
2112
2113/*
2114 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002115 *
2116 * Need to remember the current message in case flush_output returns
2117 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002118 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002119 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002120int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002121{
Janos Follath865b3eb2019-12-16 11:46:15 +00002122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002123 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002124
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002126 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002128
2129 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002130 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002131 ret = ssl_swap_epochs( ssl );
2132 if( ret != 0 )
2133 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002136 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002137
2138 while( ssl->handshake->cur_msg != NULL )
2139 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002140 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002141 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002142
Hanno Beckere1dcb032018-08-17 16:47:58 +01002143 int const is_finished =
2144 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2145 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2146
Hanno Becker04da1892018-08-14 13:22:10 +01002147 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2148 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2149
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002150 /* Swap epochs before sending Finished: we can't do it after
2151 * sending ChangeCipherSpec, in case write returns WANT_READ.
2152 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002153 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002154 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002155 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002156 ret = ssl_swap_epochs( ssl );
2157 if( ret != 0 )
2158 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002159 }
2160
Hanno Becker67bc7c32018-08-06 11:33:50 +01002161 ret = ssl_get_remaining_payload_in_datagram( ssl );
2162 if( ret < 0 )
2163 return( ret );
2164 max_frag_len = (size_t) ret;
2165
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002166 /* CCS is copied as is, while HS messages may need fragmentation */
2167 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2168 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002169 if( max_frag_len == 0 )
2170 {
2171 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2172 return( ret );
2173
2174 continue;
2175 }
2176
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002177 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002178 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002179 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002180
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002181 /* Update position inside current message */
2182 ssl->handshake->cur_msg_p += cur->len;
2183 }
2184 else
2185 {
2186 const unsigned char * const p = ssl->handshake->cur_msg_p;
2187 const size_t hs_len = cur->len - 12;
2188 const size_t frag_off = p - ( cur->p + 12 );
2189 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002190 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191
Hanno Beckere1dcb032018-08-17 16:47:58 +01002192 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002193 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002194 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002195 {
2196 ret = ssl_swap_epochs( ssl );
2197 if( ret != 0 )
2198 return( ret );
2199 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002200
Hanno Becker67bc7c32018-08-06 11:33:50 +01002201 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2202 return( ret );
2203
2204 continue;
2205 }
2206 max_hs_frag_len = max_frag_len - 12;
2207
2208 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2209 max_hs_frag_len : rem_len;
2210
2211 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002212 {
2213 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002214 (unsigned) cur_hs_frag_len,
2215 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002216 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002217
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002218 /* Messages are stored with handshake headers as if not fragmented,
2219 * copy beginning of headers then fill fragmentation fields.
2220 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2221 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002222
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002223 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2224 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2225 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2226
Hanno Becker67bc7c32018-08-06 11:33:50 +01002227 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2228 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2229 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002230
2231 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2232
Hanno Becker3f7b9732018-08-28 09:53:25 +01002233 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002234 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2235 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002236 ssl->out_msgtype = cur->type;
2237
2238 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002239 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002240 }
2241
2242 /* If done with the current message move to the next one if any */
2243 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2244 {
2245 if( cur->next != NULL )
2246 {
2247 ssl->handshake->cur_msg = cur->next;
2248 ssl->handshake->cur_msg_p = cur->next->p + 12;
2249 }
2250 else
2251 {
2252 ssl->handshake->cur_msg = NULL;
2253 ssl->handshake->cur_msg_p = NULL;
2254 }
2255 }
2256
2257 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002258 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002261 return( ret );
2262 }
2263 }
2264
Hanno Becker67bc7c32018-08-06 11:33:50 +01002265 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2266 return( ret );
2267
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002268 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2270 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002271 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002272 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002274 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002275 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002276
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002278
2279 return( 0 );
2280}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002281
2282/*
2283 * To be called when the last message of an incoming flight is received.
2284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002286{
2287 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002288 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002289 ssl->handshake->flight = NULL;
2290 ssl->handshake->cur_msg = NULL;
2291
2292 /* The next incoming flight will start with this msg_seq */
2293 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2294
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002295 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002296 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002297
Hanno Becker0271f962018-08-16 13:23:47 +01002298 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002299 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002300
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002301 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002302 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2305 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002306 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002308 }
2309 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002311}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002312
2313/*
2314 * To be called when the last message of an outgoing flight is send.
2315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002317{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002318 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002319 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2322 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002323 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002325 }
2326 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002328}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002329#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002330
Paul Bakker5121ce52009-01-03 21:22:43 +00002331/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002332 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002333 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002334
2335/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002336 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002337 *
2338 * - fill in handshake headers
2339 * - update handshake checksum
2340 * - DTLS: save message for resending
2341 * - then pass to the record layer
2342 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002343 * DTLS: except for HelloRequest, messages are only queued, and will only be
2344 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002345 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002346 * Inputs:
2347 * - ssl->out_msglen: 4 + actual handshake message len
2348 * (4 is the size of handshake headers for TLS)
2349 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2350 * - ssl->out_msg + 4: the handshake message body
2351 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002352 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002353 * - ssl->out_msglen: the length of the record contents
2354 * (including handshake headers but excluding record headers)
2355 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002356 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002357int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002358{
Janos Follath865b3eb2019-12-16 11:46:15 +00002359 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002360 const size_t hs_len = ssl->out_msglen - 4;
2361 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002362
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002363 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2364
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002365 /*
2366 * Sanity checks
2367 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002368 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002369 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2370 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002371 /* In SSLv3, the client might send a NoCertificate alert. */
2372#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2373 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2374 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2375 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2376#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2377 {
2378 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2379 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2380 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002381 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002382
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002383 /* Whenever we send anything different from a
2384 * HelloRequest we should be in a handshake - double check. */
2385 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2386 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002387 ssl->handshake == NULL )
2388 {
2389 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2390 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2391 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002394 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002395 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002397 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002398 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2399 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002400 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002401#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002402
Hanno Beckerb50a2532018-08-06 11:52:54 +01002403 /* Double-check that we did not exceed the bounds
2404 * of the outgoing record buffer.
2405 * This should never fail as the various message
2406 * writing functions must obey the bounds of the
2407 * outgoing record buffer, but better be safe.
2408 *
2409 * Note: We deliberately do not check for the MTU or MFL here.
2410 */
2411 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2412 {
2413 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2414 "size %u, maximum %u",
2415 (unsigned) ssl->out_msglen,
2416 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2417 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2418 }
2419
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002420 /*
2421 * Fill handshake headers
2422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002425 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2426 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2427 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002428
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002429 /*
2430 * DTLS has additional fields in the Handshake layer,
2431 * between the length field and the actual payload:
2432 * uint16 message_seq;
2433 * uint24 fragment_offset;
2434 * uint24 fragment_length;
2435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002437 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002438 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002439 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002440 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002441 {
2442 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2443 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002444 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002445 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002446 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2447 }
2448
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002449 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002450 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002451
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002452 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002453 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002454 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002455 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2456 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2457 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002458 }
2459 else
2460 {
2461 ssl->out_msg[4] = 0;
2462 ssl->out_msg[5] = 0;
2463 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002464
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002465 /* Handshake hashes are computed without fragmentation,
2466 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002467 memset( ssl->out_msg + 6, 0x00, 3 );
2468 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002469 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002471
Hanno Becker0207e532018-08-28 10:28:28 +01002472 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002473 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2474 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002475 }
2476
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002477 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002479 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002480 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2481 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002482 {
2483 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2484 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486 return( ret );
2487 }
2488 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002489 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002490#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002491 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002492 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002493 {
2494 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2495 return( ret );
2496 }
2497 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002498
2499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2500
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002501 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002502}
2503
2504/*
2505 * Record layer functions
2506 */
2507
2508/*
2509 * Write current record.
2510 *
2511 * Uses:
2512 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2513 * - ssl->out_msglen: length of the record content (excl headers)
2514 * - ssl->out_msg: record content
2515 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002516int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002517{
2518 int ret, done = 0;
2519 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002520 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002521
2522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002525 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002527 {
2528 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2529 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002531 return( ret );
2532 }
2533
2534 len = ssl->out_msglen;
2535 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2539 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002540 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 ret = mbedtls_ssl_hw_record_write( ssl );
2544 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002545 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002546 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2547 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002548 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002549
2550 if( ret == 0 )
2551 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002552 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002554 if( !done )
2555 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002556 unsigned i;
2557 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002558#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2559 size_t out_buf_len = ssl->out_buf_len;
2560#else
2561 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2562#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002563 /* Skip writing the record content type to after the encryption,
2564 * as it may change when using the CID extension. */
2565
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002567 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002568
Hanno Becker19859472018-08-06 09:40:20 +01002569 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002570 ssl->out_len[0] = (unsigned char)( len >> 8 );
2571 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002572
Paul Bakker48916f92012-09-16 19:57:18 +00002573 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002574 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002575 mbedtls_record rec;
2576
2577 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002578 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002579 rec.data_len = ssl->out_msglen;
2580 rec.data_offset = ssl->out_msg - rec.buf;
2581
2582 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2583 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2584 ssl->conf->transport, rec.ver );
2585 rec.type = ssl->out_msgtype;
2586
Hanno Beckera0e20d02019-05-15 14:03:01 +01002587#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002588 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002589 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002590#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002591
Hanno Beckera18d1322018-01-03 14:27:32 +00002592 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002593 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002594 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002596 return( ret );
2597 }
2598
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002599 if( rec.data_offset != 0 )
2600 {
2601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2603 }
2604
Hanno Becker6430faf2019-05-08 11:57:13 +01002605 /* Update the record content type and CID. */
2606 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002607#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002608 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002609#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002610 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002611 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2612 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002613 }
2614
Hanno Becker5903de42019-05-03 14:46:38 +01002615 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002616
2617#if defined(MBEDTLS_SSL_PROTO_DTLS)
2618 /* In case of DTLS, double-check that we don't exceed
2619 * the remaining space in the datagram. */
2620 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2621 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002622 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002623 if( ret < 0 )
2624 return( ret );
2625
2626 if( protected_record_size > (size_t) ret )
2627 {
2628 /* Should never happen */
2629 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2630 }
2631 }
2632#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002633
Hanno Becker6430faf2019-05-08 11:57:13 +01002634 /* Now write the potentially updated record content type. */
2635 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002638 "version = [%d:%d], msglen = %d",
2639 ssl->out_hdr[0], ssl->out_hdr[1],
2640 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002643 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002644
2645 ssl->out_left += protected_record_size;
2646 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002647 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002648
Hanno Beckerdd772292020-02-05 10:38:31 +00002649 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002650 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2651 break;
2652
2653 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002654 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002655 {
2656 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2657 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2658 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002659 }
2660
Hanno Becker67bc7c32018-08-06 11:33:50 +01002661#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002662 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2663 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002664 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002665 size_t remaining;
2666 ret = ssl_get_remaining_payload_in_datagram( ssl );
2667 if( ret < 0 )
2668 {
2669 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2670 ret );
2671 return( ret );
2672 }
2673
2674 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002675 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002676 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002677 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002678 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002679 else
2680 {
Hanno Becker513815a2018-08-20 11:56:09 +01002681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002682 }
2683 }
2684#endif /* MBEDTLS_SSL_PROTO_DTLS */
2685
2686 if( ( flush == SSL_FORCE_FLUSH ) &&
2687 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002688 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002690 return( ret );
2691 }
2692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002694
2695 return( 0 );
2696}
2697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002699
2700static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2701{
2702 if( ssl->in_msglen < ssl->in_hslen ||
2703 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2704 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2705 {
2706 return( 1 );
2707 }
2708 return( 0 );
2709}
Hanno Becker44650b72018-08-16 12:51:11 +01002710
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002711static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002712{
2713 return( ( ssl->in_msg[9] << 16 ) |
2714 ( ssl->in_msg[10] << 8 ) |
2715 ssl->in_msg[11] );
2716}
2717
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002718static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002719{
2720 return( ( ssl->in_msg[6] << 16 ) |
2721 ( ssl->in_msg[7] << 8 ) |
2722 ssl->in_msg[8] );
2723}
2724
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002725static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002726{
2727 uint32_t msg_len, frag_off, frag_len;
2728
2729 msg_len = ssl_get_hs_total_len( ssl );
2730 frag_off = ssl_get_hs_frag_off( ssl );
2731 frag_len = ssl_get_hs_frag_len( ssl );
2732
2733 if( frag_off > msg_len )
2734 return( -1 );
2735
2736 if( frag_len > msg_len - frag_off )
2737 return( -1 );
2738
2739 if( frag_len + 12 > ssl->in_msglen )
2740 return( -1 );
2741
2742 return( 0 );
2743}
2744
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002745/*
2746 * Mark bits in bitmask (used for DTLS HS reassembly)
2747 */
2748static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2749{
2750 unsigned int start_bits, end_bits;
2751
2752 start_bits = 8 - ( offset % 8 );
2753 if( start_bits != 8 )
2754 {
2755 size_t first_byte_idx = offset / 8;
2756
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002757 /* Special case */
2758 if( len <= start_bits )
2759 {
2760 for( ; len != 0; len-- )
2761 mask[first_byte_idx] |= 1 << ( start_bits - len );
2762
2763 /* Avoid potential issues with offset or len becoming invalid */
2764 return;
2765 }
2766
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002767 offset += start_bits; /* Now offset % 8 == 0 */
2768 len -= start_bits;
2769
2770 for( ; start_bits != 0; start_bits-- )
2771 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2772 }
2773
2774 end_bits = len % 8;
2775 if( end_bits != 0 )
2776 {
2777 size_t last_byte_idx = ( offset + len ) / 8;
2778
2779 len -= end_bits; /* Now len % 8 == 0 */
2780
2781 for( ; end_bits != 0; end_bits-- )
2782 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2783 }
2784
2785 memset( mask + offset / 8, 0xFF, len / 8 );
2786}
2787
2788/*
2789 * Check that bitmask is full
2790 */
2791static int ssl_bitmask_check( unsigned char *mask, size_t len )
2792{
2793 size_t i;
2794
2795 for( i = 0; i < len / 8; i++ )
2796 if( mask[i] != 0xFF )
2797 return( -1 );
2798
2799 for( i = 0; i < len % 8; i++ )
2800 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2801 return( -1 );
2802
2803 return( 0 );
2804}
2805
Hanno Becker56e205e2018-08-16 09:06:12 +01002806/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01002807static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002808 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002809{
Hanno Becker56e205e2018-08-16 09:06:12 +01002810 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002811
Hanno Becker56e205e2018-08-16 09:06:12 +01002812 alloc_len = 12; /* Handshake header */
2813 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002814
Hanno Beckerd07df862018-08-16 09:14:58 +01002815 if( add_bitmap )
2816 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002817
Hanno Becker2a97b0e2018-08-21 15:47:49 +01002818 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002819}
Hanno Becker56e205e2018-08-16 09:06:12 +01002820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002822
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002823static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01002824{
2825 return( ( ssl->in_msg[1] << 16 ) |
2826 ( ssl->in_msg[2] << 8 ) |
2827 ssl->in_msg[3] );
2828}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002829
Simon Butcher99000142016-10-13 17:21:01 +01002830int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002831{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002833 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002835 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002837 }
2838
Hanno Becker12555c62018-08-16 12:47:53 +01002839 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002841 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002842 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002843 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002844
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002846 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002847 {
Janos Follath865b3eb2019-12-16 11:46:15 +00002848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002849 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002850
Hanno Becker44650b72018-08-16 12:51:11 +01002851 if( ssl_check_hs_header( ssl ) != 0 )
2852 {
2853 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
2854 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
2855 }
2856
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002857 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01002858 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
2859 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
2860 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
2861 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002862 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01002863 if( recv_msg_seq > ssl->handshake->in_msg_seq )
2864 {
2865 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
2866 recv_msg_seq,
2867 ssl->handshake->in_msg_seq ) );
2868 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
2869 }
2870
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002871 /* Retransmit only on last message from previous flight, to avoid
2872 * too many retransmissions.
2873 * Besides, No sane server ever retransmits HelloVerifyRequest */
2874 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002876 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002878 "message_seq = %d, start_of_flight = %d",
2879 recv_msg_seq,
2880 ssl->handshake->in_flight_start_seq ) );
2881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002883 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002885 return( ret );
2886 }
2887 }
2888 else
2889 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002891 "message_seq = %d, expected = %d",
2892 recv_msg_seq,
2893 ssl->handshake->in_msg_seq ) );
2894 }
2895
Hanno Becker90333da2017-10-10 11:27:13 +01002896 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002897 }
2898 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002899
Hanno Becker6d97ef52018-08-16 13:09:04 +01002900 /* Message reassembly is handled alongside buffering of future
2901 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01002902 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01002903 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01002904 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002905 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01002907 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002908 }
2909 }
2910 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002912 /* With TLS we don't handle fragmentation (for now) */
2913 if( ssl->in_msglen < ssl->in_hslen )
2914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
2916 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002917 }
2918
Simon Butcher99000142016-10-13 17:21:01 +01002919 return( 0 );
2920}
2921
2922void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
2923{
Hanno Becker0271f962018-08-16 13:23:47 +01002924 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01002925
Hanno Becker0271f962018-08-16 13:23:47 +01002926 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002927 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002928 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02002929 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002930
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002931 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002933 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002934 ssl->handshake != NULL )
2935 {
Hanno Becker0271f962018-08-16 13:23:47 +01002936 unsigned offset;
2937 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002938
Hanno Becker0271f962018-08-16 13:23:47 +01002939 /* Increment handshake sequence number */
2940 hs->in_msg_seq++;
2941
2942 /*
2943 * Clear up handshake buffering and reassembly structure.
2944 */
2945
2946 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01002947 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01002948
2949 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01002950 for( offset = 0, hs_buf = &hs->buffering.hs[0];
2951 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01002952 offset++, hs_buf++ )
2953 {
2954 *hs_buf = *(hs_buf + 1);
2955 }
2956
2957 /* Create a fresh last entry */
2958 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02002959 }
2960#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002961}
2962
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02002963/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002964 * DTLS anti-replay: RFC 6347 4.1.2.6
2965 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02002966 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
2967 * Bit n is set iff record number in_window_top - n has been seen.
2968 *
2969 * Usually, in_window_top is the last record number seen and the lsb of
2970 * in_window is set. The only exception is the initial state (record number 0
2971 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00002974void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02002975{
2976 ssl->in_window_top = 0;
2977 ssl->in_window = 0;
2978}
2979
2980static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
2981{
2982 return( ( (uint64_t) buf[0] << 40 ) |
2983 ( (uint64_t) buf[1] << 32 ) |
2984 ( (uint64_t) buf[2] << 24 ) |
2985 ( (uint64_t) buf[3] << 16 ) |
2986 ( (uint64_t) buf[4] << 8 ) |
2987 ( (uint64_t) buf[5] ) );
2988}
2989
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002990static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
2991{
Janos Follath865b3eb2019-12-16 11:46:15 +00002992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02002993 unsigned char *original_in_ctr;
2994
2995 // save original in_ctr
2996 original_in_ctr = ssl->in_ctr;
2997
2998 // use counter from record
2999 ssl->in_ctr = record_in_ctr;
3000
3001 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3002
3003 // restore the counter
3004 ssl->in_ctr = original_in_ctr;
3005
3006 return ret;
3007}
3008
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003009/*
3010 * Return 0 if sequence number is acceptable, -1 otherwise
3011 */
Hanno Becker0183d692019-07-12 08:50:37 +01003012int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003013{
3014 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3015 uint64_t bit;
3016
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003017 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003018 return( 0 );
3019
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003020 if( rec_seqnum > ssl->in_window_top )
3021 return( 0 );
3022
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003023 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003024
3025 if( bit >= 64 )
3026 return( -1 );
3027
3028 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3029 return( -1 );
3030
3031 return( 0 );
3032}
3033
3034/*
3035 * Update replay window on new validated record
3036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003038{
3039 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3040
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003041 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003042 return;
3043
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003044 if( rec_seqnum > ssl->in_window_top )
3045 {
3046 /* Update window_top and the contents of the window */
3047 uint64_t shift = rec_seqnum - ssl->in_window_top;
3048
3049 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003050 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003051 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003052 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003053 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003054 ssl->in_window |= 1;
3055 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003056
3057 ssl->in_window_top = rec_seqnum;
3058 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003059 else
3060 {
3061 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003062 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003063
3064 if( bit < 64 ) /* Always true, but be extra sure */
3065 ssl->in_window |= (uint64_t) 1 << bit;
3066 }
3067}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003069
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003070#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003071/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003072 * Without any SSL context, check if a datagram looks like a ClientHello with
3073 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003074 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003075 *
3076 * - if cookie is valid, return 0
3077 * - if ClientHello looks superficially valid but cookie is not,
3078 * fill obuf and set olen, then
3079 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3080 * - otherwise return a specific error code
3081 */
3082static int ssl_check_dtls_clihlo_cookie(
3083 mbedtls_ssl_cookie_write_t *f_cookie_write,
3084 mbedtls_ssl_cookie_check_t *f_cookie_check,
3085 void *p_cookie,
3086 const unsigned char *cli_id, size_t cli_id_len,
3087 const unsigned char *in, size_t in_len,
3088 unsigned char *obuf, size_t buf_len, size_t *olen )
3089{
3090 size_t sid_len, cookie_len;
3091 unsigned char *p;
3092
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003093 /*
3094 * Structure of ClientHello with record and handshake headers,
3095 * and expected values. We don't need to check a lot, more checks will be
3096 * done when actually parsing the ClientHello - skipping those checks
3097 * avoids code duplication and does not make cookie forging any easier.
3098 *
3099 * 0-0 ContentType type; copied, must be handshake
3100 * 1-2 ProtocolVersion version; copied
3101 * 3-4 uint16 epoch; copied, must be 0
3102 * 5-10 uint48 sequence_number; copied
3103 * 11-12 uint16 length; (ignored)
3104 *
3105 * 13-13 HandshakeType msg_type; (ignored)
3106 * 14-16 uint24 length; (ignored)
3107 * 17-18 uint16 message_seq; copied
3108 * 19-21 uint24 fragment_offset; copied, must be 0
3109 * 22-24 uint24 fragment_length; (ignored)
3110 *
3111 * 25-26 ProtocolVersion client_version; (ignored)
3112 * 27-58 Random random; (ignored)
3113 * 59-xx SessionID session_id; 1 byte len + sid_len content
3114 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3115 * ...
3116 *
3117 * Minimum length is 61 bytes.
3118 */
3119 if( in_len < 61 ||
3120 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3121 in[3] != 0 || in[4] != 0 ||
3122 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3123 {
3124 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3125 }
3126
3127 sid_len = in[59];
3128 if( sid_len > in_len - 61 )
3129 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3130
3131 cookie_len = in[60 + sid_len];
3132 if( cookie_len > in_len - 60 )
3133 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3134
3135 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3136 cli_id, cli_id_len ) == 0 )
3137 {
3138 /* Valid cookie */
3139 return( 0 );
3140 }
3141
3142 /*
3143 * If we get here, we've got an invalid cookie, let's prepare HVR.
3144 *
3145 * 0-0 ContentType type; copied
3146 * 1-2 ProtocolVersion version; copied
3147 * 3-4 uint16 epoch; copied
3148 * 5-10 uint48 sequence_number; copied
3149 * 11-12 uint16 length; olen - 13
3150 *
3151 * 13-13 HandshakeType msg_type; hello_verify_request
3152 * 14-16 uint24 length; olen - 25
3153 * 17-18 uint16 message_seq; copied
3154 * 19-21 uint24 fragment_offset; copied
3155 * 22-24 uint24 fragment_length; olen - 25
3156 *
3157 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3158 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3159 *
3160 * Minimum length is 28.
3161 */
3162 if( buf_len < 28 )
3163 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3164
3165 /* Copy most fields and adapt others */
3166 memcpy( obuf, in, 25 );
3167 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3168 obuf[25] = 0xfe;
3169 obuf[26] = 0xff;
3170
3171 /* Generate and write actual cookie */
3172 p = obuf + 28;
3173 if( f_cookie_write( p_cookie,
3174 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3175 {
3176 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3177 }
3178
3179 *olen = p - obuf;
3180
3181 /* Go back and fill length fields */
3182 obuf[27] = (unsigned char)( *olen - 28 );
3183
3184 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3185 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3186 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3187
3188 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3189 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3190
3191 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3192}
3193
3194/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003195 * Handle possible client reconnect with the same UDP quadruplet
3196 * (RFC 6347 Section 4.2.8).
3197 *
3198 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3199 * that looks like a ClientHello.
3200 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003201 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003202 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003203 * - if the input looks like a ClientHello with a valid cookie,
3204 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003205 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003206 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003207 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003208 * This function is called (through ssl_check_client_reconnect()) when an
3209 * unexpected record is found in ssl_get_next_record(), which will discard the
3210 * record if we return 0, and bubble up the return value otherwise (this
3211 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3212 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003213 */
3214static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3215{
Janos Follath865b3eb2019-12-16 11:46:15 +00003216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003217 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003218
Hanno Becker2fddd372019-07-10 14:37:41 +01003219 if( ssl->conf->f_cookie_write == NULL ||
3220 ssl->conf->f_cookie_check == NULL )
3221 {
3222 /* If we can't use cookies to verify reachability of the peer,
3223 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003224 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3225 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003226 return( 0 );
3227 }
3228
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003229 ret = ssl_check_dtls_clihlo_cookie(
3230 ssl->conf->f_cookie_write,
3231 ssl->conf->f_cookie_check,
3232 ssl->conf->p_cookie,
3233 ssl->cli_id, ssl->cli_id_len,
3234 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003235 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003236
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003237 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3238
3239 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003240 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003241 int send_ret;
3242 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3243 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3244 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003245 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003246 * If the error is permanent we'll catch it later,
3247 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003248 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3249 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3250 (void) send_ret;
3251
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003252 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003253 }
3254
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003255 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003256 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003257 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003258 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003259 {
3260 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3261 return( ret );
3262 }
3263
3264 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003265 }
3266
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003267 return( ret );
3268}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003269#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003270
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003271static int ssl_check_record_type( uint8_t record_type )
3272{
3273 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3274 record_type != MBEDTLS_SSL_MSG_ALERT &&
3275 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3276 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3277 {
3278 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3279 }
3280
3281 return( 0 );
3282}
3283
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003284/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003285 * ContentType type;
3286 * ProtocolVersion version;
3287 * uint16 epoch; // DTLS only
3288 * uint48 sequence_number; // DTLS only
3289 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003290 *
3291 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003292 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003293 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3294 *
3295 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003296 * 1. proceed with the record if this function returns 0
3297 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3298 * 3. return CLIENT_RECONNECT if this function return that value
3299 * 4. drop the whole datagram if this function returns anything else.
3300 * Point 2 is needed when the peer is resending, and we have already received
3301 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003302 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003303static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003304 unsigned char *buf,
3305 size_t len,
3306 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003307{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003308 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003309
Hanno Beckere5e7e782019-07-11 12:29:35 +01003310 size_t const rec_hdr_type_offset = 0;
3311 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003312
Hanno Beckere5e7e782019-07-11 12:29:35 +01003313 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3314 rec_hdr_type_len;
3315 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Hanno Beckere5e7e782019-07-11 12:29:35 +01003317 size_t const rec_hdr_ctr_len = 8;
3318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003319 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003320 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3321 rec_hdr_version_len;
3322
Hanno Beckera0e20d02019-05-15 14:03:01 +01003323#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003324 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3325 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003326 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003327#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3328#endif /* MBEDTLS_SSL_PROTO_DTLS */
3329
3330 size_t rec_hdr_len_offset; /* To be determined */
3331 size_t const rec_hdr_len_len = 2;
3332
3333 /*
3334 * Check minimum lengths for record header.
3335 */
3336
3337#if defined(MBEDTLS_SSL_PROTO_DTLS)
3338 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3339 {
3340 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3341 }
3342 else
3343#endif /* MBEDTLS_SSL_PROTO_DTLS */
3344 {
3345 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3346 }
3347
3348 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3349 {
3350 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3351 (unsigned) len,
3352 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3353 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3354 }
3355
3356 /*
3357 * Parse and validate record content type
3358 */
3359
3360 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003361
3362 /* Check record content type */
3363#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3364 rec->cid_len = 0;
3365
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003366 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003367 ssl->conf->cid_len != 0 &&
3368 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003369 {
3370 /* Shift pointers to account for record header including CID
3371 * struct {
3372 * ContentType special_type = tls12_cid;
3373 * ProtocolVersion version;
3374 * uint16 epoch;
3375 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003376 * opaque cid[cid_length]; // Additional field compared to
3377 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003378 * uint16 length;
3379 * opaque enc_content[DTLSCiphertext.length];
3380 * } DTLSCiphertext;
3381 */
3382
3383 /* So far, we only support static CID lengths
3384 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003385 rec_hdr_cid_len = ssl->conf->cid_len;
3386 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003387
Hanno Beckere5e7e782019-07-11 12:29:35 +01003388 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003389 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3391 (unsigned) len,
3392 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003393 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003394 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003395
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003396 /* configured CID len is guaranteed at most 255, see
3397 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3398 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003399 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003400 }
3401 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003402#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003403 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003404 if( ssl_check_record_type( rec->type ) )
3405 {
Hanno Becker54229812019-07-12 14:40:00 +01003406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3407 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003408 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3409 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003410 }
3411
Hanno Beckere5e7e782019-07-11 12:29:35 +01003412 /*
3413 * Parse and validate record version
3414 */
3415
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003416 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3417 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003418 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3419 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003420 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003421
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003422 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003423 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3425 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003426 }
3427
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003428 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3431 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003432 }
3433
Hanno Beckere5e7e782019-07-11 12:29:35 +01003434 /*
3435 * Parse/Copy record sequence number.
3436 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003437
Hanno Beckere5e7e782019-07-11 12:29:35 +01003438#if defined(MBEDTLS_SSL_PROTO_DTLS)
3439 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003440 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003441 /* Copy explicit record sequence number from input buffer. */
3442 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3443 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003444 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003445 else
3446#endif /* MBEDTLS_SSL_PROTO_DTLS */
3447 {
3448 /* Copy implicit record sequence number from SSL context structure. */
3449 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3450 }
Paul Bakker40e46942009-01-03 21:51:57 +00003451
Hanno Beckere5e7e782019-07-11 12:29:35 +01003452 /*
3453 * Parse record length.
3454 */
3455
Hanno Beckere5e7e782019-07-11 12:29:35 +01003456 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003457 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3458 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003459 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003460
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003461 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003462 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003463 rec->type,
3464 major_ver, minor_ver, rec->data_len ) );
3465
3466 rec->buf = buf;
3467 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003468
Hanno Beckerd417cc92019-07-26 08:20:27 +01003469 if( rec->data_len == 0 )
3470 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003471
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003472 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003473 * DTLS-related tests.
3474 * Check epoch before checking length constraint because
3475 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3476 * message gets duplicated before the corresponding Finished message,
3477 * the second ChangeCipherSpec should be discarded because it belongs
3478 * to an old epoch, but not because its length is shorter than
3479 * the minimum record length for packets using the new record transform.
3480 * Note that these two kinds of failures are handled differently,
3481 * as an unexpected record is silently skipped but an invalid
3482 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003483 */
3484#if defined(MBEDTLS_SSL_PROTO_DTLS)
3485 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3486 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003487 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003488
Hanno Becker955a5c92019-07-10 17:12:07 +01003489 /* Check that the datagram is large enough to contain a record
3490 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003491 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003492 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003493 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3494 (unsigned) len,
3495 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003496 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3497 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003498
Hanno Becker37cfe732019-07-10 17:20:01 +01003499 /* Records from other, non-matching epochs are silently discarded.
3500 * (The case of same-port Client reconnects must be considered in
3501 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003502 if( rec_epoch != ssl->in_epoch )
3503 {
3504 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3505 "expected %d, received %d",
3506 ssl->in_epoch, rec_epoch ) );
3507
Hanno Becker552f7472019-07-19 10:59:12 +01003508 /* Records from the next epoch are considered for buffering
3509 * (concretely: early Finished messages). */
3510 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003511 {
Hanno Becker552f7472019-07-19 10:59:12 +01003512 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3513 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003514 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003515
Hanno Becker2fddd372019-07-10 14:37:41 +01003516 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003517 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003518#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003519 /* For records from the correct epoch, check whether their
3520 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003521 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3522 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003523 {
3524 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3525 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3526 }
3527#endif
3528 }
3529#endif /* MBEDTLS_SSL_PROTO_DTLS */
3530
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003531 return( 0 );
3532}
Paul Bakker5121ce52009-01-03 21:22:43 +00003533
Paul Bakker5121ce52009-01-03 21:22:43 +00003534
Hanno Becker2fddd372019-07-10 14:37:41 +01003535#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3536static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3537{
3538 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3539
3540 /*
3541 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3542 * access the first byte of record content (handshake type), as we
3543 * have an active transform (possibly iv_len != 0), so use the
3544 * fact that the record header len is 13 instead.
3545 */
3546 if( rec_epoch == 0 &&
3547 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3548 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3549 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3550 ssl->in_left > 13 &&
3551 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3552 {
3553 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3554 "from the same port" ) );
3555 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003556 }
3557
3558 return( 0 );
3559}
Hanno Becker2fddd372019-07-10 14:37:41 +01003560#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003561
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003562/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003563 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003564 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003565static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3566 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003567{
3568 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003571 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3574 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003575 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003577
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578 ret = mbedtls_ssl_hw_record_read( ssl );
3579 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003580 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3582 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003583 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003584
3585 if( ret == 0 )
3586 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003587 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003589 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003590 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003591 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003592
Hanno Beckera18d1322018-01-03 14:27:32 +00003593 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003594 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003595 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003597
Hanno Beckera0e20d02019-05-15 14:03:01 +01003598#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003599 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3600 ssl->conf->ignore_unexpected_cid
3601 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3602 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003603 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003604 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003605 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003606#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003607
Paul Bakker5121ce52009-01-03 21:22:43 +00003608 return( ret );
3609 }
3610
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003611 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003612 {
3613 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003614 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003615 }
3616
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003617 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003618 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003619
Hanno Beckera0e20d02019-05-15 14:03:01 +01003620#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003621 /* We have already checked the record content type
3622 * in ssl_parse_record_header(), failing or silently
3623 * dropping the record in the case of an unknown type.
3624 *
3625 * Since with the use of CIDs, the record content type
3626 * might change during decryption, re-check the record
3627 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003628 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003629 {
3630 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3631 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3632 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003633#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003634
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003635 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003636 {
3637#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3638 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003639 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003640 {
3641 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3642 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3643 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3644 }
3645#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3646
3647 ssl->nb_zero++;
3648
3649 /*
3650 * Three or more empty messages may be a DoS attack
3651 * (excessive CPU consumption).
3652 */
3653 if( ssl->nb_zero > 3 )
3654 {
3655 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003656 "messages, possible DoS attack" ) );
3657 /* Treat the records as if they were not properly authenticated,
3658 * thereby failing the connection if we see more than allowed
3659 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003660 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3661 }
3662 }
3663 else
3664 ssl->nb_zero = 0;
3665
3666#if defined(MBEDTLS_SSL_PROTO_DTLS)
3667 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3668 {
3669 ; /* in_ctr read from peer, not maintained internally */
3670 }
3671 else
3672#endif
3673 {
3674 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003675 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003676 if( ++ssl->in_ctr[i - 1] != 0 )
3677 break;
3678
3679 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003680 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003681 {
3682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3683 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3684 }
3685 }
3686
Paul Bakker5121ce52009-01-03 21:22:43 +00003687 }
3688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003690 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003691 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003692 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003693 }
3694#endif
3695
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003696 /* Check actual (decrypted) record content length against
3697 * configured maximum. */
3698 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3699 {
3700 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3701 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3702 }
3703
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003704 return( 0 );
3705}
3706
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003707/*
3708 * Read a record.
3709 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003710 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3711 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3712 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003713 */
Hanno Becker1097b342018-08-15 14:09:41 +01003714
3715/* Helper functions for mbedtls_ssl_read_record(). */
3716static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003717static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3718static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003719
Hanno Becker327c93b2018-08-15 13:56:18 +01003720int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003721 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003722{
Janos Follath865b3eb2019-12-16 11:46:15 +00003723 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003724
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003726
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003727 if( ssl->keep_current_message == 0 )
3728 {
3729 do {
Simon Butcher99000142016-10-13 17:21:01 +01003730
Hanno Becker26994592018-08-15 14:14:59 +01003731 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003732 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003733 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003734
Hanno Beckere74d5562018-08-15 14:26:08 +01003735 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003736 {
Hanno Becker40f50842018-08-15 14:48:01 +01003737#if defined(MBEDTLS_SSL_PROTO_DTLS)
3738 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003739
Hanno Becker40f50842018-08-15 14:48:01 +01003740 /* We only check for buffered messages if the
3741 * current datagram is fully consumed. */
3742 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003743 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003744 {
Hanno Becker40f50842018-08-15 14:48:01 +01003745 if( ssl_load_buffered_message( ssl ) == 0 )
3746 have_buffered = 1;
3747 }
3748
3749 if( have_buffered == 0 )
3750#endif /* MBEDTLS_SSL_PROTO_DTLS */
3751 {
3752 ret = ssl_get_next_record( ssl );
3753 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3754 continue;
3755
3756 if( ret != 0 )
3757 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003758 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003759 return( ret );
3760 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003761 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003762 }
3763
3764 ret = mbedtls_ssl_handle_message_type( ssl );
3765
Hanno Becker40f50842018-08-15 14:48:01 +01003766#if defined(MBEDTLS_SSL_PROTO_DTLS)
3767 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3768 {
3769 /* Buffer future message */
3770 ret = ssl_buffer_message( ssl );
3771 if( ret != 0 )
3772 return( ret );
3773
3774 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3775 }
3776#endif /* MBEDTLS_SSL_PROTO_DTLS */
3777
Hanno Becker90333da2017-10-10 11:27:13 +01003778 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3779 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003780
3781 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003782 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003783 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003784 return( ret );
3785 }
3786
Hanno Becker327c93b2018-08-15 13:56:18 +01003787 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003788 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003789 {
3790 mbedtls_ssl_update_handshake_status( ssl );
3791 }
Simon Butcher99000142016-10-13 17:21:01 +01003792 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003793 else
Simon Butcher99000142016-10-13 17:21:01 +01003794 {
Hanno Becker02f59072018-08-15 14:00:24 +01003795 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003796 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003797 }
3798
3799 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3800
3801 return( 0 );
3802}
3803
Hanno Becker40f50842018-08-15 14:48:01 +01003804#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003805static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01003806{
Hanno Becker40f50842018-08-15 14:48:01 +01003807 if( ssl->in_left > ssl->next_record_offset )
3808 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01003809
Hanno Becker40f50842018-08-15 14:48:01 +01003810 return( 0 );
3811}
3812
3813static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
3814{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003815 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01003816 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003817 int ret = 0;
3818
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003819 if( hs == NULL )
3820 return( -1 );
3821
Hanno Beckere00ae372018-08-20 09:39:42 +01003822 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
3823
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003824 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3825 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
3826 {
3827 /* Check if we have seen a ChangeCipherSpec before.
3828 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01003829 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003830 {
3831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
3832 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003833 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003834 }
3835
Hanno Becker39b8bc92018-08-28 17:17:13 +01003836 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003837 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3838 ssl->in_msglen = 1;
3839 ssl->in_msg[0] = 1;
3840
3841 /* As long as they are equal, the exact value doesn't matter. */
3842 ssl->in_left = 0;
3843 ssl->next_record_offset = 0;
3844
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003845 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003846 goto exit;
3847 }
Hanno Becker37f95322018-08-16 13:55:32 +01003848
Hanno Beckerb8f50142018-08-28 10:01:34 +01003849#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01003850 /* Debug only */
3851 {
3852 unsigned offset;
3853 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
3854 {
3855 hs_buf = &hs->buffering.hs[offset];
3856 if( hs_buf->is_valid == 1 )
3857 {
3858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
3859 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01003860 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01003861 }
3862 }
3863 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01003864#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01003865
3866 /* Check if we have buffered and/or fully reassembled the
3867 * next handshake message. */
3868 hs_buf = &hs->buffering.hs[0];
3869 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
3870 {
3871 /* Synthesize a record containing the buffered HS message. */
3872 size_t msg_len = ( hs_buf->data[1] << 16 ) |
3873 ( hs_buf->data[2] << 8 ) |
3874 hs_buf->data[3];
3875
3876 /* Double-check that we haven't accidentally buffered
3877 * a message that doesn't fit into the input buffer. */
3878 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
3879 {
3880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3881 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3882 }
3883
3884 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
3885 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
3886 hs_buf->data, msg_len + 12 );
3887
3888 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
3889 ssl->in_hslen = msg_len + 12;
3890 ssl->in_msglen = msg_len + 12;
3891 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
3892
3893 ret = 0;
3894 goto exit;
3895 }
3896 else
3897 {
3898 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
3899 hs->in_msg_seq ) );
3900 }
3901
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003902 ret = -1;
3903
3904exit:
3905
3906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
3907 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003908}
3909
Hanno Beckera02b0b42018-08-21 17:20:27 +01003910static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
3911 size_t desired )
3912{
3913 int offset;
3914 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003915 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
3916 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003917
Hanno Becker01315ea2018-08-21 17:22:17 +01003918 /* Get rid of future records epoch first, if such exist. */
3919 ssl_free_buffered_record( ssl );
3920
3921 /* Check if we have enough space available now. */
3922 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3923 hs->buffering.total_bytes_buffered ) )
3924 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01003926 return( 0 );
3927 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01003928
Hanno Becker4f432ad2018-08-28 10:02:32 +01003929 /* We don't have enough space to buffer the next expected handshake
3930 * message. Remove buffers used for future messages to gain space,
3931 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01003932 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
3933 offset >= 0; offset-- )
3934 {
3935 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
3936 offset ) );
3937
Hanno Beckerb309b922018-08-23 13:18:05 +01003938 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003939
3940 /* Check if we have enough space available now. */
3941 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
3942 hs->buffering.total_bytes_buffered ) )
3943 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01003944 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01003945 return( 0 );
3946 }
3947 }
3948
3949 return( -1 );
3950}
3951
Hanno Becker40f50842018-08-15 14:48:01 +01003952static int ssl_buffer_message( mbedtls_ssl_context *ssl )
3953{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003954 int ret = 0;
3955 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
3956
3957 if( hs == NULL )
3958 return( 0 );
3959
3960 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
3961
3962 switch( ssl->in_msgtype )
3963 {
3964 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
3965 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01003966
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01003967 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003968 break;
3969
3970 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01003971 {
3972 unsigned recv_msg_seq_offset;
3973 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
3974 mbedtls_ssl_hs_buffer *hs_buf;
3975 size_t msg_len = ssl->in_hslen - 12;
3976
3977 /* We should never receive an old handshake
3978 * message - double-check nonetheless. */
3979 if( recv_msg_seq < ssl->handshake->in_msg_seq )
3980 {
3981 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
3982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3983 }
3984
3985 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
3986 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
3987 {
3988 /* Silently ignore -- message too far in the future */
3989 MBEDTLS_SSL_DEBUG_MSG( 2,
3990 ( "Ignore future HS message with sequence number %u, "
3991 "buffering window %u - %u",
3992 recv_msg_seq, ssl->handshake->in_msg_seq,
3993 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
3994
3995 goto exit;
3996 }
3997
3998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
3999 recv_msg_seq, recv_msg_seq_offset ) );
4000
4001 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4002
4003 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004004 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004005 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004006 size_t reassembly_buf_sz;
4007
Hanno Becker37f95322018-08-16 13:55:32 +01004008 hs_buf->is_fragmented =
4009 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4010
4011 /* We copy the message back into the input buffer
4012 * after reassembly, so check that it's not too large.
4013 * This is an implementation-specific limitation
4014 * and not one from the standard, hence it is not
4015 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004016 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004017 {
4018 /* Ignore message */
4019 goto exit;
4020 }
4021
Hanno Beckere0b150f2018-08-21 15:51:03 +01004022 /* Check if we have enough space to buffer the message. */
4023 if( hs->buffering.total_bytes_buffered >
4024 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4025 {
4026 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4027 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4028 }
4029
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004030 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4031 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004032
4033 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4034 hs->buffering.total_bytes_buffered ) )
4035 {
4036 if( recv_msg_seq_offset > 0 )
4037 {
4038 /* If we can't buffer a future message because
4039 * of space limitations -- ignore. */
4040 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",
4041 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4042 (unsigned) hs->buffering.total_bytes_buffered ) );
4043 goto exit;
4044 }
Hanno Beckere1801392018-08-21 16:51:05 +01004045 else
4046 {
4047 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",
4048 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4049 (unsigned) hs->buffering.total_bytes_buffered ) );
4050 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004051
Hanno Beckera02b0b42018-08-21 17:20:27 +01004052 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004053 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004054 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",
4055 (unsigned) msg_len,
4056 (unsigned) reassembly_buf_sz,
4057 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004058 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004059 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4060 goto exit;
4061 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004062 }
4063
4064 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4065 msg_len ) );
4066
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004067 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4068 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004069 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004070 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004071 goto exit;
4072 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004073 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004074
4075 /* Prepare final header: copy msg_type, length and message_seq,
4076 * then add standardised fragment_offset and fragment_length */
4077 memcpy( hs_buf->data, ssl->in_msg, 6 );
4078 memset( hs_buf->data + 6, 0, 3 );
4079 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4080
4081 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004082
4083 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004084 }
4085 else
4086 {
4087 /* Make sure msg_type and length are consistent */
4088 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4089 {
4090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4091 /* Ignore */
4092 goto exit;
4093 }
4094 }
4095
Hanno Becker4422bbb2018-08-20 09:40:19 +01004096 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004097 {
4098 size_t frag_len, frag_off;
4099 unsigned char * const msg = hs_buf->data + 12;
4100
4101 /*
4102 * Check and copy current fragment
4103 */
4104
4105 /* Validation of header fields already done in
4106 * mbedtls_ssl_prepare_handshake_record(). */
4107 frag_off = ssl_get_hs_frag_off( ssl );
4108 frag_len = ssl_get_hs_frag_len( ssl );
4109
4110 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4111 frag_off, frag_len ) );
4112 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4113
4114 if( hs_buf->is_fragmented )
4115 {
4116 unsigned char * const bitmask = msg + msg_len;
4117 ssl_bitmask_set( bitmask, frag_off, frag_len );
4118 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4119 msg_len ) == 0 );
4120 }
4121 else
4122 {
4123 hs_buf->is_complete = 1;
4124 }
4125
4126 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4127 hs_buf->is_complete ? "" : "not yet " ) );
4128 }
4129
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004130 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004131 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004132
4133 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004134 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004135 break;
4136 }
4137
4138exit:
4139
4140 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4141 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004142}
4143#endif /* MBEDTLS_SSL_PROTO_DTLS */
4144
Hanno Becker1097b342018-08-15 14:09:41 +01004145static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004146{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004147 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004148 * Consume last content-layer message and potentially
4149 * update in_msglen which keeps track of the contents'
4150 * consumption state.
4151 *
4152 * (1) Handshake messages:
4153 * Remove last handshake message, move content
4154 * and adapt in_msglen.
4155 *
4156 * (2) Alert messages:
4157 * Consume whole record content, in_msglen = 0.
4158 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004159 * (3) Change cipher spec:
4160 * Consume whole record content, in_msglen = 0.
4161 *
4162 * (4) Application data:
4163 * Don't do anything - the record layer provides
4164 * the application data as a stream transport
4165 * and consumes through mbedtls_ssl_read only.
4166 *
4167 */
4168
4169 /* Case (1): Handshake messages */
4170 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004171 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004172 /* Hard assertion to be sure that no application data
4173 * is in flight, as corrupting ssl->in_msglen during
4174 * ssl->in_offt != NULL is fatal. */
4175 if( ssl->in_offt != NULL )
4176 {
4177 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4178 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4179 }
4180
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004181 /*
4182 * Get next Handshake message in the current record
4183 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004184
Hanno Becker4a810fb2017-05-24 16:27:30 +01004185 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004186 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004187 * current handshake content: If DTLS handshake
4188 * fragmentation is used, that's the fragment
4189 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004190 * size here is faulty and should be changed at
4191 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004192 * (2) While it doesn't seem to cause problems, one
4193 * has to be very careful not to assume that in_hslen
4194 * is always <= in_msglen in a sensible communication.
4195 * Again, it's wrong for DTLS handshake fragmentation.
4196 * The following check is therefore mandatory, and
4197 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004198 * Additionally, ssl->in_hslen might be arbitrarily out of
4199 * bounds after handling a DTLS message with an unexpected
4200 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004201 */
4202 if( ssl->in_hslen < ssl->in_msglen )
4203 {
4204 ssl->in_msglen -= ssl->in_hslen;
4205 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4206 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004207
Hanno Becker4a810fb2017-05-24 16:27:30 +01004208 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4209 ssl->in_msg, ssl->in_msglen );
4210 }
4211 else
4212 {
4213 ssl->in_msglen = 0;
4214 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004215
Hanno Becker4a810fb2017-05-24 16:27:30 +01004216 ssl->in_hslen = 0;
4217 }
4218 /* Case (4): Application data */
4219 else if( ssl->in_offt != NULL )
4220 {
4221 return( 0 );
4222 }
4223 /* Everything else (CCS & Alerts) */
4224 else
4225 {
4226 ssl->in_msglen = 0;
4227 }
4228
Hanno Becker1097b342018-08-15 14:09:41 +01004229 return( 0 );
4230}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004231
Hanno Beckere74d5562018-08-15 14:26:08 +01004232static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4233{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004234 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004235 return( 1 );
4236
4237 return( 0 );
4238}
4239
Hanno Becker5f066e72018-08-16 14:56:31 +01004240#if defined(MBEDTLS_SSL_PROTO_DTLS)
4241
4242static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4243{
4244 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4245 if( hs == NULL )
4246 return;
4247
Hanno Becker01315ea2018-08-21 17:22:17 +01004248 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004249 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004250 hs->buffering.total_bytes_buffered -=
4251 hs->buffering.future_record.len;
4252
4253 mbedtls_free( hs->buffering.future_record.data );
4254 hs->buffering.future_record.data = NULL;
4255 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004256}
4257
4258static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4259{
4260 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4261 unsigned char * rec;
4262 size_t rec_len;
4263 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004264#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4265 size_t in_buf_len = ssl->in_buf_len;
4266#else
4267 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4268#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004269 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4270 return( 0 );
4271
4272 if( hs == NULL )
4273 return( 0 );
4274
Hanno Becker5f066e72018-08-16 14:56:31 +01004275 rec = hs->buffering.future_record.data;
4276 rec_len = hs->buffering.future_record.len;
4277 rec_epoch = hs->buffering.future_record.epoch;
4278
4279 if( rec == NULL )
4280 return( 0 );
4281
Hanno Becker4cb782d2018-08-20 11:19:05 +01004282 /* Only consider loading future records if the
4283 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004284 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004285 return( 0 );
4286
Hanno Becker5f066e72018-08-16 14:56:31 +01004287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4288
4289 if( rec_epoch != ssl->in_epoch )
4290 {
4291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4292 goto exit;
4293 }
4294
4295 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4296
4297 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004298 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004299 {
4300 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4301 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4302 }
4303
4304 memcpy( ssl->in_hdr, rec, rec_len );
4305 ssl->in_left = rec_len;
4306 ssl->next_record_offset = 0;
4307
4308 ssl_free_buffered_record( ssl );
4309
4310exit:
4311 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4312 return( 0 );
4313}
4314
Hanno Becker519f15d2019-07-11 12:43:20 +01004315static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4316 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004317{
4318 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004319
4320 /* Don't buffer future records outside handshakes. */
4321 if( hs == NULL )
4322 return( 0 );
4323
4324 /* Only buffer handshake records (we are only interested
4325 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004326 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004327 return( 0 );
4328
4329 /* Don't buffer more than one future epoch record. */
4330 if( hs->buffering.future_record.data != NULL )
4331 return( 0 );
4332
Hanno Becker01315ea2018-08-21 17:22:17 +01004333 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004334 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004335 hs->buffering.total_bytes_buffered ) )
4336 {
4337 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 +01004338 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004339 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004340 return( 0 );
4341 }
4342
Hanno Becker5f066e72018-08-16 14:56:31 +01004343 /* Buffer record */
4344 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4345 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004346 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004347
4348 /* ssl_parse_record_header() only considers records
4349 * of the next epoch as candidates for buffering. */
4350 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004351 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004352
4353 hs->buffering.future_record.data =
4354 mbedtls_calloc( 1, hs->buffering.future_record.len );
4355 if( hs->buffering.future_record.data == NULL )
4356 {
4357 /* If we run out of RAM trying to buffer a
4358 * record from the next epoch, just ignore. */
4359 return( 0 );
4360 }
4361
Hanno Becker519f15d2019-07-11 12:43:20 +01004362 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004363
Hanno Becker519f15d2019-07-11 12:43:20 +01004364 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004365 return( 0 );
4366}
4367
4368#endif /* MBEDTLS_SSL_PROTO_DTLS */
4369
Hanno Beckere74d5562018-08-15 14:26:08 +01004370static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004371{
Janos Follath865b3eb2019-12-16 11:46:15 +00004372 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004373 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004374
Hanno Becker5f066e72018-08-16 14:56:31 +01004375#if defined(MBEDTLS_SSL_PROTO_DTLS)
4376 /* We might have buffered a future record; if so,
4377 * and if the epoch matches now, load it.
4378 * On success, this call will set ssl->in_left to
4379 * the length of the buffered record, so that
4380 * the calls to ssl_fetch_input() below will
4381 * essentially be no-ops. */
4382 ret = ssl_load_buffered_record( ssl );
4383 if( ret != 0 )
4384 return( ret );
4385#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004386
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004387 /* Ensure that we have enough space available for the default form
4388 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4389 * with no space for CIDs counted in). */
4390 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4391 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004392 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004393 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004394 return( ret );
4395 }
4396
Hanno Beckere5e7e782019-07-11 12:29:35 +01004397 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4398 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004399 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004400#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004401 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004402 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004403 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4404 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004405 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004406 if( ret != 0 )
4407 return( ret );
4408
4409 /* Fall through to handling of unexpected records */
4410 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4411 }
4412
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004413 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4414 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004415#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004416 /* Reset in pointers to default state for TLS/DTLS records,
4417 * assuming no CID and no offset between record content and
4418 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004419 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004420
Hanno Becker7ae20e02019-07-12 08:33:49 +01004421 /* Setup internal message pointers from record structure. */
4422 ssl->in_msgtype = rec.type;
4423#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4424 ssl->in_len = ssl->in_cid + rec.cid_len;
4425#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4426 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4427 ssl->in_msglen = rec.data_len;
4428
Hanno Becker2fddd372019-07-10 14:37:41 +01004429 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004430 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004431 if( ret != 0 )
4432 return( ret );
4433#endif
4434
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004435 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004436 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004437
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4439 "(header)" ) );
4440 }
4441 else
4442 {
4443 /* Skip invalid record and the rest of the datagram */
4444 ssl->next_record_offset = 0;
4445 ssl->in_left = 0;
4446
4447 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4448 "(header)" ) );
4449 }
4450
4451 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004452 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004453 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004454 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004455#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004456 {
4457 return( ret );
4458 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004459 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004460
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004461#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004462 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004463 {
Hanno Beckera8814792019-07-10 15:01:45 +01004464 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004465 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004466 if( ssl->next_record_offset < ssl->in_left )
4467 {
4468 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4469 }
4470 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004471 else
4472#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004473 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004474 /*
4475 * Fetch record contents from underlying transport.
4476 */
Hanno Beckera3175662019-07-11 12:50:29 +01004477 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004478 if( ret != 0 )
4479 {
4480 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4481 return( ret );
4482 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004483
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004484 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004485 }
4486
4487 /*
4488 * Decrypt record contents.
4489 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004490
Hanno Beckerfdf66042019-07-11 13:07:45 +01004491 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004492 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004493#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004494 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004495 {
4496 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004497 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004498 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004499 /* Except when waiting for Finished as a bad mac here
4500 * probably means something went wrong in the handshake
4501 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4502 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4503 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4504 {
4505#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4506 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4507 {
4508 mbedtls_ssl_send_alert_message( ssl,
4509 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4510 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4511 }
4512#endif
4513 return( ret );
4514 }
4515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004517 if( ssl->conf->badmac_limit != 0 &&
4518 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004519 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4521 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004522 }
4523#endif
4524
Hanno Becker4a810fb2017-05-24 16:27:30 +01004525 /* As above, invalid records cause
4526 * dismissal of the whole datagram. */
4527
4528 ssl->next_record_offset = 0;
4529 ssl->in_left = 0;
4530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004532 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004533 }
4534
4535 return( ret );
4536 }
4537 else
4538#endif
4539 {
4540 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4542 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004543 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004544 mbedtls_ssl_send_alert_message( ssl,
4545 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4546 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004547 }
4548#endif
4549 return( ret );
4550 }
4551 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004552
Hanno Becker44d89b22019-07-12 09:40:44 +01004553
4554 /* Reset in pointers to default state for TLS/DTLS records,
4555 * assuming no CID and no offset between record content and
4556 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004557 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004558#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4559 ssl->in_len = ssl->in_cid + rec.cid_len;
4560#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004561 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004562
Hanno Becker8685c822019-07-12 09:37:30 +01004563 /* The record content type may change during decryption,
4564 * so re-read it. */
4565 ssl->in_msgtype = rec.type;
4566 /* Also update the input buffer, because unfortunately
4567 * the server-side ssl_parse_client_hello() reparses the
4568 * record header when receiving a ClientHello initiating
4569 * a renegotiation. */
4570 ssl->in_hdr[0] = rec.type;
4571 ssl->in_msg = rec.buf + rec.data_offset;
4572 ssl->in_msglen = rec.data_len;
4573 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4574 ssl->in_len[1] = (unsigned char)( rec.data_len );
4575
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004576#if defined(MBEDTLS_ZLIB_SUPPORT)
4577 if( ssl->transform_in != NULL &&
4578 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4579 {
4580 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4581 {
4582 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4583 return( ret );
4584 }
4585
4586 /* Check actual (decompress) record content length against
4587 * configured maximum. */
4588 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4589 {
4590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4591 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4592 }
4593 }
4594#endif /* MBEDTLS_ZLIB_SUPPORT */
4595
Simon Butcher99000142016-10-13 17:21:01 +01004596 return( 0 );
4597}
4598
4599int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4600{
Janos Follath865b3eb2019-12-16 11:46:15 +00004601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004602
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004603 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004604 * Handle particular types of records
4605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004606 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004607 {
Simon Butcher99000142016-10-13 17:21:01 +01004608 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4609 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004610 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004611 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004612 }
4613
Hanno Beckere678eaa2018-08-21 14:57:46 +01004614 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004615 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004616 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004617 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4619 ssl->in_msglen ) );
4620 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004621 }
4622
Hanno Beckere678eaa2018-08-21 14:57:46 +01004623 if( ssl->in_msg[0] != 1 )
4624 {
4625 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4626 ssl->in_msg[0] ) );
4627 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4628 }
4629
4630#if defined(MBEDTLS_SSL_PROTO_DTLS)
4631 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4632 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4633 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4634 {
4635 if( ssl->handshake == NULL )
4636 {
4637 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4638 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4639 }
4640
4641 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4642 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4643 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004644#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004645 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004647 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004648 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004649 if( ssl->in_msglen != 2 )
4650 {
4651 /* Note: Standard allows for more than one 2 byte alert
4652 to be packed in a single message, but Mbed TLS doesn't
4653 currently support this. */
4654 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4655 ssl->in_msglen ) );
4656 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4657 }
4658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004659 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004660 ssl->in_msg[0], ssl->in_msg[1] ) );
4661
4662 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004663 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004665 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004666 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004668 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004669 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004670 }
4671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004672 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4673 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004674 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004675 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4676 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004677 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004678
4679#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4680 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4681 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4682 {
Hanno Becker90333da2017-10-10 11:27:13 +01004683 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004684 /* Will be handled when trying to parse ServerHello */
4685 return( 0 );
4686 }
4687#endif
4688
4689#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4690 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4691 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4692 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4693 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4694 {
4695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4696 /* Will be handled in mbedtls_ssl_parse_certificate() */
4697 return( 0 );
4698 }
4699#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4700
4701 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004702 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004703 }
4704
Hanno Beckerc76c6192017-06-06 10:03:17 +01004705#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004706 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004707 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004708 /* Drop unexpected ApplicationData records,
4709 * except at the beginning of renegotiations */
4710 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4711 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4712#if defined(MBEDTLS_SSL_RENEGOTIATION)
4713 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4714 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004715#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004716 )
4717 {
4718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4719 return( MBEDTLS_ERR_SSL_NON_FATAL );
4720 }
4721
4722 if( ssl->handshake != NULL &&
4723 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4724 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004725 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004726 }
4727 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004728#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004729
Paul Bakker5121ce52009-01-03 21:22:43 +00004730 return( 0 );
4731}
4732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004733int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004734{
irwir6c0da642019-09-26 21:07:41 +03004735 return( mbedtls_ssl_send_alert_message( ssl,
4736 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4737 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004738}
4739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004740int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004741 unsigned char level,
4742 unsigned char message )
4743{
Janos Follath865b3eb2019-12-16 11:46:15 +00004744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004745
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004746 if( ssl == NULL || ssl->conf == NULL )
4747 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004749 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004750 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004753 ssl->out_msglen = 2;
4754 ssl->out_msg[0] = level;
4755 ssl->out_msg[1] = message;
4756
Hanno Becker67bc7c32018-08-06 11:33:50 +01004757 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004758 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004759 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004760 return( ret );
4761 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004763
4764 return( 0 );
4765}
4766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004768{
Janos Follath865b3eb2019-12-16 11:46:15 +00004769 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004772
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004773 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004774 ssl->out_msglen = 1;
4775 ssl->out_msg[0] = 1;
4776
Paul Bakker5121ce52009-01-03 21:22:43 +00004777 ssl->state++;
4778
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004779 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004780 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004781 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004782 return( ret );
4783 }
4784
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004786
4787 return( 0 );
4788}
4789
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004790int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004791{
Janos Follath865b3eb2019-12-16 11:46:15 +00004792 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004795
Hanno Becker327c93b2018-08-15 13:56:18 +01004796 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004797 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004799 return( ret );
4800 }
4801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004802 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00004803 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004805 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4806 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004807 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004808 }
4809
Hanno Beckere678eaa2018-08-21 14:57:46 +01004810 /* CCS records are only accepted if they have length 1 and content '1',
4811 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004812
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004813 /*
4814 * Switch to our negotiated transform and session parameters for inbound
4815 * data.
4816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004817 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004818 ssl->transform_in = ssl->transform_negotiate;
4819 ssl->session_in = ssl->session_negotiate;
4820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004821#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004822 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004823 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004824#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00004825 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004826#endif
4827
4828 /* Increment epoch */
4829 if( ++ssl->in_epoch == 0 )
4830 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004831 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004832 /* This is highly unlikely to happen for legitimate reasons, so
4833 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004834 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004835 }
4836 }
4837 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004838#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004839 memset( ssl->in_ctr, 0, 8 );
4840
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004841 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004843#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
4844 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004845 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004846 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004847 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004848 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004849 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4850 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004851 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004852 }
4853 }
4854#endif
4855
Paul Bakker5121ce52009-01-03 21:22:43 +00004856 ssl->state++;
4857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004858 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004859
4860 return( 0 );
4861}
4862
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004863/* Once ssl->out_hdr as the address of the beginning of the
4864 * next outgoing record is set, deduce the other pointers.
4865 *
4866 * Note: For TLS, we save the implicit record sequence number
4867 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4868 * and the caller has to make sure there's space for this.
4869 */
4870
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004871void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
4872 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004873{
4874#if defined(MBEDTLS_SSL_PROTO_DTLS)
4875 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4876 {
4877 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004878#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004879 ssl->out_cid = ssl->out_ctr + 8;
4880 ssl->out_len = ssl->out_cid;
4881 if( transform != NULL )
4882 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004883#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004884 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004885#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004886 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004887 }
4888 else
4889#endif
4890 {
4891 ssl->out_ctr = ssl->out_hdr - 8;
4892 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004893#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004894 ssl->out_cid = ssl->out_len;
4895#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004896 ssl->out_iv = ssl->out_hdr + 5;
4897 }
4898
4899 /* Adjust out_msg to make space for explicit IV, if used. */
4900 if( transform != NULL &&
4901 ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
4902 {
4903 ssl->out_msg = ssl->out_iv + transform->ivlen - transform->fixed_ivlen;
4904 }
4905 else
4906 ssl->out_msg = ssl->out_iv;
4907}
4908
4909/* Once ssl->in_hdr as the address of the beginning of the
4910 * next incoming record is set, deduce the other pointers.
4911 *
4912 * Note: For TLS, we save the implicit record sequence number
4913 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
4914 * and the caller has to make sure there's space for this.
4915 */
4916
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004917void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004918{
Hanno Becker79594fd2019-05-08 09:38:41 +01004919 /* This function sets the pointers to match the case
4920 * of unprotected TLS/DTLS records, with both ssl->in_iv
4921 * and ssl->in_msg pointing to the beginning of the record
4922 * content.
4923 *
4924 * When decrypting a protected record, ssl->in_msg
4925 * will be shifted to point to the beginning of the
4926 * record plaintext.
4927 */
4928
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004929#if defined(MBEDTLS_SSL_PROTO_DTLS)
4930 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4931 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004932 /* This sets the header pointers to match records
4933 * without CID. When we receive a record containing
4934 * a CID, the fields are shifted accordingly in
4935 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004936 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004937#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004938 ssl->in_cid = ssl->in_ctr + 8;
4939 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01004940#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004941 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004942#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004943 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004944 }
4945 else
4946#endif
4947 {
4948 ssl->in_ctr = ssl->in_hdr - 8;
4949 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004950#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004951 ssl->in_cid = ssl->in_len;
4952#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004953 ssl->in_iv = ssl->in_hdr + 5;
4954 }
4955
Hanno Becker79594fd2019-05-08 09:38:41 +01004956 /* This will be adjusted at record decryption time. */
4957 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004958}
4959
Paul Bakker5121ce52009-01-03 21:22:43 +00004960/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02004961 * Setup an SSL context
4962 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004963
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004964void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004965{
4966 /* Set the incoming and outgoing record pointers. */
4967#if defined(MBEDTLS_SSL_PROTO_DTLS)
4968 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4969 {
4970 ssl->out_hdr = ssl->out_buf;
4971 ssl->in_hdr = ssl->in_buf;
4972 }
4973 else
4974#endif /* MBEDTLS_SSL_PROTO_DTLS */
4975 {
4976 ssl->out_hdr = ssl->out_buf + 8;
4977 ssl->in_hdr = ssl->in_buf + 8;
4978 }
4979
4980 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004981 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
4982 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01004983}
4984
Paul Bakker5121ce52009-01-03 21:22:43 +00004985/*
4986 * SSL get accessors
4987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004988size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004989{
4990 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
4991}
4992
Hanno Becker8b170a02017-10-10 11:51:19 +01004993int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
4994{
4995 /*
4996 * Case A: We're currently holding back
4997 * a message for further processing.
4998 */
4999
5000 if( ssl->keep_current_message == 1 )
5001 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005002 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005003 return( 1 );
5004 }
5005
5006 /*
5007 * Case B: Further records are pending in the current datagram.
5008 */
5009
5010#if defined(MBEDTLS_SSL_PROTO_DTLS)
5011 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5012 ssl->in_left > ssl->next_record_offset )
5013 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005014 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005015 return( 1 );
5016 }
5017#endif /* MBEDTLS_SSL_PROTO_DTLS */
5018
5019 /*
5020 * Case C: A handshake message is being processed.
5021 */
5022
Hanno Becker8b170a02017-10-10 11:51:19 +01005023 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5024 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005025 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005026 return( 1 );
5027 }
5028
5029 /*
5030 * Case D: An application data message is being processed
5031 */
5032 if( ssl->in_offt != NULL )
5033 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005034 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005035 return( 1 );
5036 }
5037
5038 /*
5039 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005040 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005041 * we implement support for multiple alerts in single records.
5042 */
5043
5044 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5045 return( 0 );
5046}
5047
Paul Bakker43ca69c2011-01-15 17:35:19 +00005048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005049int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005050{
Hanno Becker3136ede2018-08-17 15:28:19 +01005051 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005052 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005053 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005054
Hanno Becker5903de42019-05-03 14:46:38 +01005055 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5056
Hanno Becker78640902018-08-13 16:35:15 +01005057 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005058 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005060#if defined(MBEDTLS_ZLIB_SUPPORT)
5061 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5062 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005063#endif
5064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005065 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005066 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005067 case MBEDTLS_MODE_GCM:
5068 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005069 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005070 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005071 transform_expansion = transform->minlen;
5072 break;
5073
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005075
5076 block_size = mbedtls_cipher_get_block_size(
5077 &transform->cipher_ctx_enc );
5078
Hanno Becker3136ede2018-08-17 15:28:19 +01005079 /* Expansion due to the addition of the MAC. */
5080 transform_expansion += transform->maclen;
5081
5082 /* Expansion due to the addition of CBC padding;
5083 * Theoretically up to 256 bytes, but we never use
5084 * more than the block size of the underlying cipher. */
5085 transform_expansion += block_size;
5086
5087 /* For TLS 1.1 or higher, an explicit IV is added
5088 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005089#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5090 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005091 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005092#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005093
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005094 break;
5095
5096 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005097 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005099 }
5100
Hanno Beckera0e20d02019-05-15 14:03:01 +01005101#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005102 if( transform->out_cid_len != 0 )
5103 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005104#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005105
Hanno Becker5903de42019-05-03 14:46:38 +01005106 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005107}
5108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005109#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005110/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005111 * Check record counters and renegotiate if they're above the limit.
5112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005113static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005114{
Hanno Beckerdd772292020-02-05 10:38:31 +00005115 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005116 int in_ctr_cmp;
5117 int out_ctr_cmp;
5118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5120 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005121 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005122 {
5123 return( 0 );
5124 }
5125
Andres AG2196c7f2016-12-15 17:01:16 +00005126 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5127 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005128 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005129 ssl->conf->renego_period + ep_len, 8 - ep_len );
5130
5131 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005132 {
5133 return( 0 );
5134 }
5135
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005136 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005137 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005138}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005139#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005140
5141/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005142 * Receive application data decrypted from the SSL layer
5143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005144int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005145{
Janos Follath865b3eb2019-12-16 11:46:15 +00005146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005147 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005148
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005149 if( ssl == NULL || ssl->conf == NULL )
5150 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005152 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005155 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005156 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005157 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005158 return( ret );
5159
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005160 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005161 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005162 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005163 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005164 return( ret );
5165 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005166 }
5167#endif
5168
Hanno Becker4a810fb2017-05-24 16:27:30 +01005169 /*
5170 * Check if renegotiation is necessary and/or handshake is
5171 * in process. If yes, perform/continue, and fall through
5172 * if an unexpected packet is received while the client
5173 * is waiting for the ServerHello.
5174 *
5175 * (There is no equivalent to the last condition on
5176 * the server-side as it is not treated as within
5177 * a handshake while waiting for the ClientHello
5178 * after a renegotiation request.)
5179 */
5180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005181#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005182 ret = ssl_check_ctr_renegotiate( ssl );
5183 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5184 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005186 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005187 return( ret );
5188 }
5189#endif
5190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005191 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005192 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005193 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005194 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5195 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005196 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005197 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005198 return( ret );
5199 }
5200 }
5201
Hanno Beckere41158b2017-10-23 13:30:32 +01005202 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005203 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005204 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005205 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005206 if( ssl->f_get_timer != NULL &&
5207 ssl->f_get_timer( ssl->p_timer ) == -1 )
5208 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005209 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005210 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005211
Hanno Becker327c93b2018-08-15 13:56:18 +01005212 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005213 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005214 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5215 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005216
Hanno Becker4a810fb2017-05-24 16:27:30 +01005217 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5218 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005219 }
5220
5221 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005222 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005223 {
5224 /*
5225 * OpenSSL sends empty messages to randomize the IV
5226 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005227 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005228 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005229 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005230 return( 0 );
5231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005232 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005233 return( ret );
5234 }
5235 }
5236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005237 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005238 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005239 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005240
Hanno Becker4a810fb2017-05-24 16:27:30 +01005241 /*
5242 * - For client-side, expect SERVER_HELLO_REQUEST.
5243 * - For server-side, expect CLIENT_HELLO.
5244 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5245 */
5246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005247#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005248 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005249 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005250 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005251 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005252 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005253
5254 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005255#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005256 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005257 {
5258 continue;
5259 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005260#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005261 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005262 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005263#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005264
Hanno Becker4a810fb2017-05-24 16:27:30 +01005265#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005266 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005269 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005270
5271 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005272#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005273 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005274 {
5275 continue;
5276 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005277#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005278 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005279 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005280#endif /* MBEDTLS_SSL_SRV_C */
5281
Hanno Becker21df7f92017-10-17 11:03:26 +01005282#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005283 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005284 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5285 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5286 ssl->conf->allow_legacy_renegotiation ==
5287 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5288 {
5289 /*
5290 * Accept renegotiation request
5291 */
Paul Bakker48916f92012-09-16 19:57:18 +00005292
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005293 /* DTLS clients need to know renego is server-initiated */
5294#if defined(MBEDTLS_SSL_PROTO_DTLS)
5295 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5296 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5297 {
5298 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5299 }
5300#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005301 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005302 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5303 ret != 0 )
5304 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005305 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5306 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005307 return( ret );
5308 }
5309 }
5310 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005311#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005312 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005313 /*
5314 * Refuse renegotiation
5315 */
5316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005319#if defined(MBEDTLS_SSL_PROTO_SSL3)
5320 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005321 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005322 /* SSLv3 does not have a "no_renegotiation" warning, so
5323 we send a fatal alert and abort the connection. */
5324 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5325 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5326 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005327 }
5328 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005329#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5330#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5331 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5332 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005333 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005334 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5335 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5336 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005337 {
5338 return( ret );
5339 }
Paul Bakker48916f92012-09-16 19:57:18 +00005340 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005341 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005342#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5343 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005344 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5346 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005347 }
Paul Bakker48916f92012-09-16 19:57:18 +00005348 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005349
Hanno Becker90333da2017-10-10 11:27:13 +01005350 /* At this point, we don't know whether the renegotiation has been
5351 * completed or not. The cases to consider are the following:
5352 * 1) The renegotiation is complete. In this case, no new record
5353 * has been read yet.
5354 * 2) The renegotiation is incomplete because the client received
5355 * an application data record while awaiting the ServerHello.
5356 * 3) The renegotiation is incomplete because the client received
5357 * a non-handshake, non-application data message while awaiting
5358 * the ServerHello.
5359 * In each of these case, looping will be the proper action:
5360 * - For 1), the next iteration will read a new record and check
5361 * if it's application data.
5362 * - For 2), the loop condition isn't satisfied as application data
5363 * is present, hence continue is the same as break
5364 * - For 3), the loop condition is satisfied and read_record
5365 * will re-deliver the message that was held back by the client
5366 * when expecting the ServerHello.
5367 */
5368 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005369 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005370#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005371 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005372 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005373 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005374 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005375 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005376 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005377 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005378 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005379 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005380 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005381 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005382 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005385 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5386 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005387 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005389 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005390 }
5391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005392 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005393 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005394 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5395 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005396 }
5397
5398 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005399
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005400 /* We're going to return something now, cancel timer,
5401 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005402 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005403 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005404
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005405#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005406 /* If we requested renego but received AppData, resend HelloRequest.
5407 * Do it now, after setting in_offt, to avoid taking this branch
5408 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005409#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005410 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005411 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005412 {
Hanno Becker786300f2020-02-05 10:46:40 +00005413 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005414 {
Hanno Becker786300f2020-02-05 10:46:40 +00005415 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5416 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005417 return( ret );
5418 }
5419 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005420#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005421#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005422 }
5423
5424 n = ( len < ssl->in_msglen )
5425 ? len : ssl->in_msglen;
5426
5427 memcpy( buf, ssl->in_offt, n );
5428 ssl->in_msglen -= n;
5429
5430 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005431 {
5432 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005433 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005434 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005435 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005436 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005437 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005438 /* more data available */
5439 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005440 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005442 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005443
Paul Bakker23986e52011-04-24 08:57:21 +00005444 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005445}
5446
5447/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005448 * Send application data to be encrypted by the SSL layer, taking care of max
5449 * fragment length and buffer size.
5450 *
5451 * According to RFC 5246 Section 6.2.1:
5452 *
5453 * Zero-length fragments of Application data MAY be sent as they are
5454 * potentially useful as a traffic analysis countermeasure.
5455 *
5456 * Therefore, it is possible that the input message length is 0 and the
5457 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005458 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005459static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005460 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005461{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005462 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5463 const size_t max_len = (size_t) ret;
5464
5465 if( ret < 0 )
5466 {
5467 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5468 return( ret );
5469 }
5470
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005471 if( len > max_len )
5472 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005473#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005474 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005475 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005476 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005477 "maximum fragment length: %d > %d",
5478 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005479 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005480 }
5481 else
5482#endif
5483 len = max_len;
5484 }
Paul Bakker887bd502011-06-08 13:10:54 +00005485
Paul Bakker5121ce52009-01-03 21:22:43 +00005486 if( ssl->out_left != 0 )
5487 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005488 /*
5489 * The user has previously tried to send the data and
5490 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5491 * written. In this case, we expect the high-level write function
5492 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005494 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005495 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005496 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 return( ret );
5498 }
5499 }
Paul Bakker887bd502011-06-08 13:10:54 +00005500 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005501 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005502 /*
5503 * The user is trying to send a message the first time, so we need to
5504 * copy the data into the internal buffers and setup the data structure
5505 * to keep track of partial writes
5506 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005507 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005508 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005509 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005510
Hanno Becker67bc7c32018-08-06 11:33:50 +01005511 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005512 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005513 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005514 return( ret );
5515 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005516 }
5517
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005518 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005519}
5520
5521/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005522 * Write application data, doing 1/n-1 splitting if necessary.
5523 *
5524 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005525 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005526 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005528#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005529static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005530 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005531{
Janos Follath865b3eb2019-12-16 11:46:15 +00005532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005533
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005534 if( ssl->conf->cbc_record_splitting ==
5535 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005536 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005537 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5538 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5539 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005540 {
5541 return( ssl_write_real( ssl, buf, len ) );
5542 }
5543
5544 if( ssl->split_done == 0 )
5545 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005546 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005547 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005548 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005549 }
5550
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005551 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5552 return( ret );
5553 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005554
5555 return( ret + 1 );
5556}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005558
5559/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005560 * Write application data (public-facing wrapper)
5561 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005562int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005563{
Janos Follath865b3eb2019-12-16 11:46:15 +00005564 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005565
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005566 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005567
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005568 if( ssl == NULL || ssl->conf == NULL )
5569 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5570
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005571#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005572 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5573 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005574 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005575 return( ret );
5576 }
5577#endif
5578
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005579 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005580 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005581 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005582 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005583 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005584 return( ret );
5585 }
5586 }
5587
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005588#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005589 ret = ssl_write_split( ssl, buf, len );
5590#else
5591 ret = ssl_write_real( ssl, buf, len );
5592#endif
5593
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005594 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005595
5596 return( ret );
5597}
5598
5599/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005600 * Notify the peer that the connection is being closed
5601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005602int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005603{
Janos Follath865b3eb2019-12-16 11:46:15 +00005604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005605
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005606 if( ssl == NULL || ssl->conf == NULL )
5607 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005609 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005610
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005611 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005614 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005615 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005616 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5617 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5618 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005619 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005620 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005621 return( ret );
5622 }
5623 }
5624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005626
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005627 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005628}
5629
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005630void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005631{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005632 if( transform == NULL )
5633 return;
5634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005635#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005636 deflateEnd( &transform->ctx_deflate );
5637 inflateEnd( &transform->ctx_inflate );
5638#endif
5639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5641 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005642
Hanno Beckerd56ed242018-01-03 15:32:51 +00005643#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005644 mbedtls_md_free( &transform->md_ctx_enc );
5645 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005646#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005647
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005648 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005649}
5650
Hanno Becker0271f962018-08-16 13:23:47 +01005651#if defined(MBEDTLS_SSL_PROTO_DTLS)
5652
Hanno Becker533ab5f2020-02-05 10:49:13 +00005653void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005654{
5655 unsigned offset;
5656 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5657
5658 if( hs == NULL )
5659 return;
5660
Hanno Becker283f5ef2018-08-24 09:34:47 +01005661 ssl_free_buffered_record( ssl );
5662
Hanno Becker0271f962018-08-16 13:23:47 +01005663 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005664 ssl_buffering_free_slot( ssl, offset );
5665}
5666
5667static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5668 uint8_t slot )
5669{
5670 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5671 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005672
5673 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5674 return;
5675
Hanno Beckere605b192018-08-21 15:59:07 +01005676 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005677 {
Hanno Beckere605b192018-08-21 15:59:07 +01005678 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005679 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005680 mbedtls_free( hs_buf->data );
5681 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005682 }
5683}
5684
5685#endif /* MBEDTLS_SSL_PROTO_DTLS */
5686
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005687/*
5688 * Convert version numbers to/from wire format
5689 * and, for DTLS, to/from TLS equivalent.
5690 *
5691 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005692 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005693 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5694 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005696void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005697 unsigned char ver[2] )
5698{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005699#if defined(MBEDTLS_SSL_PROTO_DTLS)
5700 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005703 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5704
5705 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5706 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5707 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005708 else
5709#else
5710 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005711#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005712 {
5713 ver[0] = (unsigned char) major;
5714 ver[1] = (unsigned char) minor;
5715 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005716}
5717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005718void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005719 const unsigned char ver[2] )
5720{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005721#if defined(MBEDTLS_SSL_PROTO_DTLS)
5722 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005723 {
5724 *major = 255 - ver[0] + 2;
5725 *minor = 255 - ver[1] + 1;
5726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005728 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5729 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005730 else
5731#else
5732 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005733#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005734 {
5735 *major = ver[0];
5736 *minor = ver[1];
5737 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005738}
5739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005740#endif /* MBEDTLS_SSL_TLS_C */