blob: 2ea35808ad5ad02390c85ffdb167606918b1a8ba [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 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
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 Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
21 * The SSL 3.0 specification was drafted by Netscape in 1996,
22 * and became an IETF standard in 1999.
23 *
24 * http://wp.netscape.com/eng/ssl3/
25 * http://www.ietf.org/rfc/rfc2246.txt
26 * http://www.ietf.org/rfc/rfc4346.txt
27 */
28
Gilles Peskinedb09ef62020-06-03 01:43:33 +020029#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000032
SimonBd5800b72016-04-26 07:43:27 +010033#if defined(MBEDTLS_PLATFORM_C)
34#include "mbedtls/platform.h"
35#else
36#include <stdlib.h>
37#define mbedtls_calloc calloc
38#define mbedtls_free free
SimonBd5800b72016-04-26 07:43:27 +010039#endif
40
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000041#include "mbedtls/ssl.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020042#include "mbedtls/ssl_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000043#include "mbedtls/debug.h"
44#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050045#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010046#include "mbedtls/version.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020047
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +020048#include "ssl_invasive.h"
49
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <string.h>
51
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050052#if defined(MBEDTLS_USE_PSA_CRYPTO)
53#include "mbedtls/psa_util.h"
54#include "psa/crypto.h"
55#endif
56
Janos Follath23bdca02016-10-07 14:47:14 +010057#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000058#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020059#endif
60
Hanno Beckercd9dcda2018-08-28 17:18:56 +010061static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +010062
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020063/*
64 * Start a timer.
65 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020066 */
Hanno Becker0f57a652020-02-05 10:37:26 +000067void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020068{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020069 if( ssl->f_set_timer == NULL )
70 return;
71
72 MBEDTLS_SSL_DEBUG_MSG( 3, ( "set_timer to %d ms", (int) millisecs ) );
73 ssl->f_set_timer( ssl->p_timer, millisecs / 4, millisecs );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020074}
75
76/*
77 * Return -1 is timer is expired, 0 if it isn't.
78 */
Hanno Becker7876d122020-02-05 10:39:31 +000079int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020080{
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020081 if( ssl->f_get_timer == NULL )
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +020082 return( 0 );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020083
84 if( ssl->f_get_timer( ssl->p_timer ) == 2 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020085 {
86 MBEDTLS_SSL_DEBUG_MSG( 3, ( "timer expired" ) );
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020087 return( -1 );
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020088 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020089
90 return( 0 );
91}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020092
Hanno Beckercfe45792019-07-03 16:13:00 +010093#if defined(MBEDTLS_SSL_RECORD_CHECKING)
Hanno Becker54229812019-07-12 14:40:00 +010094static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
95 unsigned char *buf,
96 size_t len,
97 mbedtls_record *rec );
98
Hanno Beckercfe45792019-07-03 16:13:00 +010099int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
100 unsigned char *buf,
101 size_t buflen )
102{
Hanno Becker54229812019-07-12 14:40:00 +0100103 int ret = 0;
Hanno Becker54229812019-07-12 14:40:00 +0100104 MBEDTLS_SSL_DEBUG_MSG( 1, ( "=> mbedtls_ssl_check_record" ) );
105 MBEDTLS_SSL_DEBUG_BUF( 3, "record buffer", buf, buflen );
106
107 /* We don't support record checking in TLS because
108 * (a) there doesn't seem to be a usecase for it, and
109 * (b) In SSLv3 and TLS 1.0, CBC record decryption has state
110 * and we'd need to backup the transform here.
111 */
112 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM )
113 {
114 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
115 goto exit;
116 }
117#if defined(MBEDTLS_SSL_PROTO_DTLS)
118 else
119 {
irwir734f0cf2019-09-26 21:03:24 +0300120 mbedtls_record rec;
121
Hanno Becker54229812019-07-12 14:40:00 +0100122 ret = ssl_parse_record_header( ssl, buf, buflen, &rec );
123 if( ret != 0 )
124 {
125 MBEDTLS_SSL_DEBUG_RET( 3, "ssl_parse_record_header", ret );
126 goto exit;
127 }
128
129 if( ssl->transform_in != NULL )
130 {
131 ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in, &rec );
132 if( ret != 0 )
133 {
134 MBEDTLS_SSL_DEBUG_RET( 3, "mbedtls_ssl_decrypt_buf", ret );
135 goto exit;
136 }
137 }
138 }
139#endif /* MBEDTLS_SSL_PROTO_DTLS */
140
141exit:
142 /* On success, we have decrypted the buffer in-place, so make
143 * sure we don't leak any plaintext data. */
144 mbedtls_platform_zeroize( buf, buflen );
145
146 /* For the purpose of this API, treat messages with unexpected CID
147 * as well as such from future epochs as unexpected. */
148 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
149 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
150 {
151 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
152 }
153
154 MBEDTLS_SSL_DEBUG_MSG( 1, ( "<= mbedtls_ssl_check_record" ) );
155 return( ret );
Hanno Beckercfe45792019-07-03 16:13:00 +0100156}
157#endif /* MBEDTLS_SSL_RECORD_CHECKING */
158
Hanno Becker67bc7c32018-08-06 11:33:50 +0100159#define SSL_DONT_FORCE_FLUSH 0
160#define SSL_FORCE_FLUSH 1
161
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100163
Hanno Beckerd5847772018-08-28 10:09:23 +0100164/* Forward declarations for functions related to message buffering. */
Hanno Beckerd5847772018-08-28 10:09:23 +0100165static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
166 uint8_t slot );
167static void ssl_free_buffered_record( mbedtls_ssl_context *ssl );
168static int ssl_load_buffered_message( mbedtls_ssl_context *ssl );
169static int ssl_load_buffered_record( mbedtls_ssl_context *ssl );
170static int ssl_buffer_message( mbedtls_ssl_context *ssl );
Hanno Becker519f15d2019-07-11 12:43:20 +0100171static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
172 mbedtls_record const *rec );
Hanno Beckeref7afdf2018-08-28 17:16:31 +0100173static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl );
Hanno Beckerd5847772018-08-28 10:09:23 +0100174
Hanno Becker11682cc2018-08-22 14:41:02 +0100175static size_t ssl_get_maximum_datagram_size( mbedtls_ssl_context const *ssl )
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176{
Hanno Becker89490712020-02-05 10:50:12 +0000177 size_t mtu = mbedtls_ssl_get_current_mtu( ssl );
Darryl Greenb33cc762019-11-28 14:29:44 +0000178#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
179 size_t out_buf_len = ssl->out_buf_len;
180#else
181 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
182#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100183
Darryl Greenb33cc762019-11-28 14:29:44 +0000184 if( mtu != 0 && mtu < out_buf_len )
Hanno Becker11682cc2018-08-22 14:41:02 +0100185 return( mtu );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100186
Darryl Greenb33cc762019-11-28 14:29:44 +0000187 return( out_buf_len );
Hanno Becker2b1e3542018-08-06 11:19:13 +0100188}
189
Hanno Becker67bc7c32018-08-06 11:33:50 +0100190static int ssl_get_remaining_space_in_datagram( mbedtls_ssl_context const *ssl )
191{
Hanno Becker11682cc2018-08-22 14:41:02 +0100192 size_t const bytes_written = ssl->out_left;
193 size_t const mtu = ssl_get_maximum_datagram_size( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100194
195 /* Double-check that the write-index hasn't gone
196 * past what we can transmit in a single datagram. */
Hanno Becker11682cc2018-08-22 14:41:02 +0100197 if( bytes_written > mtu )
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198 {
199 /* Should never happen... */
200 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
201 }
202
203 return( (int) ( mtu - bytes_written ) );
204}
205
206static int ssl_get_remaining_payload_in_datagram( mbedtls_ssl_context const *ssl )
207{
Janos Follath865b3eb2019-12-16 11:46:15 +0000208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100209 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400210 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100211
212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Andrzej Kurek90c6e842020-04-03 05:25:29 -0400213 const size_t mfl = mbedtls_ssl_get_output_max_frag_len( ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100214
215 if( max_len > mfl )
216 max_len = mfl;
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100217
218 /* By the standard (RFC 6066 Sect. 4), the MFL extension
219 * only limits the maximum record payload size, so in theory
220 * we would be allowed to pack multiple records of payload size
221 * MFL into a single datagram. However, this would mean that there's
222 * no way to explicitly communicate MTU restrictions to the peer.
223 *
224 * The following reduction of max_len makes sure that we never
225 * write datagrams larger than MFL + Record Expansion Overhead.
226 */
227 if( max_len <= ssl->out_left )
228 return( 0 );
229
230 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100231#endif
232
233 ret = ssl_get_remaining_space_in_datagram( ssl );
234 if( ret < 0 )
235 return( ret );
236 remaining = (size_t) ret;
237
238 ret = mbedtls_ssl_get_record_expansion( ssl );
239 if( ret < 0 )
240 return( ret );
241 expansion = (size_t) ret;
242
243 if( remaining <= expansion )
244 return( 0 );
245
246 remaining -= expansion;
247 if( remaining >= max_len )
248 remaining = max_len;
249
250 return( (int) remaining );
251}
252
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200253/*
254 * Double the retransmit timeout value, within the allowed range,
255 * returning -1 if the maximum value has already been reached.
256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257static int ssl_double_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200258{
259 uint32_t new_timeout;
260
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200261 if( ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200262 return( -1 );
263
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200264 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
265 * in the following way: after the initial transmission and a first
266 * retransmission, back off to a temporary estimated MTU of 508 bytes.
267 * This value is guaranteed to be deliverable (if not guaranteed to be
268 * delivered) of any compliant IPv4 (and IPv6) network, and should work
269 * on most non-IP stacks too. */
270 if( ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min )
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400271 {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200272 ssl->handshake->mtu = 508;
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400273 MBEDTLS_SSL_DEBUG_MSG( 2, ( "mtu autoreduction to %d bytes", ssl->handshake->mtu ) );
274 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200275
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200276 new_timeout = 2 * ssl->handshake->retransmit_timeout;
277
278 /* Avoid arithmetic overflow and range overflow */
279 if( new_timeout < ssl->handshake->retransmit_timeout ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200280 new_timeout > ssl->conf->hs_timeout_max )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200281 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200282 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283 }
284
285 ssl->handshake->retransmit_timeout = new_timeout;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200287 ssl->handshake->retransmit_timeout ) );
288
289 return( 0 );
290}
291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292static void ssl_reset_retransmit_timeout( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200293{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200294 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "update timeout value to %d millisecs",
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200296 ssl->handshake->retransmit_timeout ) );
297}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
301int (*mbedtls_ssl_hw_record_init)( mbedtls_ssl_context *ssl,
Paul Bakker9af723c2014-05-01 13:03:14 +0200302 const unsigned char *key_enc, const unsigned char *key_dec,
303 size_t keylen,
304 const unsigned char *iv_enc, const unsigned char *iv_dec,
305 size_t ivlen,
306 const unsigned char *mac_enc, const unsigned char *mac_dec,
Paul Bakker66d5d072014-06-17 16:39:18 +0200307 size_t maclen ) = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308int (*mbedtls_ssl_hw_record_activate)( mbedtls_ssl_context *ssl, int direction) = NULL;
309int (*mbedtls_ssl_hw_record_reset)( mbedtls_ssl_context *ssl ) = NULL;
310int (*mbedtls_ssl_hw_record_write)( mbedtls_ssl_context *ssl ) = NULL;
311int (*mbedtls_ssl_hw_record_read)( mbedtls_ssl_context *ssl ) = NULL;
312int (*mbedtls_ssl_hw_record_finish)( mbedtls_ssl_context *ssl ) = NULL;
313#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000314
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100315/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000316 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200317 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000318
Hanno Beckerccc13d02020-05-04 12:30:04 +0100319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || \
320 defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Becker13996922020-05-28 16:15:19 +0100321
322static size_t ssl_compute_padding_length( size_t len,
323 size_t granularity )
324{
325 return( ( granularity - ( len + 1 ) % granularity ) % granularity );
326}
327
Hanno Becker581bc1b2020-05-04 12:20:03 +0100328/* This functions transforms a (D)TLS plaintext fragment and a record content
329 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
330 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
331 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100332 *
333 * struct {
334 * opaque content[DTLSPlaintext.length];
335 * ContentType real_type;
336 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100337 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100338 *
339 * Input:
340 * - `content`: The beginning of the buffer holding the
341 * plaintext to be wrapped.
342 * - `*content_size`: The length of the plaintext in Bytes.
343 * - `max_len`: The number of Bytes available starting from
344 * `content`. This must be `>= *content_size`.
345 * - `rec_type`: The desired record content type.
346 *
347 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100348 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
349 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100350 *
351 * Returns:
352 * - `0` on success.
353 * - A negative error code if `max_len` didn't offer enough space
354 * for the expansion.
355 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100356static int ssl_build_inner_plaintext( unsigned char *content,
357 size_t *content_size,
358 size_t remaining,
Hanno Becker13996922020-05-28 16:15:19 +0100359 uint8_t rec_type,
360 size_t pad )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361{
362 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100363
364 /* Write real content type */
365 if( remaining == 0 )
366 return( -1 );
367 content[ len ] = rec_type;
368 len++;
369 remaining--;
370
371 if( remaining < pad )
372 return( -1 );
373 memset( content + len, 0, pad );
374 len += pad;
375 remaining -= pad;
376
377 *content_size = len;
378 return( 0 );
379}
380
Hanno Becker581bc1b2020-05-04 12:20:03 +0100381/* This function parses a (D)TLSInnerPlaintext structure.
382 * See ssl_build_inner_plaintext() for details. */
383static int ssl_parse_inner_plaintext( unsigned char const *content,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384 size_t *content_size,
385 uint8_t *rec_type )
386{
387 size_t remaining = *content_size;
388
389 /* Determine length of padding by skipping zeroes from the back. */
390 do
391 {
392 if( remaining == 0 )
393 return( -1 );
394 remaining--;
395 } while( content[ remaining ] == 0 );
396
397 *content_size = remaining;
398 *rec_type = content[ remaining ];
399
400 return( 0 );
401}
Hanno Beckerccc13d02020-05-04 12:30:04 +0100402#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID ||
403 MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100404
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100405/* `add_data` must have size 13 Bytes if the CID extension is disabled,
Hanno Beckerc4a190b2019-05-08 18:15:21 +0100406 * and 13 + 1 + CID-length Bytes if the CID extension is enabled. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000407static void ssl_extract_add_data_from_record( unsigned char* add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100408 size_t *add_data_len,
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100409 mbedtls_record *rec,
410 unsigned minor_ver )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000411{
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100412 /* Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100413 *
414 * additional_data = seq_num + TLSCompressed.type +
415 * TLSCompressed.version + TLSCompressed.length;
416 *
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100417 * For the CID extension, this is extended as follows
418 * (quoting draft-ietf-tls-dtls-connection-id-05,
419 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05):
Hanno Beckercab87e62019-04-29 13:52:53 +0100420 *
421 * additional_data = seq_num + DTLSPlaintext.type +
422 * DTLSPlaintext.version +
Hanno Beckerd5aeab12019-05-20 14:50:53 +0100423 * cid +
424 * cid_length +
Hanno Beckercab87e62019-04-29 13:52:53 +0100425 * length_of_DTLSInnerPlaintext;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100426 *
427 * For TLS 1.3, the record sequence number is dropped from the AAD
428 * and encoded within the nonce of the AEAD operation instead.
Hanno Beckercab87e62019-04-29 13:52:53 +0100429 */
430
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100431 unsigned char *cur = add_data;
432
433#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
434 if( minor_ver != MBEDTLS_SSL_MINOR_VERSION_4 )
435#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
436 {
437 ((void) minor_ver);
438 memcpy( cur, rec->ctr, sizeof( rec->ctr ) );
439 cur += sizeof( rec->ctr );
440 }
441
442 *cur = rec->type;
443 cur++;
444
445 memcpy( cur, rec->ver, sizeof( rec->ver ) );
446 cur += sizeof( rec->ver );
Hanno Beckercab87e62019-04-29 13:52:53 +0100447
Hanno Beckera0e20d02019-05-15 14:03:01 +0100448#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100449 if( rec->cid_len != 0 )
450 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100451 memcpy( cur, rec->cid, rec->cid_len );
452 cur += rec->cid_len;
453
454 *cur = rec->cid_len;
455 cur++;
456
457 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
458 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
459 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100460 }
461 else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100462#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100463 {
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100464 cur[0] = ( rec->data_len >> 8 ) & 0xFF;
465 cur[1] = ( rec->data_len >> 0 ) & 0xFF;
466 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100467 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100468
469 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000470}
471
Hanno Becker9d062f92020-02-07 10:26:36 +0000472#if defined(MBEDTLS_SSL_PROTO_SSL3)
473
474#define SSL3_MAC_MAX_BYTES 20 /* MD-5 or SHA-1 */
475
476/*
477 * SSLv3.0 MAC functions
478 */
479static void ssl_mac( mbedtls_md_context_t *md_ctx,
480 const unsigned char *secret,
481 const unsigned char *buf, size_t len,
482 const unsigned char *ctr, int type,
483 unsigned char out[SSL3_MAC_MAX_BYTES] )
484{
485 unsigned char header[11];
486 unsigned char padding[48];
487 int padlen;
488 int md_size = mbedtls_md_get_size( md_ctx->md_info );
489 int md_type = mbedtls_md_get_type( md_ctx->md_info );
490
491 /* Only MD5 and SHA-1 supported */
492 if( md_type == MBEDTLS_MD_MD5 )
493 padlen = 48;
494 else
495 padlen = 40;
496
497 memcpy( header, ctr, 8 );
498 header[ 8] = (unsigned char) type;
499 header[ 9] = (unsigned char)( len >> 8 );
500 header[10] = (unsigned char)( len );
501
502 memset( padding, 0x36, padlen );
503 mbedtls_md_starts( md_ctx );
504 mbedtls_md_update( md_ctx, secret, md_size );
505 mbedtls_md_update( md_ctx, padding, padlen );
506 mbedtls_md_update( md_ctx, header, 11 );
507 mbedtls_md_update( md_ctx, buf, len );
508 mbedtls_md_finish( md_ctx, out );
509
510 memset( padding, 0x5C, padlen );
511 mbedtls_md_starts( md_ctx );
512 mbedtls_md_update( md_ctx, secret, md_size );
513 mbedtls_md_update( md_ctx, padding, padlen );
514 mbedtls_md_update( md_ctx, out, md_size );
515 mbedtls_md_finish( md_ctx, out );
516}
517#endif /* MBEDTLS_SSL_PROTO_SSL3 */
518
Hanno Becker67a37db2020-05-28 16:27:07 +0100519#if defined(MBEDTLS_GCM_C) || \
520 defined(MBEDTLS_CCM_C) || \
521 defined(MBEDTLS_CHACHAPOLY_C)
Hanno Becker17263802020-05-28 07:05:48 +0100522static int ssl_transform_aead_dynamic_iv_is_explicit(
523 mbedtls_ssl_transform const *transform )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100524{
Hanno Becker17263802020-05-28 07:05:48 +0100525 return( transform->ivlen != transform->fixed_ivlen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100526}
527
Hanno Becker17263802020-05-28 07:05:48 +0100528/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
529 *
530 * Concretely, this occurs in two variants:
531 *
532 * a) Fixed and dynamic IV lengths add up to total IV length, giving
533 * IV = fixed_iv || dynamic_iv
534 *
Hanno Becker15952812020-06-04 13:31:46 +0100535 * This variant is used in TLS 1.2 when used with GCM or CCM.
536 *
Hanno Becker17263802020-05-28 07:05:48 +0100537 * b) Fixed IV lengths matches total IV length, giving
538 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100539 *
540 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
541 *
542 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100543 *
544 * This function has the precondition that
545 *
546 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
547 *
548 * which has to be ensured by the caller. If this precondition
549 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100550 */
551static void ssl_build_record_nonce( unsigned char *dst_iv,
552 size_t dst_iv_len,
553 unsigned char const *fixed_iv,
554 size_t fixed_iv_len,
555 unsigned char const *dynamic_iv,
556 size_t dynamic_iv_len )
557{
558 size_t i;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100559
560 /* Start with Fixed IV || 0 */
Hanno Becker17263802020-05-28 07:05:48 +0100561 memset( dst_iv, 0, dst_iv_len );
562 memcpy( dst_iv, fixed_iv, fixed_iv_len );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100563
Hanno Becker17263802020-05-28 07:05:48 +0100564 dst_iv += dst_iv_len - dynamic_iv_len;
565 for( i = 0; i < dynamic_iv_len; i++ )
566 dst_iv[i] ^= dynamic_iv[i];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100567}
Hanno Becker67a37db2020-05-28 16:27:07 +0100568#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100569
Hanno Beckera18d1322018-01-03 14:27:32 +0000570int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
571 mbedtls_ssl_transform *transform,
572 mbedtls_record *rec,
573 int (*f_rng)(void *, unsigned char *, size_t),
574 void *p_rng )
Paul Bakker5121ce52009-01-03 21:22:43 +0000575{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576 mbedtls_cipher_mode_t mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100577 int auth_done = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000578 unsigned char * data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +0100579 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +0100580 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000581 size_t post_avail;
582
583 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000584#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200585 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000586 ((void) ssl);
587#endif
588
589 /* The PRNG is used for dynamic IV generation that's used
590 * for CBC transformations in TLS 1.1 and TLS 1.2. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200591#if !( defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000592 ( defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2) ) )
593 ((void) f_rng);
594 ((void) p_rng);
595#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000598
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000599 if( transform == NULL )
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100600 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000601 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no transform provided to encrypt_buf" ) );
602 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
603 }
Hanno Becker43c24b82019-05-01 09:45:57 +0100604 if( rec == NULL
605 || rec->buf == NULL
606 || rec->buf_len < rec->data_offset
607 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100608#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100609 || rec->cid_len != 0
610#endif
611 )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000612 {
613 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to encrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100615 }
616
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000617 data = rec->buf + rec->data_offset;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100618 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619 MBEDTLS_SSL_DEBUG_BUF( 4, "before encrypt: output payload",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000620 data, rec->data_len );
621
622 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc );
623
624 if( rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN )
625 {
626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record content %u too large, maximum %d",
627 (unsigned) rec->data_len,
628 MBEDTLS_SSL_OUT_CONTENT_LEN ) );
629 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
630 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100631
Hanno Becker92313402020-05-20 13:58:58 +0100632 /* The following two code paths implement the (D)TLSInnerPlaintext
633 * structure present in TLS 1.3 and DTLS 1.2 + CID.
634 *
635 * See ssl_build_inner_plaintext() for more information.
636 *
637 * Note that this changes `rec->data_len`, and hence
638 * `post_avail` needs to be recalculated afterwards.
639 *
640 * Note also that the two code paths cannot occur simultaneously
641 * since they apply to different versions of the protocol. There
642 * is hence no risk of double-addition of the inner plaintext.
643 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100644#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
645 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
646 {
Hanno Becker13996922020-05-28 16:15:19 +0100647 size_t padding =
648 ssl_compute_padding_length( rec->data_len,
Hanno Beckerceef8482020-06-02 06:16:00 +0100649 MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY );
Hanno Beckerccc13d02020-05-04 12:30:04 +0100650 if( ssl_build_inner_plaintext( data,
Hanno Becker13996922020-05-28 16:15:19 +0100651 &rec->data_len,
652 post_avail,
653 rec->type,
654 padding ) != 0 )
Hanno Beckerccc13d02020-05-04 12:30:04 +0100655 {
656 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
657 }
658
659 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
660 }
661#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
662
Hanno Beckera0e20d02019-05-15 14:03:01 +0100663#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100664 /*
665 * Add CID information
666 */
667 rec->cid_len = transform->out_cid_len;
668 memcpy( rec->cid, transform->out_cid, transform->out_cid_len );
669 MBEDTLS_SSL_DEBUG_BUF( 3, "CID", rec->cid, rec->cid_len );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100670
671 if( rec->cid_len != 0 )
672 {
Hanno Becker13996922020-05-28 16:15:19 +0100673 size_t padding =
674 ssl_compute_padding_length( rec->data_len,
675 MBEDTLS_SSL_CID_PADDING_GRANULARITY );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100676 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100677 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100678 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100679 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100680 * Note that this changes `rec->data_len`, and hence
681 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100682 */
Hanno Becker581bc1b2020-05-04 12:20:03 +0100683 if( ssl_build_inner_plaintext( data,
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100684 &rec->data_len,
685 post_avail,
Hanno Becker13996922020-05-28 16:15:19 +0100686 rec->type,
687 padding ) != 0 )
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100688 {
689 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
690 }
691
692 rec->type = MBEDTLS_SSL_MSG_CID;
693 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100694#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100695
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100696 post_avail = rec->buf_len - ( rec->data_len + rec->data_offset );
697
Paul Bakker5121ce52009-01-03 21:22:43 +0000698 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100699 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000700 */
Hanno Becker52344c22018-01-03 15:24:20 +0000701#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 if( mode == MBEDTLS_MODE_STREAM ||
703 ( mode == MBEDTLS_MODE_CBC
704#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000705 && transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100706#endif
707 ) )
Paul Bakker5121ce52009-01-03 21:22:43 +0000708 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000709 if( post_avail < transform->maclen )
710 {
711 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
712 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
713 }
714
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000716 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200717 {
Hanno Becker9d062f92020-02-07 10:26:36 +0000718 unsigned char mac[SSL3_MAC_MAX_BYTES];
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000719 ssl_mac( &transform->md_ctx_enc, transform->mac_enc,
720 data, rec->data_len, rec->ctr, rec->type, mac );
721 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200722 }
723 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200724#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
726 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000727 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200728 {
Hanno Becker992b6872017-11-09 18:57:39 +0000729 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
730
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100731 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
732 transform->minor_ver );
Hanno Becker992b6872017-11-09 18:57:39 +0000733
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000734 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +0100735 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000736 mbedtls_md_hmac_update( &transform->md_ctx_enc,
737 data, rec->data_len );
738 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
739 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
740
741 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200742 }
743 else
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200744#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200745 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
747 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200748 }
749
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000750 MBEDTLS_SSL_DEBUG_BUF( 4, "computed mac", data + rec->data_len,
751 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200752
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753 rec->data_len += transform->maclen;
754 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100755 auth_done++;
Paul Bakker577e0062013-08-28 11:57:20 +0200756 }
Hanno Becker52344c22018-01-03 15:24:20 +0000757#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000758
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200759 /*
760 * Encrypt
761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
763 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker5121ce52009-01-03 21:22:43 +0000764 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000766 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000768 "including %d bytes of padding",
769 rec->data_len, 0 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000770
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000771 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
772 transform->iv_enc, transform->ivlen,
773 data, rec->data_len,
774 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200775 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200777 return( ret );
778 }
779
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000780 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200781 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200782 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
783 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +0200784 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000785 }
Paul Bakker68884e32013-01-07 18:20:04 +0100786 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000788
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200789#if defined(MBEDTLS_GCM_C) || \
790 defined(MBEDTLS_CCM_C) || \
791 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200793 mode == MBEDTLS_MODE_CCM ||
794 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +0000795 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000796 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200797 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100798 unsigned char *dynamic_iv;
799 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100800 int dynamic_iv_is_explicit =
801 ssl_transform_aead_dynamic_iv_is_explicit( transform );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000802
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100803 /* Check that there's space for the authentication tag. */
804 if( post_avail < transform->taglen )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000805 {
806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
807 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
808 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000809
Paul Bakker68884e32013-01-07 18:20:04 +0100810 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100811 * Build nonce for AEAD encryption.
812 *
813 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
814 * part of the IV is prepended to the ciphertext and
815 * can be chosen freely - in particular, it need not
816 * agree with the record sequence number.
817 * However, since ChaChaPoly as well as all AEAD modes
818 * in TLS 1.3 use the record sequence number as the
819 * dynamic part of the nonce, we uniformly use the
820 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100821 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100822 dynamic_iv = rec->ctr;
823 dynamic_iv_len = sizeof( rec->ctr );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200824
Hanno Becker17263802020-05-28 07:05:48 +0100825 ssl_build_record_nonce( iv, sizeof( iv ),
826 transform->iv_enc,
827 transform->fixed_ivlen,
828 dynamic_iv,
829 dynamic_iv_len );
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100830
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 /*
832 * Build additional data for AEAD encryption.
833 * This depends on the TLS version.
834 */
835 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
836 transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +0100837
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200838 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (internal)",
Hanno Becker7cca3582020-06-04 13:27:22 +0100839 iv, transform->ivlen );
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200840 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used (transmitted)",
Hanno Becker16bf0e22020-06-04 13:27:34 +0100841 dynamic_iv,
842 dynamic_iv_is_explicit ? dynamic_iv_len : 0 );
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000843 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +0100844 add_data, add_data_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200846 "including 0 bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000847 rec->data_len ) );
Paul Bakkerca4ab492012-04-18 14:23:57 +0000848
Paul Bakker68884e32013-01-07 18:20:04 +0100849 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200850 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200851 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200853 if( ( ret = mbedtls_cipher_auth_encrypt( &transform->cipher_ctx_enc,
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000854 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +0100855 add_data, add_data_len, /* add data */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000856 data, rec->data_len, /* source */
857 data, &rec->data_len, /* destination */
858 data + rec->data_len, transform->taglen ) ) != 0 )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_encrypt", ret );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200861 return( ret );
862 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 MBEDTLS_SSL_DEBUG_BUF( 4, "after encrypt: tag",
864 data + rec->data_len, transform->taglen );
Hanno Beckerdf8be222020-05-21 15:30:57 +0100865 /* Account for authentication tag. */
866 rec->data_len += transform->taglen;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000867 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868
869 /*
870 * Prefix record content with dynamic IV in case it is explicit.
871 */
Hanno Becker1cda2662020-06-04 13:28:28 +0100872 if( dynamic_iv_is_explicit != 0 )
Hanno Beckerdf8be222020-05-21 15:30:57 +0100873 {
874 if( rec->data_offset < dynamic_iv_len )
875 {
876 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
877 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
878 }
879
880 memcpy( data - dynamic_iv_len, dynamic_iv, dynamic_iv_len );
881 rec->data_offset -= dynamic_iv_len;
882 rec->data_len += dynamic_iv_len;
883 }
884
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100885 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000886 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000887 else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +0100888#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200889#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 {
Janos Follath865b3eb2019-12-16 11:46:15 +0000892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000893 size_t padlen, i;
894 size_t olen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000895
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000896 /* Currently we're always using minimal padding
897 * (up to 255 bytes would be allowed). */
898 padlen = transform->ivlen - ( rec->data_len + 1 ) % transform->ivlen;
899 if( padlen == transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 padlen = 0;
901
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000902 /* Check there's enough space in the buffer for the padding. */
903 if( post_avail < padlen + 1 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
906 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
907 }
908
Paul Bakker5121ce52009-01-03 21:22:43 +0000909 for( i = 0; i <= padlen; i++ )
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000910 data[rec->data_len + i] = (unsigned char) padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +0000911
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000912 rec->data_len += padlen + 1;
913 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000916 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000917 * Prepend per-record IV for block cipher in TLS v1.1 and up as per
918 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000919 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000920 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000921 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000922 if( f_rng == NULL )
923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No PRNG provided to encrypt_record routine" ) );
925 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
926 }
927
928 if( rec->data_offset < transform->ivlen )
929 {
930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
931 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
932 }
933
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000934 /*
935 * Generate IV
936 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000937 ret = f_rng( p_rng, transform->iv_enc, transform->ivlen );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000938 if( ret != 0 )
939 return( ret );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000940
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000941 memcpy( data - transform->ivlen, transform->iv_enc,
942 transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000943
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000944 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before encrypt: msglen = %d, "
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000948 "including %d bytes of IV and %d bytes of padding",
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000949 rec->data_len, transform->ivlen,
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200950 padlen + 1 ) );
Paul Bakker5121ce52009-01-03 21:22:43 +0000951
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000952 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_enc,
953 transform->iv_enc,
954 transform->ivlen,
955 data, rec->data_len,
956 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +0200957 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +0200959 return( ret );
960 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200961
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000962 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +0200963 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
965 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +0200966 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +0200967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +0200970 {
971 /*
972 * Save IV in SSL3 and TLS1
973 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000974 memcpy( transform->iv_enc, transform->cipher_ctx_enc.iv,
975 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000976 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000977 else
Paul Bakkercca5b812013-08-31 17:40:26 +0200978#endif
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000979 {
980 data -= transform->ivlen;
981 rec->data_offset -= transform->ivlen;
982 rec->data_len += transform->ivlen;
983 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100986 if( auth_done == 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100987 {
Hanno Becker3d8c9072018-01-05 16:24:22 +0000988 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
989
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100990 /*
991 * MAC(MAC_write_key, seq_num +
992 * TLSCipherText.type +
993 * TLSCipherText.version +
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +0100994 * length_of( (IV +) ENC(...) ) +
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +0100995 * IV + // except for TLS 1.0
996 * ENC(content + padding + padding_length));
997 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000998
999 if( post_avail < transform->maclen)
1000 {
1001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Buffer provided for encrypted record not large enough" ) );
1002 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
1003 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001004
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001005 ssl_extract_add_data_from_record( add_data, &add_data_len,
1006 rec, transform->minor_ver );
Hanno Becker1f10d762019-04-26 13:34:37 +01001007
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001009 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001010 add_data_len );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001011
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 mbedtls_md_hmac_update( &transform->md_ctx_enc, add_data,
Hanno Beckercab87e62019-04-29 13:52:53 +01001013 add_data_len );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001014 mbedtls_md_hmac_update( &transform->md_ctx_enc,
1015 data, rec->data_len );
1016 mbedtls_md_hmac_finish( &transform->md_ctx_enc, mac );
1017 mbedtls_md_hmac_reset( &transform->md_ctx_enc );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001018
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001019 memcpy( data + rec->data_len, mac, transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001020
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001021 rec->data_len += transform->maclen;
1022 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001023 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001024 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001027 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001028#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001029 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1031 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001032 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001033
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001034 /* Make extra sure authentication was performed, exactly once */
1035 if( auth_done != 1 )
1036 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1038 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001039 }
1040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= encrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001042
1043 return( 0 );
1044}
1045
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001046#if defined(MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001047/*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001048 * Constant-flow conditional memcpy:
1049 * - if c1 == c2, equivalent to memcpy(dst, src, len),
1050 * - otherwise, a no-op,
1051 * but with execution flow independent of the values of c1 and c2.
1052 *
1053 * Use only bit operations to avoid branches that could be used by some
1054 * compilers on some platforms to translate comparison operators.
1055 */
Manuel Pégourié-Gonnarde7478432020-07-24 11:09:22 +02001056static void mbedtls_ssl_cf_memcpy_if_eq( unsigned char *dst,
1057 const unsigned char *src,
1058 size_t len,
1059 size_t c1, size_t c2 )
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001060{
1061 /* diff = 0 if c1 == c2, non-zero otherwise */
1062 const size_t diff = c1 ^ c2;
1063
1064 /* MSVC has a warning about unary minus on unsigned integer types,
1065 * but this is well-defined and precisely what we want to do here. */
1066#if defined(_MSC_VER)
1067#pragma warning( push )
1068#pragma warning( disable : 4146 )
1069#endif
1070
Manuel Pégourié-Gonnardf0095422020-07-24 11:13:01 +02001071 /* diff_msb's most significant bit is equal to c1 != c2 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001072 const size_t diff_msb = ( diff | -diff );
1073
1074 /* diff1 = c1 != c2 */
1075 const size_t diff1 = diff_msb >> ( sizeof( diff_msb ) * 8 - 1 );
1076
1077 /* mask = c1 != c2 ? 0xff : 0x00 */
Manuel Pégourié-Gonnardf0095422020-07-24 11:13:01 +02001078 const unsigned char mask = (unsigned char) -diff1;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001079
1080#if defined(_MSC_VER)
1081#pragma warning( pop )
1082#endif
1083
1084 /* dst[i] = c1 != c2 ? dst[i] : src[i] */
1085 for( size_t i = 0; i < len; i++ )
1086 dst[i] = ( dst[i] & mask ) | ( src[i] & ~mask );
1087}
1088
1089/*
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001090 * Compute HMAC of variable-length data with constant flow.
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001091 *
1092 * Only works with MD-5, SHA-1, SHA-256 and SHA-384.
1093 * (Otherwise, computation of block_size needs to be adapted.)
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001094 */
Manuel Pégourié-Gonnard65a6fa32020-07-09 09:52:17 +02001095MBEDTLS_STATIC_TESTABLE int mbedtls_ssl_cf_hmac(
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001096 mbedtls_md_context_t *ctx,
1097 const unsigned char *add_data, size_t add_data_len,
1098 const unsigned char *data, size_t data_len_secret,
1099 size_t min_data_len, size_t max_data_len,
1100 unsigned char *output )
1101{
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001102 /*
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001103 * This function breaks the HMAC abstraction and uses the md_clone()
1104 * extension to the MD API in order to get constant-flow behaviour.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001105 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001106 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001107 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001108 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001109 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001110 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
1111 * minlen, then cloning the context, and for each byte up to maxlen
1112 * finishing up the hash computation, keeping only the correct result.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001113 *
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001114 * Then we only need to compute HASH(okey + inner_hash) and we're done.
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001115 */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001116 const mbedtls_md_type_t md_alg = mbedtls_md_get_type( ctx->md_info );
Manuel Pégourié-Gonnardbaccf802020-07-22 10:37:27 +02001117 /* TLS 1.0-1.2 only support SHA-384, SHA-256, SHA-1, MD-5,
1118 * all of which have the same block size except SHA-384. */
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001119 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
Manuel Pégourié-Gonnard9713e132020-07-22 10:40:31 +02001120 const unsigned char * const ikey = ctx->hmac_ctx;
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001121 const unsigned char * const okey = ikey + block_size;
1122 const size_t hash_size = mbedtls_md_get_size( ctx->md_info );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001123
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001124 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
1125 mbedtls_md_context_t aux;
1126 size_t offset;
Manuel Pégourié-Gonnarde0765f32020-07-22 12:22:51 +02001127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001128
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001129 mbedtls_md_init( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001130
1131#define MD_CHK( func_call ) \
1132 do { \
1133 ret = (func_call); \
1134 if( ret != 0 ) \
1135 goto cleanup; \
1136 } while( 0 )
1137
1138 MD_CHK( mbedtls_md_setup( &aux, ctx->md_info, 0 ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001139
1140 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
1141 * so we can start directly with the message */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001142 MD_CHK( mbedtls_md_update( ctx, add_data, add_data_len ) );
1143 MD_CHK( mbedtls_md_update( ctx, data, min_data_len ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001144
1145 /* For each possible length, compute the hash up to that point */
1146 for( offset = min_data_len; offset <= max_data_len; offset++ )
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001147 {
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001148 MD_CHK( mbedtls_md_clone( &aux, ctx ) );
1149 MD_CHK( mbedtls_md_finish( &aux, aux_out ) );
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001150 /* Keep only the correct inner_hash in the output buffer */
1151 mbedtls_ssl_cf_memcpy_if_eq( output, aux_out, hash_size,
1152 offset, data_len_secret );
1153
1154 if( offset < max_data_len )
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001155 MD_CHK( mbedtls_md_update( ctx, data + offset, 1 ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001156 }
1157
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001158 /* Now compute HASH(okey + inner_hash) */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001159 MD_CHK( mbedtls_md_starts( ctx ) );
1160 MD_CHK( mbedtls_md_update( ctx, okey, block_size ) );
1161 MD_CHK( mbedtls_md_update( ctx, output, hash_size ) );
1162 MD_CHK( mbedtls_md_finish( ctx, output ) );
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001163
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001164 /* Done, get ready for next time */
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001165 MD_CHK( mbedtls_md_hmac_reset( ctx ) );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001166
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001167#undef MD_CHK
1168
1169cleanup:
Manuel Pégourié-Gonnard7a8b1e62020-07-15 11:52:14 +02001170 mbedtls_md_free( &aux );
Manuel Pégourié-Gonnard44c9fdd2020-07-22 10:48:47 +02001171 return( ret );
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001172}
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001173
1174/*
1175 * Constant-flow memcpy from variable position in buffer.
1176 * - functionally equivalent to memcpy(dst, src + offset_secret, len)
Manuel Pégourié-Gonnardba6fc972020-08-24 12:59:55 +02001177 * - but with execution flow independent from the value of offset_secret.
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001178 */
1179MBEDTLS_STATIC_TESTABLE void mbedtls_ssl_cf_memcpy_offset(
1180 unsigned char *dst,
1181 const unsigned char *src_base,
1182 size_t offset_secret,
1183 size_t offset_min, size_t offset_max,
1184 size_t len )
1185{
Manuel Pégourié-Gonnardde1cf2c52020-08-19 12:35:30 +02001186 size_t offset;
1187
1188 for( offset = offset_min; offset <= offset_max; offset++ )
1189 {
1190 mbedtls_ssl_cf_memcpy_if_eq( dst, src_base + offset, len,
1191 offset, offset_secret );
1192 }
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001193}
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +02001194#endif /* MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC */
Manuel Pégourié-Gonnard045f0942020-07-02 11:34:02 +02001195
Hanno Becker605949f2019-07-12 08:23:59 +01001196int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001197 mbedtls_ssl_transform *transform,
1198 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00001199{
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001200 size_t olen;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 mbedtls_cipher_mode_t mode;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001202 int ret, auth_done = 0;
Hanno Becker52344c22018-01-03 15:24:20 +00001203#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001204 size_t padlen = 0, correct = 1;
1205#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001206 unsigned char* data;
Hanno Becker92fb4fa2019-05-20 14:54:26 +01001207 unsigned char add_data[13 + 1 + MBEDTLS_SSL_CID_IN_LEN_MAX ];
Hanno Beckercab87e62019-04-29 13:52:53 +01001208 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001209
Hanno Beckera18d1322018-01-03 14:27:32 +00001210#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001211 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001212 ((void) ssl);
1213#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001214
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decrypt buf" ) );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001216 if( rec == NULL ||
1217 rec->buf == NULL ||
1218 rec->buf_len < rec->data_offset ||
1219 rec->buf_len - rec->data_offset < rec->data_len )
1220 {
1221 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad record structure provided to decrypt_buf" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001223 }
1224
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001225 data = rec->buf + rec->data_offset;
1226 mode = mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_dec );
Paul Bakker5121ce52009-01-03 21:22:43 +00001227
Hanno Beckera0e20d02019-05-15 14:03:01 +01001228#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001229 /*
1230 * Match record's CID with incoming CID.
1231 */
Hanno Becker938489a2019-05-08 13:02:22 +01001232 if( rec->cid_len != transform->in_cid_len ||
1233 memcmp( rec->cid, transform->in_cid, rec->cid_len ) != 0 )
1234 {
Hanno Becker8367ccc2019-05-14 11:30:10 +01001235 return( MBEDTLS_ERR_SSL_UNEXPECTED_CID );
Hanno Becker938489a2019-05-08 13:02:22 +01001236 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001237#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER)
1240 if( mode == MBEDTLS_MODE_STREAM )
Paul Bakker68884e32013-01-07 18:20:04 +01001241 {
1242 padlen = 0;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001243 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1244 transform->iv_dec,
1245 transform->ivlen,
1246 data, rec->data_len,
1247 data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001248 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001249 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001250 return( ret );
1251 }
1252
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001253 if( rec->data_len != olen )
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001254 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1256 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkerea6ad3f2013-09-02 14:57:01 +02001257 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001258 }
Paul Bakker68884e32013-01-07 18:20:04 +01001259 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#endif /* MBEDTLS_ARC4_C || MBEDTLS_CIPHER_NULL_CIPHER */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001261#if defined(MBEDTLS_GCM_C) || \
1262 defined(MBEDTLS_CCM_C) || \
1263 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001264 if( mode == MBEDTLS_MODE_GCM ||
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001265 mode == MBEDTLS_MODE_CCM ||
1266 mode == MBEDTLS_MODE_CHACHAPOLY )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001267 {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001268 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001269 unsigned char *dynamic_iv;
1270 size_t dynamic_iv_len;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001271
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001272 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001273 * Extract dynamic part of nonce for AEAD decryption.
1274 *
1275 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1276 * part of the IV is prepended to the ciphertext and
1277 * can be chosen freely - in particular, it need not
1278 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001279 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001280 dynamic_iv_len = sizeof( rec->ctr );
Hanno Becker17263802020-05-28 07:05:48 +01001281 if( ssl_transform_aead_dynamic_iv_is_explicit( transform ) == 1 )
Hanno Beckerdf8be222020-05-21 15:30:57 +01001282 {
1283 if( rec->data_len < dynamic_iv_len )
1284 {
1285 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < explicit_iv_len (%d) ",
1286 rec->data_len,
1287 dynamic_iv_len ) );
1288 return( MBEDTLS_ERR_SSL_INVALID_MAC );
1289 }
1290 dynamic_iv = data;
1291
1292 data += dynamic_iv_len;
1293 rec->data_offset += dynamic_iv_len;
1294 rec->data_len -= dynamic_iv_len;
1295 }
Hanno Becker17263802020-05-28 07:05:48 +01001296 else
1297 {
1298 dynamic_iv = rec->ctr;
1299 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001300
1301 /* Check that there's space for the authentication tag. */
1302 if( rec->data_len < transform->taglen )
1303 {
1304 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < taglen (%d) " ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001306 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001307 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001308
Hanno Beckerdf8be222020-05-21 15:30:57 +01001309 /*
1310 * Prepare nonce from dynamic and static parts.
1311 */
Hanno Becker17263802020-05-28 07:05:48 +01001312 ssl_build_record_nonce( iv, sizeof( iv ),
1313 transform->iv_dec,
1314 transform->fixed_ivlen,
1315 dynamic_iv,
1316 dynamic_iv_len );
Paul Bakker68884e32013-01-07 18:20:04 +01001317
Hanno Beckerdf8be222020-05-21 15:30:57 +01001318 /*
1319 * Build additional data for AEAD encryption.
1320 * This depends on the TLS version.
1321 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001322 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1323 transform->minor_ver );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 MBEDTLS_SSL_DEBUG_BUF( 4, "additional data used for AEAD",
Hanno Beckercab87e62019-04-29 13:52:53 +01001325 add_data, add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001326
Hanno Beckerd96a6522019-07-10 13:55:25 +01001327 /* Because of the check above, we know that there are
1328 * explicit_iv_len Bytes preceeding data, and taglen
1329 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001330 * the debug message and the invocation of
Hanno Beckerd96a6522019-07-10 13:55:25 +01001331 * mbedtls_cipher_auth_decrypt() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001332
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001333 MBEDTLS_SSL_DEBUG_BUF( 4, "IV used", iv, transform->ivlen );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 MBEDTLS_SSL_DEBUG_BUF( 4, "TAG used", data + rec->data_len,
Hanno Beckere694c3e2017-12-27 21:34:08 +00001335 transform->taglen );
Paul Bakker68884e32013-01-07 18:20:04 +01001336
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001337 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001338 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001339 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001340 if( ( ret = mbedtls_cipher_auth_decrypt( &transform->cipher_ctx_dec,
1341 iv, transform->ivlen,
Hanno Beckercab87e62019-04-29 13:52:53 +01001342 add_data, add_data_len,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001343 data, rec->data_len,
1344 data, &olen,
1345 data + rec->data_len,
1346 transform->taglen ) ) != 0 )
Paul Bakkerca4ab492012-04-18 14:23:57 +00001347 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_auth_decrypt", ret );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350 if( ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED )
1351 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001352
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001353 return( ret );
1354 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001355 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001356
Hanno Beckerd96a6522019-07-10 13:55:25 +01001357 /* Double-check that AEAD decryption doesn't change content length. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001358 if( olen != rec->data_len )
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1361 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001362 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001363 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367 if( mode == MBEDTLS_MODE_CBC )
Paul Bakker5121ce52009-01-03 21:22:43 +00001368 {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001369 size_t minlen = 0;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001370
Paul Bakker5121ce52009-01-03 21:22:43 +00001371 /*
Paul Bakker45829992013-01-03 14:52:21 +01001372 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001374#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001375 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
1376 {
1377 /* The ciphertext is prefixed with the CBC IV. */
1378 minlen += transform->ivlen;
1379 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001380#endif
Paul Bakker45829992013-01-03 14:52:21 +01001381
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001382 /* Size considerations:
1383 *
1384 * - The CBC cipher text must not be empty and hence
1385 * at least of size transform->ivlen.
1386 *
1387 * Together with the potential IV-prefix, this explains
1388 * the first of the two checks below.
1389 *
1390 * - The record must contain a MAC, either in plain or
1391 * encrypted, depending on whether Encrypt-then-MAC
1392 * is used or not.
1393 * - If it is, the message contains the IV-prefix,
1394 * the CBC ciphertext, and the MAC.
1395 * - If it is not, the padded plaintext, and hence
1396 * the CBC ciphertext, has at least length maclen + 1
1397 * because there is at least the padding length byte.
1398 *
1399 * As the CBC ciphertext is not empty, both cases give the
1400 * lower bound minlen + maclen + 1 on the record size, which
1401 * we test for in the second check below.
1402 */
1403 if( rec->data_len < minlen + transform->ivlen ||
1404 rec->data_len < minlen + transform->maclen + 1 )
Paul Bakker45829992013-01-03 14:52:21 +01001405 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < max( ivlen(%d), maclen (%d) "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001407 "+ 1 ) ( + expl IV )", rec->data_len,
1408 transform->ivlen,
1409 transform->maclen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Paul Bakker45829992013-01-03 14:52:21 +01001411 }
1412
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001413 /*
1414 * Authenticate before decrypt if enabled
1415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001417 if( transform->encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001418 {
Hanno Becker992b6872017-11-09 18:57:39 +00001419 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 MBEDTLS_SSL_DEBUG_MSG( 3, ( "using encrypt then mac" ) );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001422
Hanno Beckerd96a6522019-07-10 13:55:25 +01001423 /* Update data_len in tandem with add_data.
1424 *
1425 * The subtraction is safe because of the previous check
1426 * data_len >= minlen + maclen + 1.
1427 *
1428 * Afterwards, we know that data + data_len is followed by at
1429 * least maclen Bytes, which justifies the call to
1430 * mbedtls_ssl_safer_memcmp() below.
1431 *
1432 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001433 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001434 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1435 transform->minor_ver );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001436
Hanno Beckerd96a6522019-07-10 13:55:25 +01001437 /* Calculate expected MAC. */
Hanno Beckercab87e62019-04-29 13:52:53 +01001438 MBEDTLS_SSL_DEBUG_BUF( 4, "MAC'd meta-data", add_data,
1439 add_data_len );
1440 mbedtls_md_hmac_update( &transform->md_ctx_dec, add_data,
1441 add_data_len );
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001442 mbedtls_md_hmac_update( &transform->md_ctx_dec,
1443 data, rec->data_len );
1444 mbedtls_md_hmac_finish( &transform->md_ctx_dec, mac_expect );
1445 mbedtls_md_hmac_reset( &transform->md_ctx_dec );
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001446
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001447 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", data + rec->data_len,
1448 transform->maclen );
Hanno Becker992b6872017-11-09 18:57:39 +00001449 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 transform->maclen );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001451
Hanno Beckerd96a6522019-07-10 13:55:25 +01001452 /* Compare expected MAC with MAC at the end of the record. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001453 if( mbedtls_ssl_safer_memcmp( data + rec->data_len, mac_expect,
1454 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001455 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001458 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001459 auth_done++;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001460 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001462
1463 /*
1464 * Check length sanity
1465 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001466
1467 /* We know from above that data_len > minlen >= 0,
1468 * so the following check in particular implies that
1469 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001470 if( rec->data_len % transform->ivlen != 0 )
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001471 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001472 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) %% ivlen (%d) != 0",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001473 rec->data_len, transform->ivlen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001475 }
1476
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001478 /*
Paul Bakker1ef83d62012-04-11 12:09:53 +00001479 * Initialize for prepended IV for block cipher in TLS v1.1 and up
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001480 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001481 if( transform->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001482 {
Hanno Beckerd96a6522019-07-10 13:55:25 +01001483 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001484 memcpy( transform->iv_dec, data, transform->ivlen );
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001485
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001486 data += transform->ivlen;
1487 rec->data_offset += transform->ivlen;
1488 rec->data_len -= transform->ivlen;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001489 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001491
Hanno Beckerd96a6522019-07-10 13:55:25 +01001492 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1493
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 if( ( ret = mbedtls_cipher_crypt( &transform->cipher_ctx_dec,
1495 transform->iv_dec, transform->ivlen,
1496 data, rec->data_len, data, &olen ) ) != 0 )
Paul Bakker45125bc2013-09-04 16:47:11 +02001497 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_cipher_crypt", ret );
Paul Bakkercca5b812013-08-31 17:40:26 +02001499 return( ret );
1500 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001501
Hanno Beckerd96a6522019-07-10 13:55:25 +01001502 /* Double-check that length hasn't changed during decryption. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001503 if( rec->data_len != olen )
Paul Bakkercca5b812013-08-31 17:40:26 +02001504 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1506 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakkercca5b812013-08-31 17:40:26 +02001507 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001510 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
Paul Bakkercca5b812013-08-31 17:40:26 +02001511 {
1512 /*
Hanno Beckerd96a6522019-07-10 13:55:25 +01001513 * Save IV in SSL3 and TLS1, where CBC decryption of consecutive
1514 * records is equivalent to CBC decryption of the concatenation
1515 * of the records; in other words, IVs are maintained across
1516 * record decryptions.
Paul Bakkercca5b812013-08-31 17:40:26 +02001517 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001518 memcpy( transform->iv_dec, transform->cipher_ctx_dec.iv,
1519 transform->ivlen );
Paul Bakker5121ce52009-01-03 21:22:43 +00001520 }
Paul Bakkercca5b812013-08-31 17:40:26 +02001521#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001522
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001523 /* Safe since data_len >= minlen + maclen + 1, so after having
1524 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001525 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1526 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001528
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001529 if( auth_done == 1 )
1530 {
1531 correct *= ( rec->data_len >= padlen + 1 );
1532 padlen *= ( rec->data_len >= padlen + 1 );
1533 }
1534 else
Paul Bakker45829992013-01-03 14:52:21 +01001535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001537 if( rec->data_len < transform->maclen + padlen + 1 )
1538 {
1539 MBEDTLS_SSL_DEBUG_MSG( 1, ( "msglen (%d) < maclen (%d) + padlen (%d)",
1540 rec->data_len,
1541 transform->maclen,
1542 padlen + 1 ) );
1543 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001544#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001545
1546 correct *= ( rec->data_len >= transform->maclen + padlen + 1 );
1547 padlen *= ( rec->data_len >= transform->maclen + padlen + 1 );
Paul Bakker45829992013-01-03 14:52:21 +01001548 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001549
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001550 padlen++;
1551
1552 /* Regardless of the validity of the padding,
1553 * we have data_len >= padlen here. */
1554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001556 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001557 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001558 if( padlen > transform->ivlen )
Paul Bakker5121ce52009-01-03 21:22:43 +00001559 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#if defined(MBEDTLS_SSL_DEBUG_ALL)
1561 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding length: is %d, "
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001562 "should be no more than %d",
1563 padlen, transform->ivlen ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001564#endif
Paul Bakker45829992013-01-03 14:52:21 +01001565 correct = 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001566 }
1567 }
1568 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1570#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1571 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001572 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00001573 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001574 /* The padding check involves a series of up to 256
1575 * consecutive memory reads at the end of the record
1576 * plaintext buffer. In order to hide the length and
1577 * validity of the padding, always perform exactly
1578 * `min(256,plaintext_len)` reads (but take into account
1579 * only the last `padlen` bytes for the padding check). */
1580 size_t pad_count = 0;
1581 size_t real_count = 0;
1582 volatile unsigned char* const check = data;
Paul Bakkere47b34b2013-02-27 14:48:00 +01001583
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001584 /* Index of first padding byte; it has been ensured above
1585 * that the subtraction is safe. */
1586 size_t const padding_idx = rec->data_len - padlen;
1587 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1588 size_t const start_idx = rec->data_len - num_checks;
1589 size_t idx;
Paul Bakker956c9e02013-12-19 14:42:28 +01001590
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001591 for( idx = start_idx; idx < rec->data_len; idx++ )
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001592 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001593 real_count |= ( idx >= padding_idx );
1594 pad_count += real_count * ( check[idx] == padlen - 1 );
Paul Bakkerca9c87e2013-09-25 18:52:37 +02001595 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001596 correct &= ( pad_count == padlen );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598#if defined(MBEDTLS_SSL_DEBUG_ALL)
Paul Bakker66d5d072014-06-17 16:39:18 +02001599 if( padlen > 0 && correct == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad padding byte detected" ) );
Paul Bakkerd66f0702013-01-31 16:57:45 +01001601#endif
Paul Bakkere47b34b2013-02-27 14:48:00 +01001602 padlen &= correct * 0x1FF;
Paul Bakker5121ce52009-01-03 21:22:43 +00001603 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001604 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1606 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02001607 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1609 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02001610 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001611
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612 /* If the padding was found to be invalid, padlen == 0
1613 * and the subtraction is safe. If the padding was found valid,
1614 * padlen hasn't been changed and the previous assertion
1615 * data_len >= padlen still holds. */
1616 rec->data_len -= padlen;
Paul Bakker5121ce52009-01-03 21:22:43 +00001617 }
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001618 else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001619#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001620 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1622 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001623 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001624
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001625#if defined(MBEDTLS_SSL_DEBUG_ALL)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 MBEDTLS_SSL_DEBUG_BUF( 4, "raw buffer after decryption",
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001627 data, rec->data_len );
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001628#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001629
1630 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001631 * Authenticate if not done yet.
1632 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001633 */
Hanno Becker52344c22018-01-03 15:24:20 +00001634#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001635 if( auth_done == 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001636 {
Hanno Becker992b6872017-11-09 18:57:39 +00001637 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001638 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD];
Paul Bakker1e5369c2013-12-19 16:40:57 +01001639
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001640 /* If the initial value of padlen was such that
1641 * data_len < maclen + padlen + 1, then padlen
1642 * got reset to 1, and the initial check
1643 * data_len >= minlen + maclen + 1
1644 * guarantees that at this point we still
1645 * have at least data_len >= maclen.
1646 *
1647 * If the initial value of padlen was such that
1648 * data_len >= maclen + padlen + 1, then we have
1649 * subtracted either padlen + 1 (if the padding was correct)
1650 * or 0 (if the padding was incorrect) since then,
1651 * hence data_len >= maclen in any case.
1652 */
1653 rec->data_len -= transform->maclen;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001654 ssl_extract_add_data_from_record( add_data, &add_data_len, rec,
1655 transform->minor_ver );
Paul Bakker5121ce52009-01-03 21:22:43 +00001656
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001657#if defined(MBEDTLS_SSL_PROTO_SSL3)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001658 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001659 {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001660 ssl_mac( &transform->md_ctx_dec,
1661 transform->mac_dec,
1662 data, rec->data_len,
1663 rec->ctr, rec->type,
1664 mac_expect );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001665 memcpy( mac_peer, data + rec->data_len, transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001666 }
1667 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668#endif /* MBEDTLS_SSL_PROTO_SSL3 */
1669#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1670 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001671 if( transform->minor_ver > MBEDTLS_SSL_MINOR_VERSION_0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001672 {
1673 /*
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001674 * The next two sizes are the minimum and maximum values of
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001675 * data_len over all padlen values.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001676 *
1677 * They're independent of padlen, since we previously did
Hanno Beckerd96a6522019-07-10 13:55:25 +01001678 * data_len -= padlen.
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001679 *
1680 * Note that max_len + maclen is never more than the buffer
1681 * length, as we previously did in_msglen -= maclen too.
1682 */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001683 const size_t max_len = rec->data_len + padlen;
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001684 const size_t min_len = ( max_len > 256 ) ? max_len - 256 : 0;
1685
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001686 ret = mbedtls_ssl_cf_hmac( &transform->md_ctx_dec,
1687 add_data, add_data_len,
1688 data, rec->data_len, min_len, max_len,
1689 mac_expect );
1690 if( ret != 0 )
Gilles Peskine20b44082018-05-29 14:06:49 +02001691 {
Manuel Pégourié-Gonnard8aa29e32020-07-07 12:30:39 +02001692 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_cf_hmac", ret );
1693 return( ret );
Gilles Peskine20b44082018-05-29 14:06:49 +02001694 }
Paul Bakkere47b34b2013-02-27 14:48:00 +01001695
Manuel Pégourié-Gonnard7fe2c5f2020-08-18 12:02:54 +02001696 mbedtls_ssl_cf_memcpy_offset( mac_peer, data,
1697 rec->data_len,
1698 min_len, max_len,
1699 transform->maclen );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001700 }
1701 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1703 MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001704 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001707 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001708
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001709#if defined(MBEDTLS_SSL_DEBUG_ALL)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001710 MBEDTLS_SSL_DEBUG_BUF( 4, "expected mac", mac_expect, transform->maclen );
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001711 MBEDTLS_SSL_DEBUG_BUF( 4, "message mac", mac_peer, transform->maclen );
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001712#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001713
Manuel Pégourié-Gonnard3c31afa2020-08-13 12:08:54 +02001714 if( mbedtls_ssl_safer_memcmp( mac_peer, mac_expect,
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001715 transform->maclen ) != 0 )
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001716 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#if defined(MBEDTLS_SSL_DEBUG_ALL)
1718 MBEDTLS_SSL_DEBUG_MSG( 1, ( "message mac does not match" ) );
Paul Bakkere47b34b2013-02-27 14:48:00 +01001719#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001720 correct = 0;
1721 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001722 auth_done++;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001723 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001724
1725 /*
1726 * Finally check the correct flag
1727 */
1728 if( correct == 0 )
1729 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Hanno Becker52344c22018-01-03 15:24:20 +00001730#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001731
1732 /* Make extra sure authentication was performed, exactly once */
1733 if( auth_done != 1 )
1734 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1736 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001737 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001738
Hanno Beckerccc13d02020-05-04 12:30:04 +01001739#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1740 if( transform->minor_ver == MBEDTLS_SSL_MINOR_VERSION_4 )
1741 {
1742 /* Remove inner padding and infer true content type. */
1743 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1744 &rec->type );
1745
1746 if( ret != 0 )
1747 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1748 }
1749#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1750
Hanno Beckera0e20d02019-05-15 14:03:01 +01001751#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001752 if( rec->cid_len != 0 )
1753 {
Hanno Becker581bc1b2020-05-04 12:20:03 +01001754 ret = ssl_parse_inner_plaintext( data, &rec->data_len,
1755 &rec->type );
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001756 if( ret != 0 )
1757 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
1758 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001759#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001760
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decrypt buf" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001762
1763 return( 0 );
1764}
1765
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001766#undef MAC_NONE
1767#undef MAC_PLAINTEXT
1768#undef MAC_CIPHERTEXT
1769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +00001771/*
1772 * Compression/decompression functions
1773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001774static int ssl_compress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001775{
Janos Follath865b3eb2019-12-16 11:46:15 +00001776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001777 unsigned char *msg_post = ssl->out_msg;
Andrzej Kurek5462e022018-04-20 07:58:53 -04001778 ptrdiff_t bytes_written = ssl->out_msg - ssl->out_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001779 size_t len_pre = ssl->out_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001780 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001781#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1782 size_t out_buf_len = ssl->out_buf_len;
1783#else
1784 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1785#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001786
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001788
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001789 if( len_pre == 0 )
1790 return( 0 );
1791
Paul Bakker2770fbd2012-07-03 13:30:23 +00001792 memcpy( msg_pre, ssl->out_msg, len_pre );
1793
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001795 ssl->out_msglen ) );
1796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 MBEDTLS_SSL_DEBUG_BUF( 4, "before compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001798 ssl->out_msg, ssl->out_msglen );
1799
Paul Bakker48916f92012-09-16 19:57:18 +00001800 ssl->transform_out->ctx_deflate.next_in = msg_pre;
1801 ssl->transform_out->ctx_deflate.avail_in = len_pre;
1802 ssl->transform_out->ctx_deflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001803 ssl->transform_out->ctx_deflate.avail_out = out_buf_len - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001804
Paul Bakker48916f92012-09-16 19:57:18 +00001805 ret = deflate( &ssl->transform_out->ctx_deflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001806 if( ret != Z_OK )
1807 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform compression (%d)", ret ) );
1809 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001810 }
1811
Darryl Greenb33cc762019-11-28 14:29:44 +00001812 ssl->out_msglen = out_buf_len -
Andrzej Kurek5462e022018-04-20 07:58:53 -04001813 ssl->transform_out->ctx_deflate.avail_out - bytes_written;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after compression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001816 ssl->out_msglen ) );
1817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 MBEDTLS_SSL_DEBUG_BUF( 4, "after compression: output payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001819 ssl->out_msg, ssl->out_msglen );
1820
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= compress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001822
1823 return( 0 );
1824}
1825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826static int ssl_decompress_buf( mbedtls_ssl_context *ssl )
Paul Bakker2770fbd2012-07-03 13:30:23 +00001827{
Janos Follath865b3eb2019-12-16 11:46:15 +00001828 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001829 unsigned char *msg_post = ssl->in_msg;
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001830 ptrdiff_t header_bytes = ssl->in_msg - ssl->in_buf;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001831 size_t len_pre = ssl->in_msglen;
Paul Bakker16770332013-10-11 09:59:44 +02001832 unsigned char *msg_pre = ssl->compress_buf;
Darryl Greenb33cc762019-11-28 14:29:44 +00001833#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1834 size_t in_buf_len = ssl->in_buf_len;
1835#else
1836 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1837#endif
Paul Bakker2770fbd2012-07-03 13:30:23 +00001838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001840
Paul Bakkerabf2f8f2013-06-30 14:57:46 +02001841 if( len_pre == 0 )
1842 return( 0 );
1843
Paul Bakker2770fbd2012-07-03 13:30:23 +00001844 memcpy( msg_pre, ssl->in_msg, len_pre );
1845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001846 MBEDTLS_SSL_DEBUG_MSG( 3, ( "before decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001847 ssl->in_msglen ) );
1848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849 MBEDTLS_SSL_DEBUG_BUF( 4, "before decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001850 ssl->in_msg, ssl->in_msglen );
1851
Paul Bakker48916f92012-09-16 19:57:18 +00001852 ssl->transform_in->ctx_inflate.next_in = msg_pre;
1853 ssl->transform_in->ctx_inflate.avail_in = len_pre;
1854 ssl->transform_in->ctx_inflate.next_out = msg_post;
Darryl Greenb33cc762019-11-28 14:29:44 +00001855 ssl->transform_in->ctx_inflate.avail_out = in_buf_len - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001856
Paul Bakker48916f92012-09-16 19:57:18 +00001857 ret = inflate( &ssl->transform_in->ctx_inflate, Z_SYNC_FLUSH );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001858 if( ret != Z_OK )
1859 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860 MBEDTLS_SSL_DEBUG_MSG( 1, ( "failed to perform decompression (%d)", ret ) );
1861 return( MBEDTLS_ERR_SSL_COMPRESSION_FAILED );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001862 }
1863
Darryl Greenb33cc762019-11-28 14:29:44 +00001864 ssl->in_msglen = in_buf_len -
Andrzej Kureka9ceef82018-04-24 06:32:44 -04001865 ssl->transform_in->ctx_inflate.avail_out - header_bytes;
Paul Bakker2770fbd2012-07-03 13:30:23 +00001866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001867 MBEDTLS_SSL_DEBUG_MSG( 3, ( "after decompression: msglen = %d, ",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001868 ssl->in_msglen ) );
1869
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 MBEDTLS_SSL_DEBUG_BUF( 4, "after decompression: input payload",
Paul Bakker2770fbd2012-07-03 13:30:23 +00001871 ssl->in_msg, ssl->in_msglen );
1872
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001873 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= decompress buf" ) );
Paul Bakker2770fbd2012-07-03 13:30:23 +00001874
1875 return( 0 );
1876}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#endif /* MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001878
Paul Bakker5121ce52009-01-03 21:22:43 +00001879/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001880 * Fill the input message buffer by appending data to it.
1881 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001882 *
1883 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1884 * available (from this read and/or a previous one). Otherwise, an error code
1885 * is returned (possibly EOF or WANT_READ).
1886 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001887 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1888 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1889 * since we always read a whole datagram at once.
1890 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001891 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001892 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want )
Paul Bakker5121ce52009-01-03 21:22:43 +00001895{
Janos Follath865b3eb2019-12-16 11:46:15 +00001896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001897 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001898#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1899 size_t in_buf_len = ssl->in_buf_len;
1900#else
1901 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1902#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00001905
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001906 if( ssl->f_recv == NULL && ssl->f_recv_timeout == NULL )
1907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001909 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001911 }
1912
Darryl Greenb33cc762019-11-28 14:29:44 +00001913 if( nb_want > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001914 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "requesting more data than fits" ) );
1916 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001917 }
1918
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001920 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker5121ce52009-01-03 21:22:43 +00001921 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001922 uint32_t timeout;
1923
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001924 /* Just to be sure */
1925 if( ssl->f_set_timer == NULL || ssl->f_get_timer == NULL )
1926 {
1927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "You must use "
1928 "mbedtls_ssl_set_timer_cb() for DTLS" ) );
1929 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1930 }
1931
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001932 /*
1933 * The point is, we need to always read a full datagram at once, so we
1934 * sometimes read more then requested, and handle the additional data.
1935 * It could be the rest of the current record (while fetching the
1936 * header) and/or some other records in the same datagram.
1937 */
1938
1939 /*
1940 * Move to the next record in the already read datagram if applicable
1941 */
1942 if( ssl->next_record_offset != 0 )
1943 {
1944 if( ssl->in_left < ssl->next_record_offset )
1945 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001946 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1947 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001948 }
1949
1950 ssl->in_left -= ssl->next_record_offset;
1951
1952 if( ssl->in_left != 0 )
1953 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "next record in same datagram, offset: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001955 ssl->next_record_offset ) );
1956 memmove( ssl->in_hdr,
1957 ssl->in_hdr + ssl->next_record_offset,
1958 ssl->in_left );
1959 }
1960
1961 ssl->next_record_offset = 0;
1962 }
1963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Paul Bakker5121ce52009-01-03 21:22:43 +00001965 ssl->in_left, nb_want ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001966
1967 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001968 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001969 */
1970 if( nb_want <= ssl->in_left)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001971 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001973 return( 0 );
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001974 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001975
1976 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001977 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001978 * are not at the beginning of a new record, the caller did something
1979 * wrong.
1980 */
1981 if( ssl->in_left != 0 )
1982 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1984 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001985 }
1986
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001987 /*
1988 * Don't even try to read if time's out already.
1989 * This avoids by-passing the timer when repeatedly receiving messages
1990 * that will end up being dropped.
1991 */
Hanno Becker7876d122020-02-05 10:39:31 +00001992 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Hanno Beckere65ce782017-05-22 14:47:48 +01001993 {
1994 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timer has expired" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001995 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Hanno Beckere65ce782017-05-22 14:47:48 +01001996 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001997 else
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001998 {
Darryl Greenb33cc762019-11-28 14:29:44 +00001999 len = in_buf_len - ( ssl->in_hdr - ssl->in_buf );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002002 timeout = ssl->handshake->retransmit_timeout;
2003 else
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002004 timeout = ssl->conf->read_timeout;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006 MBEDTLS_SSL_DEBUG_MSG( 3, ( "f_recv_timeout: %u ms", timeout ) );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002007
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002008 if( ssl->f_recv_timeout != NULL )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002009 ret = ssl->f_recv_timeout( ssl->p_bio, ssl->in_hdr, len,
2010 timeout );
2011 else
2012 ret = ssl->f_recv( ssl->p_bio, ssl->in_hdr, len );
2013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002015
2016 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002017 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002018 }
2019
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002020 if( ret == MBEDTLS_ERR_SSL_TIMEOUT )
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002021 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "timeout" ) );
Hanno Becker0f57a652020-02-05 10:37:26 +00002023 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002026 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002027 if( ssl_double_retransmit_timeout( ssl ) != 0 )
2028 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake timeout" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002030 return( MBEDTLS_ERR_SSL_TIMEOUT );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002031 }
2032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002034 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002036 return( ret );
2037 }
2038
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002039 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002040 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002042 else if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002044 {
Hanno Becker786300f2020-02-05 10:46:40 +00002045 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002046 {
Hanno Becker786300f2020-02-05 10:46:40 +00002047 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
2048 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002049 return( ret );
2050 }
2051
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002052 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002053 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002054#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002055 }
2056
Paul Bakker5121ce52009-01-03 21:22:43 +00002057 if( ret < 0 )
2058 return( ret );
2059
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002060 ssl->in_left = ret;
2061 }
2062 else
2063#endif
2064 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002066 ssl->in_left, nb_want ) );
2067
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002068 while( ssl->in_left < nb_want )
2069 {
2070 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002071
Hanno Becker7876d122020-02-05 10:39:31 +00002072 if( mbedtls_ssl_check_timer( ssl ) != 0 )
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002073 ret = MBEDTLS_ERR_SSL_TIMEOUT;
2074 else
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002075 {
2076 if( ssl->f_recv_timeout != NULL )
2077 {
2078 ret = ssl->f_recv_timeout( ssl->p_bio,
2079 ssl->in_hdr + ssl->in_left, len,
2080 ssl->conf->read_timeout );
2081 }
2082 else
2083 {
2084 ret = ssl->f_recv( ssl->p_bio,
2085 ssl->in_hdr + ssl->in_left, len );
2086 }
2087 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089 MBEDTLS_SSL_DEBUG_MSG( 2, ( "in_left: %d, nb_want: %d",
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002090 ssl->in_left, nb_want ) );
2091 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_recv(_timeout)", ret );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002092
2093 if( ret == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094 return( MBEDTLS_ERR_SSL_CONN_EOF );
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002095
2096 if( ret < 0 )
2097 return( ret );
2098
makise-homuraaf9513b2020-08-24 18:26:27 +03002099 if ( (size_t)ret > len || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16035bd15cb2018-02-28 04:30:59 -08002100 {
Darryl Green11999bb2018-03-13 15:22:58 +00002101 MBEDTLS_SSL_DEBUG_MSG( 1,
2102 ( "f_recv returned %d bytes but only %lu were requested",
mohammad160319d392b2018-04-02 07:25:26 -07002103 ret, (unsigned long)len ) );
mohammad16035bd15cb2018-02-28 04:30:59 -08002104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2105 }
2106
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002107 ssl->in_left += ret;
2108 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002109 }
2110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= fetch input" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002112
2113 return( 0 );
2114}
2115
2116/*
2117 * Flush any data not yet written
2118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002120{
Janos Follath865b3eb2019-12-16 11:46:15 +00002121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002122 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002125
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002126 if( ssl->f_send == NULL )
2127 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Bad usage of mbedtls_ssl_set_bio() "
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002129 "or mbedtls_ssl_set_bio()" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002131 }
2132
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002133 /* Avoid incrementing counter if data is flushed */
2134 if( ssl->out_left == 0 )
2135 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002137 return( 0 );
2138 }
2139
Paul Bakker5121ce52009-01-03 21:22:43 +00002140 while( ssl->out_left > 0 )
2141 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message length: %d, out_left: %d",
Hanno Becker5903de42019-05-03 14:46:38 +01002143 mbedtls_ssl_out_hdr_len( ssl ) + ssl->out_msglen, ssl->out_left ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
Hanno Becker2b1e3542018-08-06 11:19:13 +01002145 buf = ssl->out_hdr - ssl->out_left;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002146 ret = ssl->f_send( ssl->p_bio, buf, ssl->out_left );
Paul Bakker186751d2012-05-08 13:16:14 +00002147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002149
2150 if( ret <= 0 )
2151 return( ret );
2152
makise-homuraaf9513b2020-08-24 18:26:27 +03002153 if( (size_t)ret > ssl->out_left || ( INT_MAX > SIZE_MAX && ret > (int)SIZE_MAX ) )
mohammad16034bbaeb42018-02-22 04:29:04 -08002154 {
Darryl Green11999bb2018-03-13 15:22:58 +00002155 MBEDTLS_SSL_DEBUG_MSG( 1,
2156 ( "f_send returned %d bytes but only %lu bytes were sent",
mohammad160319d392b2018-04-02 07:25:26 -07002157 ret, (unsigned long)ssl->out_left ) );
mohammad16034bbaeb42018-02-22 04:29:04 -08002158 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2159 }
2160
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 ssl->out_left -= ret;
2162 }
2163
Hanno Becker2b1e3542018-08-06 11:19:13 +01002164#if defined(MBEDTLS_SSL_PROTO_DTLS)
2165 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002166 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002167 ssl->out_hdr = ssl->out_buf;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002168 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002169 else
2170#endif
2171 {
2172 ssl->out_hdr = ssl->out_buf + 8;
2173 }
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002174 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= flush output" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002177
2178 return( 0 );
2179}
2180
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002181/*
2182 * Functions to handle the DTLS retransmission state machine
2183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002185/*
2186 * Append current handshake message to current outgoing flight
2187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188static int ssl_flight_append( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 mbedtls_ssl_flight_item *msg;
Hanno Becker3b235902018-08-06 09:54:53 +01002191 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_flight_append" ) );
2192 MBEDTLS_SSL_DEBUG_BUF( 4, "message appended to flight",
2193 ssl->out_msg, ssl->out_msglen );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002194
2195 /* Allocate space for current message */
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002196 if( ( msg = mbedtls_calloc( 1, sizeof( mbedtls_ssl_flight_item ) ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002197 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002198 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed",
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 sizeof( mbedtls_ssl_flight_item ) ) );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002200 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002201 }
2202
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +02002203 if( ( msg->p = mbedtls_calloc( 1, ssl->out_msglen ) ) == NULL )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204 {
Manuel Pégourié-Gonnardb2a18a22015-05-27 16:29:56 +02002205 MBEDTLS_SSL_DEBUG_MSG( 1, ( "alloc %d bytes failed", ssl->out_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206 mbedtls_free( msg );
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002207 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002208 }
2209
2210 /* Copy current handshake message with headers */
2211 memcpy( msg->p, ssl->out_msg, ssl->out_msglen );
2212 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002213 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002214 msg->next = NULL;
2215
2216 /* Append to the current flight */
2217 if( ssl->handshake->flight == NULL )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002218 ssl->handshake->flight = msg;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002219 else
2220 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002222 while( cur->next != NULL )
2223 cur = cur->next;
2224 cur->next = msg;
2225 }
2226
Hanno Becker3b235902018-08-06 09:54:53 +01002227 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_flight_append" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002228 return( 0 );
2229}
2230
2231/*
2232 * Free the current flight of handshake messages
2233 */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002234void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236 mbedtls_ssl_flight_item *cur = flight;
2237 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002238
2239 while( cur != NULL )
2240 {
2241 next = cur->next;
2242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002243 mbedtls_free( cur->p );
2244 mbedtls_free( cur );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002245
2246 cur = next;
2247 }
2248}
2249
2250/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002251 * Swap transform_out and out_ctr with the alternative ones
2252 */
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002253static int ssl_swap_epochs( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 mbedtls_ssl_transform *tmp_transform;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002256 unsigned char tmp_out_ctr[8];
2257
2258 if( ssl->transform_out == ssl->handshake->alt_transform_out )
2259 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002260 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip swap epochs" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002261 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002262 }
2263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 MBEDTLS_SSL_DEBUG_MSG( 3, ( "swap epochs" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002265
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002266 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002267 tmp_transform = ssl->transform_out;
2268 ssl->transform_out = ssl->handshake->alt_transform_out;
2269 ssl->handshake->alt_transform_out = tmp_transform;
2270
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002271 /* Swap epoch + sequence_number */
Hanno Becker19859472018-08-06 09:40:20 +01002272 memcpy( tmp_out_ctr, ssl->cur_out_ctr, 8 );
2273 memcpy( ssl->cur_out_ctr, ssl->handshake->alt_out_ctr, 8 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002274 memcpy( ssl->handshake->alt_out_ctr, tmp_out_ctr, 8 );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002275
2276 /* Adjust to the newly activated transform */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002277 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2280 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002281 {
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002282 int ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_OUTBOUND );
2283 if( ret != 0 )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002284 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
2286 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002287 }
2288 }
2289#endif
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002290
2291 return( 0 );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002292}
2293
2294/*
2295 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002296 */
2297int mbedtls_ssl_resend( mbedtls_ssl_context *ssl )
2298{
2299 int ret = 0;
2300
2301 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_resend" ) );
2302
2303 ret = mbedtls_ssl_flight_transmit( ssl );
2304
2305 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_resend" ) );
2306
2307 return( ret );
2308}
2309
2310/*
2311 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002312 *
2313 * Need to remember the current message in case flush_output returns
2314 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002315 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002316 */
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002317int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002318{
Janos Follath865b3eb2019-12-16 11:46:15 +00002319 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322 if( ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002323 {
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002324 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialise flight transmission" ) );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002325
2326 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002327 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002328 ret = ssl_swap_epochs( ssl );
2329 if( ret != 0 )
2330 return( ret );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002333 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002334
2335 while( ssl->handshake->cur_msg != NULL )
2336 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002337 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002338 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002339
Hanno Beckere1dcb032018-08-17 16:47:58 +01002340 int const is_finished =
2341 ( cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2342 cur->p[0] == MBEDTLS_SSL_HS_FINISHED );
2343
Hanno Becker04da1892018-08-14 13:22:10 +01002344 uint8_t const force_flush = ssl->disable_datagram_packing == 1 ?
2345 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
2346
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002347 /* Swap epochs before sending Finished: we can't do it after
2348 * sending ChangeCipherSpec, in case write returns WANT_READ.
2349 * Must be done before copying, may change out_msg pointer */
Hanno Beckere1dcb032018-08-17 16:47:58 +01002350 if( is_finished && ssl->handshake->cur_msg_p == ( cur->p + 12 ) )
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002351 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002352 MBEDTLS_SSL_DEBUG_MSG( 2, ( "swap epochs to send finished message" ) );
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002353 ret = ssl_swap_epochs( ssl );
2354 if( ret != 0 )
2355 return( ret );
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002356 }
2357
Hanno Becker67bc7c32018-08-06 11:33:50 +01002358 ret = ssl_get_remaining_payload_in_datagram( ssl );
2359 if( ret < 0 )
2360 return( ret );
2361 max_frag_len = (size_t) ret;
2362
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002363 /* CCS is copied as is, while HS messages may need fragmentation */
2364 if( cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2365 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002366 if( max_frag_len == 0 )
2367 {
2368 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2369 return( ret );
2370
2371 continue;
2372 }
2373
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002374 memcpy( ssl->out_msg, cur->p, cur->len );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002375 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002376 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002377
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002378 /* Update position inside current message */
2379 ssl->handshake->cur_msg_p += cur->len;
2380 }
2381 else
2382 {
2383 const unsigned char * const p = ssl->handshake->cur_msg_p;
2384 const size_t hs_len = cur->len - 12;
2385 const size_t frag_off = p - ( cur->p + 12 );
2386 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002387 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002388
Hanno Beckere1dcb032018-08-17 16:47:58 +01002389 if( ( max_frag_len < 12 ) || ( max_frag_len == 12 && hs_len != 0 ) )
Manuel Pégourié-Gonnarda1071a52018-08-20 11:56:14 +02002390 {
Hanno Beckere1dcb032018-08-17 16:47:58 +01002391 if( is_finished )
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002392 {
2393 ret = ssl_swap_epochs( ssl );
2394 if( ret != 0 )
2395 return( ret );
2396 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002397
Hanno Becker67bc7c32018-08-06 11:33:50 +01002398 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2399 return( ret );
2400
2401 continue;
2402 }
2403 max_hs_frag_len = max_frag_len - 12;
2404
2405 cur_hs_frag_len = rem_len > max_hs_frag_len ?
2406 max_hs_frag_len : rem_len;
2407
2408 if( frag_off == 0 && cur_hs_frag_len != hs_len )
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002409 {
2410 MBEDTLS_SSL_DEBUG_MSG( 2, ( "fragmenting handshake message (%u > %u)",
Hanno Becker67bc7c32018-08-06 11:33:50 +01002411 (unsigned) cur_hs_frag_len,
2412 (unsigned) max_hs_frag_len ) );
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002413 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002414
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002415 /* Messages are stored with handshake headers as if not fragmented,
2416 * copy beginning of headers then fill fragmentation fields.
2417 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
2418 memcpy( ssl->out_msg, cur->p, 6 );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002419
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002420 ssl->out_msg[6] = ( ( frag_off >> 16 ) & 0xff );
2421 ssl->out_msg[7] = ( ( frag_off >> 8 ) & 0xff );
2422 ssl->out_msg[8] = ( ( frag_off ) & 0xff );
2423
Hanno Becker67bc7c32018-08-06 11:33:50 +01002424 ssl->out_msg[ 9] = ( ( cur_hs_frag_len >> 16 ) & 0xff );
2425 ssl->out_msg[10] = ( ( cur_hs_frag_len >> 8 ) & 0xff );
2426 ssl->out_msg[11] = ( ( cur_hs_frag_len ) & 0xff );
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002427
2428 MBEDTLS_SSL_DEBUG_BUF( 3, "handshake header", ssl->out_msg, 12 );
2429
Hanno Becker3f7b9732018-08-28 09:53:25 +01002430 /* Copy the handshake message content and set records fields */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002431 memcpy( ssl->out_msg + 12, p, cur_hs_frag_len );
2432 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002433 ssl->out_msgtype = cur->type;
2434
2435 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002436 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002437 }
2438
2439 /* If done with the current message move to the next one if any */
2440 if( ssl->handshake->cur_msg_p >= cur->p + cur->len )
2441 {
2442 if( cur->next != NULL )
2443 {
2444 ssl->handshake->cur_msg = cur->next;
2445 ssl->handshake->cur_msg_p = cur->next->p + 12;
2446 }
2447 else
2448 {
2449 ssl->handshake->cur_msg = NULL;
2450 ssl->handshake->cur_msg_p = NULL;
2451 }
2452 }
2453
2454 /* Actually send the message out */
Hanno Becker04da1892018-08-14 13:22:10 +01002455 if( ( ret = mbedtls_ssl_write_record( ssl, force_flush ) ) != 0 )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002456 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002458 return( ret );
2459 }
2460 }
2461
Hanno Becker67bc7c32018-08-06 11:33:50 +01002462 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
2463 return( ret );
2464
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002465 /* Update state and set timer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
2467 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard23b7b702014-09-25 13:50:12 +02002468 else
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002469 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Hanno Becker0f57a652020-02-05 10:37:26 +00002471 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002472 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002473
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002474 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= mbedtls_ssl_flight_transmit" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002475
2476 return( 0 );
2477}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002478
2479/*
2480 * To be called when the last message of an incoming flight is received.
2481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002483{
2484 /* We won't need to resend that one any more */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002485 mbedtls_ssl_flight_free( ssl->handshake->flight );
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002486 ssl->handshake->flight = NULL;
2487 ssl->handshake->cur_msg = NULL;
2488
2489 /* The next incoming flight will start with this msg_seq */
2490 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2491
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002492 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002493 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002494
Hanno Becker0271f962018-08-16 13:23:47 +01002495 /* Clear future message buffering structure. */
Hanno Becker533ab5f2020-02-05 10:49:13 +00002496 mbedtls_ssl_buffering_free( ssl );
Hanno Becker0271f962018-08-16 13:23:47 +01002497
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002498 /* Cancel timer */
Hanno Becker0f57a652020-02-05 10:37:26 +00002499 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002500
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2502 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002503 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002505 }
2506 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002508}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002509
2510/*
2511 * To be called when the last message of an outgoing flight is send.
2512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002514{
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002515 ssl_reset_retransmit_timeout( ssl );
Hanno Becker0f57a652020-02-05 10:37:26 +00002516 mbedtls_ssl_set_timer( ssl, ssl->handshake->retransmit_timeout );
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002517
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2519 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED )
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002520 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002522 }
2523 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002525}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002527
Paul Bakker5121ce52009-01-03 21:22:43 +00002528/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002529 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002531
2532/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002533 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002534 *
2535 * - fill in handshake headers
2536 * - update handshake checksum
2537 * - DTLS: save message for resending
2538 * - then pass to the record layer
2539 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002540 * DTLS: except for HelloRequest, messages are only queued, and will only be
2541 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002542 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002543 * Inputs:
2544 * - ssl->out_msglen: 4 + actual handshake message len
2545 * (4 is the size of handshake headers for TLS)
2546 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2547 * - ssl->out_msg + 4: the handshake message body
2548 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002549 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002550 * - ssl->out_msglen: the length of the record contents
2551 * (including handshake headers but excluding record headers)
2552 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002553 */
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002554int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00002555{
Janos Follath865b3eb2019-12-16 11:46:15 +00002556 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002557 const size_t hs_len = ssl->out_msglen - 4;
2558 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002559
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002560 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write handshake message" ) );
2561
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002562 /*
2563 * Sanity checks
2564 */
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002565 if( ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002566 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
2567 {
Hanno Beckerc83d2b32018-08-22 16:05:47 +01002568 /* In SSLv3, the client might send a NoCertificate alert. */
2569#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_CLI_C)
2570 if( ! ( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
2571 ssl->out_msgtype == MBEDTLS_SSL_MSG_ALERT &&
2572 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ) )
2573#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
2574 {
2575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2576 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2577 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002578 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002579
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002580 /* Whenever we send anything different from a
2581 * HelloRequest we should be in a handshake - double check. */
2582 if( ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2583 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) &&
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002584 ssl->handshake == NULL )
2585 {
2586 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2587 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2588 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002590#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002591 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002592 ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002594 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002595 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2596 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002597 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002598#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002599
Hanno Beckerb50a2532018-08-06 11:52:54 +01002600 /* Double-check that we did not exceed the bounds
2601 * of the outgoing record buffer.
2602 * This should never fail as the various message
2603 * writing functions must obey the bounds of the
2604 * outgoing record buffer, but better be safe.
2605 *
2606 * Note: We deliberately do not check for the MTU or MFL here.
2607 */
2608 if( ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN )
2609 {
2610 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Record too large: "
2611 "size %u, maximum %u",
2612 (unsigned) ssl->out_msglen,
2613 (unsigned) MBEDTLS_SSL_OUT_CONTENT_LEN ) );
2614 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2615 }
2616
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002617 /*
2618 * Fill handshake headers
2619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 if( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00002621 {
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002622 ssl->out_msg[1] = (unsigned char)( hs_len >> 16 );
2623 ssl->out_msg[2] = (unsigned char)( hs_len >> 8 );
2624 ssl->out_msg[3] = (unsigned char)( hs_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002625
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002626 /*
2627 * DTLS has additional fields in the Handshake layer,
2628 * between the length field and the actual payload:
2629 * uint16 message_seq;
2630 * uint24 fragment_offset;
2631 * uint24 fragment_length;
2632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002634 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002635 {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002636 /* Make room for the additional DTLS fields */
Angus Grattond8213d02016-05-25 20:56:48 +10002637 if( MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8 )
Hanno Becker9648f8b2017-09-18 10:55:54 +01002638 {
2639 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS handshake message too large: "
2640 "size %u, maximum %u",
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002641 (unsigned) ( hs_len ),
Angus Grattond8213d02016-05-25 20:56:48 +10002642 (unsigned) ( MBEDTLS_SSL_OUT_CONTENT_LEN - 12 ) ) );
Hanno Becker9648f8b2017-09-18 10:55:54 +01002643 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2644 }
2645
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002646 memmove( ssl->out_msg + 12, ssl->out_msg + 4, hs_len );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002647 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002648
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002649 /* Write message_seq and update it, except for HelloRequest */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002650 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002651 {
Manuel Pégourié-Gonnardd9ba0d92014-09-02 18:30:26 +02002652 ssl->out_msg[4] = ( ssl->handshake->out_msg_seq >> 8 ) & 0xFF;
2653 ssl->out_msg[5] = ( ssl->handshake->out_msg_seq ) & 0xFF;
2654 ++( ssl->handshake->out_msg_seq );
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002655 }
2656 else
2657 {
2658 ssl->out_msg[4] = 0;
2659 ssl->out_msg[5] = 0;
2660 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002661
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002662 /* Handshake hashes are computed without fragmentation,
2663 * so set frag_offset = 0 and frag_len = hs_len for now */
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002664 memset( ssl->out_msg + 6, 0x00, 3 );
2665 memcpy( ssl->out_msg + 9, ssl->out_msg + 1, 3 );
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002666 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002668
Hanno Becker0207e532018-08-28 10:28:28 +01002669 /* Update running hashes of handshake messages seen */
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002670 if( hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST )
2671 ssl->handshake->update_checksum( ssl, ssl->out_msg, ssl->out_msglen );
Paul Bakker5121ce52009-01-03 21:22:43 +00002672 }
2673
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002674 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002676 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002677 ! ( ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2678 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST ) )
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002679 {
2680 if( ( ret = ssl_flight_append( ssl ) ) != 0 )
2681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_flight_append", ret );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002683 return( ret );
2684 }
2685 }
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002686 else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002687#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002688 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002689 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002690 {
2691 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_write_record", ret );
2692 return( ret );
2693 }
2694 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002695
2696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write handshake message" ) );
2697
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002698 return( 0 );
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002699}
2700
2701/*
2702 * Record layer functions
2703 */
2704
2705/*
2706 * Write current record.
2707 *
2708 * Uses:
2709 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2710 * - ssl->out_msglen: length of the record content (excl headers)
2711 * - ssl->out_msg: record content
2712 */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002713int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush )
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002714{
2715 int ret, done = 0;
2716 size_t len = ssl->out_msglen;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002717 uint8_t flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002718
2719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write record" ) );
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00002722 if( ssl->transform_out != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 ssl->session_out->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
Paul Bakker2770fbd2012-07-03 13:30:23 +00002724 {
2725 if( ( ret = ssl_compress_buf( ssl ) ) != 0 )
2726 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_compress_buf", ret );
Paul Bakker2770fbd2012-07-03 13:30:23 +00002728 return( ret );
2729 }
2730
2731 len = ssl->out_msglen;
2732 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#endif /*MBEDTLS_ZLIB_SUPPORT */
Paul Bakker2770fbd2012-07-03 13:30:23 +00002734
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
2736 if( mbedtls_ssl_hw_record_write != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00002737 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_write()" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002739
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 ret = mbedtls_ssl_hw_record_write( ssl );
2741 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00002742 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_write", ret );
2744 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00002745 }
Paul Bakkerc7878112012-12-19 14:41:14 +01002746
2747 if( ret == 0 )
2748 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00002749 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00002751 if( !done )
2752 {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002753 unsigned i;
2754 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002755#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2756 size_t out_buf_len = ssl->out_buf_len;
2757#else
2758 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2759#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002760 /* Skip writing the record content type to after the encryption,
2761 * as it may change when using the CID extension. */
2762
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002763 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002764 ssl->conf->transport, ssl->out_hdr + 1 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002765
Hanno Becker19859472018-08-06 09:40:20 +01002766 memcpy( ssl->out_ctr, ssl->cur_out_ctr, 8 );
Manuel Pégourié-Gonnard507e1e42014-02-13 11:17:34 +01002767 ssl->out_len[0] = (unsigned char)( len >> 8 );
2768 ssl->out_len[1] = (unsigned char)( len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002769
Paul Bakker48916f92012-09-16 19:57:18 +00002770 if( ssl->transform_out != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00002771 {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002772 mbedtls_record rec;
2773
2774 rec.buf = ssl->out_iv;
Darryl Greenb33cc762019-11-28 14:29:44 +00002775 rec.buf_len = out_buf_len - ( ssl->out_iv - ssl->out_buf );
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002776 rec.data_len = ssl->out_msglen;
2777 rec.data_offset = ssl->out_msg - rec.buf;
2778
2779 memcpy( &rec.ctr[0], ssl->out_ctr, 8 );
2780 mbedtls_ssl_write_version( ssl->major_ver, ssl->minor_ver,
2781 ssl->conf->transport, rec.ver );
2782 rec.type = ssl->out_msgtype;
2783
Hanno Beckera0e20d02019-05-15 14:03:01 +01002784#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002785 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002786 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002787#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002788
Hanno Beckera18d1322018-01-03 14:27:32 +00002789 if( ( ret = mbedtls_ssl_encrypt_buf( ssl, ssl->transform_out, &rec,
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002790 ssl->conf->f_rng, ssl->conf->p_rng ) ) != 0 )
Paul Bakker05ef8352012-05-08 09:17:57 +00002791 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_encrypt_buf", ret );
Paul Bakker05ef8352012-05-08 09:17:57 +00002793 return( ret );
2794 }
2795
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002796 if( rec.data_offset != 0 )
2797 {
2798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2799 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2800 }
2801
Hanno Becker6430faf2019-05-08 11:57:13 +01002802 /* Update the record content type and CID. */
2803 ssl->out_msgtype = rec.type;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002804#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID )
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01002805 memcpy( ssl->out_cid, rec.cid, rec.cid_len );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002806#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002807 ssl->out_msglen = len = rec.data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002808 ssl->out_len[0] = (unsigned char)( rec.data_len >> 8 );
2809 ssl->out_len[1] = (unsigned char)( rec.data_len );
Paul Bakker05ef8352012-05-08 09:17:57 +00002810 }
2811
Hanno Becker5903de42019-05-03 14:46:38 +01002812 protected_record_size = len + mbedtls_ssl_out_hdr_len( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002813
2814#if defined(MBEDTLS_SSL_PROTO_DTLS)
2815 /* In case of DTLS, double-check that we don't exceed
2816 * the remaining space in the datagram. */
2817 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
2818 {
Hanno Becker554b0af2018-08-22 20:33:41 +01002819 ret = ssl_get_remaining_space_in_datagram( ssl );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002820 if( ret < 0 )
2821 return( ret );
2822
2823 if( protected_record_size > (size_t) ret )
2824 {
2825 /* Should never happen */
2826 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2827 }
2828 }
2829#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002830
Hanno Becker6430faf2019-05-08 11:57:13 +01002831 /* Now write the potentially updated record content type. */
2832 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2833
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002834 MBEDTLS_SSL_DEBUG_MSG( 3, ( "output record: msgtype = %d, "
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002835 "version = [%d:%d], msglen = %d",
2836 ssl->out_hdr[0], ssl->out_hdr[1],
2837 ssl->out_hdr[2], len ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00002838
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
Hanno Beckerecbdf1c2018-08-28 09:53:54 +01002840 ssl->out_hdr, protected_record_size );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002841
2842 ssl->out_left += protected_record_size;
2843 ssl->out_hdr += protected_record_size;
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00002844 mbedtls_ssl_update_out_pointers( ssl, ssl->transform_out );
Hanno Becker2b1e3542018-08-06 11:19:13 +01002845
Hanno Beckerdd772292020-02-05 10:38:31 +00002846 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker04484622018-08-06 09:49:38 +01002847 if( ++ssl->cur_out_ctr[i - 1] != 0 )
2848 break;
2849
2850 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00002851 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker04484622018-08-06 09:49:38 +01002852 {
2853 MBEDTLS_SSL_DEBUG_MSG( 1, ( "outgoing message counter would wrap" ) );
2854 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
2855 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002856 }
2857
Hanno Becker67bc7c32018-08-06 11:33:50 +01002858#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker47db8772018-08-21 13:32:13 +01002859 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2860 flush == SSL_DONT_FORCE_FLUSH )
Hanno Becker67bc7c32018-08-06 11:33:50 +01002861 {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002862 size_t remaining;
2863 ret = ssl_get_remaining_payload_in_datagram( ssl );
2864 if( ret < 0 )
2865 {
2866 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_get_remaining_payload_in_datagram",
2867 ret );
2868 return( ret );
2869 }
2870
2871 remaining = (size_t) ret;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002872 if( remaining == 0 )
Hanno Beckerf0da6672018-08-28 09:55:10 +01002873 {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002874 flush = SSL_FORCE_FLUSH;
Hanno Beckerf0da6672018-08-28 09:55:10 +01002875 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002876 else
2877 {
Hanno Becker513815a2018-08-20 11:56:09 +01002878 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Still %u bytes available in current datagram", (unsigned) remaining ) );
Hanno Becker67bc7c32018-08-06 11:33:50 +01002879 }
2880 }
2881#endif /* MBEDTLS_SSL_PROTO_DTLS */
2882
2883 if( ( flush == SSL_FORCE_FLUSH ) &&
2884 ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00002885 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00002887 return( ret );
2888 }
2889
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write record" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00002891
2892 return( 0 );
2893}
2894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002896
2897static int ssl_hs_is_proper_fragment( mbedtls_ssl_context *ssl )
2898{
2899 if( ssl->in_msglen < ssl->in_hslen ||
2900 memcmp( ssl->in_msg + 6, "\0\0\0", 3 ) != 0 ||
2901 memcmp( ssl->in_msg + 9, ssl->in_msg + 1, 3 ) != 0 )
2902 {
2903 return( 1 );
2904 }
2905 return( 0 );
2906}
Hanno Becker44650b72018-08-16 12:51:11 +01002907
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002908static uint32_t ssl_get_hs_frag_len( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002909{
2910 return( ( ssl->in_msg[9] << 16 ) |
2911 ( ssl->in_msg[10] << 8 ) |
2912 ssl->in_msg[11] );
2913}
2914
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002915static uint32_t ssl_get_hs_frag_off( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002916{
2917 return( ( ssl->in_msg[6] << 16 ) |
2918 ( ssl->in_msg[7] << 8 ) |
2919 ssl->in_msg[8] );
2920}
2921
Hanno Beckercd9dcda2018-08-28 17:18:56 +01002922static int ssl_check_hs_header( mbedtls_ssl_context const *ssl )
Hanno Becker44650b72018-08-16 12:51:11 +01002923{
2924 uint32_t msg_len, frag_off, frag_len;
2925
2926 msg_len = ssl_get_hs_total_len( ssl );
2927 frag_off = ssl_get_hs_frag_off( ssl );
2928 frag_len = ssl_get_hs_frag_len( ssl );
2929
2930 if( frag_off > msg_len )
2931 return( -1 );
2932
2933 if( frag_len > msg_len - frag_off )
2934 return( -1 );
2935
2936 if( frag_len + 12 > ssl->in_msglen )
2937 return( -1 );
2938
2939 return( 0 );
2940}
2941
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002942/*
2943 * Mark bits in bitmask (used for DTLS HS reassembly)
2944 */
2945static void ssl_bitmask_set( unsigned char *mask, size_t offset, size_t len )
2946{
2947 unsigned int start_bits, end_bits;
2948
2949 start_bits = 8 - ( offset % 8 );
2950 if( start_bits != 8 )
2951 {
2952 size_t first_byte_idx = offset / 8;
2953
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002954 /* Special case */
2955 if( len <= start_bits )
2956 {
2957 for( ; len != 0; len-- )
2958 mask[first_byte_idx] |= 1 << ( start_bits - len );
2959
2960 /* Avoid potential issues with offset or len becoming invalid */
2961 return;
2962 }
2963
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002964 offset += start_bits; /* Now offset % 8 == 0 */
2965 len -= start_bits;
2966
2967 for( ; start_bits != 0; start_bits-- )
2968 mask[first_byte_idx] |= 1 << ( start_bits - 1 );
2969 }
2970
2971 end_bits = len % 8;
2972 if( end_bits != 0 )
2973 {
2974 size_t last_byte_idx = ( offset + len ) / 8;
2975
2976 len -= end_bits; /* Now len % 8 == 0 */
2977
2978 for( ; end_bits != 0; end_bits-- )
2979 mask[last_byte_idx] |= 1 << ( 8 - end_bits );
2980 }
2981
2982 memset( mask + offset / 8, 0xFF, len / 8 );
2983}
2984
2985/*
2986 * Check that bitmask is full
2987 */
2988static int ssl_bitmask_check( unsigned char *mask, size_t len )
2989{
2990 size_t i;
2991
2992 for( i = 0; i < len / 8; i++ )
2993 if( mask[i] != 0xFF )
2994 return( -1 );
2995
2996 for( i = 0; i < len % 8; i++ )
2997 if( ( mask[len / 8] & ( 1 << ( 7 - i ) ) ) == 0 )
2998 return( -1 );
2999
3000 return( 0 );
3001}
3002
Hanno Becker56e205e2018-08-16 09:06:12 +01003003/* msg_len does not include the handshake header */
Hanno Becker65dc8852018-08-23 09:40:49 +01003004static size_t ssl_get_reassembly_buffer_size( size_t msg_len,
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003005 unsigned add_bitmap )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003006{
Hanno Becker56e205e2018-08-16 09:06:12 +01003007 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003008
Hanno Becker56e205e2018-08-16 09:06:12 +01003009 alloc_len = 12; /* Handshake header */
3010 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003011
Hanno Beckerd07df862018-08-16 09:14:58 +01003012 if( add_bitmap )
3013 alloc_len += msg_len / 8 + ( msg_len % 8 != 0 ); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003014
Hanno Becker2a97b0e2018-08-21 15:47:49 +01003015 return( alloc_len );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003016}
Hanno Becker56e205e2018-08-16 09:06:12 +01003017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003019
Hanno Beckercd9dcda2018-08-28 17:18:56 +01003020static uint32_t ssl_get_hs_total_len( mbedtls_ssl_context const *ssl )
Hanno Becker12555c62018-08-16 12:47:53 +01003021{
3022 return( ( ssl->in_msg[1] << 16 ) |
3023 ( ssl->in_msg[2] << 8 ) |
3024 ssl->in_msg[3] );
3025}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003026
Simon Butcher99000142016-10-13 17:21:01 +01003027int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003028{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029 if( ssl->in_msglen < mbedtls_ssl_hs_hdr_len( ssl ) )
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003030 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake message too short: %d",
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003032 ssl->in_msglen ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003034 }
3035
Hanno Becker12555c62018-08-16 12:47:53 +01003036 ssl->in_hslen = mbedtls_ssl_hs_hdr_len( ssl ) + ssl_get_hs_total_len( ssl );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 MBEDTLS_SSL_DEBUG_MSG( 3, ( "handshake message: msglen ="
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003039 " %d, type = %d, hslen = %d",
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01003040 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen ) );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003043 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003044 {
Janos Follath865b3eb2019-12-16 11:46:15 +00003045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003046 unsigned int recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003047
Hanno Becker44650b72018-08-16 12:51:11 +01003048 if( ssl_check_hs_header( ssl ) != 0 )
3049 {
3050 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid handshake header" ) );
3051 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3052 }
3053
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003054 if( ssl->handshake != NULL &&
Hanno Beckerc76c6192017-06-06 10:03:17 +01003055 ( ( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER &&
3056 recv_msg_seq != ssl->handshake->in_msg_seq ) ||
3057 ( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3058 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO ) ) )
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003059 {
Hanno Becker9e1ec222018-08-15 15:54:43 +01003060 if( recv_msg_seq > ssl->handshake->in_msg_seq )
3061 {
3062 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received future handshake message of sequence number %u (next %u)",
3063 recv_msg_seq,
3064 ssl->handshake->in_msg_seq ) );
3065 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
3066 }
3067
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003068 /* Retransmit only on last message from previous flight, to avoid
3069 * too many retransmissions.
3070 * Besides, No sane server ever retransmits HelloVerifyRequest */
3071 if( recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003073 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received message from last flight, "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003075 "message_seq = %d, start_of_flight = %d",
3076 recv_msg_seq,
3077 ssl->handshake->in_flight_start_seq ) );
3078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 if( ( ret = mbedtls_ssl_resend( ssl ) ) != 0 )
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003080 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend", ret );
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003082 return( ret );
3083 }
3084 }
3085 else
3086 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "dropping out-of-sequence message: "
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003088 "message_seq = %d, expected = %d",
3089 recv_msg_seq,
3090 ssl->handshake->in_msg_seq ) );
3091 }
3092
Hanno Becker90333da2017-10-10 11:27:13 +01003093 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003094 }
3095 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003096
Hanno Becker6d97ef52018-08-16 13:09:04 +01003097 /* Message reassembly is handled alongside buffering of future
3098 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003099 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003100 * handshake logic layer. */
Hanno Beckere25e3b72018-08-16 09:30:53 +01003101 if( ssl_hs_is_proper_fragment( ssl ) == 1 )
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003102 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "found fragmented DTLS handshake message" ) );
Hanno Becker6d97ef52018-08-16 13:09:04 +01003104 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003105 }
3106 }
3107 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003109 /* With TLS we don't handle fragmentation (for now) */
3110 if( ssl->in_msglen < ssl->in_hslen )
3111 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003112 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS handshake fragmentation not supported" ) );
3113 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003114 }
3115
Simon Butcher99000142016-10-13 17:21:01 +01003116 return( 0 );
3117}
3118
3119void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl )
3120{
Hanno Becker0271f962018-08-16 13:23:47 +01003121 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003122
Hanno Becker0271f962018-08-16 13:23:47 +01003123 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER && hs != NULL )
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003124 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003125 ssl->handshake->update_checksum( ssl, ssl->in_msg, ssl->in_hslen );
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003126 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003127
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003128 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003130 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003131 ssl->handshake != NULL )
3132 {
Hanno Becker0271f962018-08-16 13:23:47 +01003133 unsigned offset;
3134 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003135
Hanno Becker0271f962018-08-16 13:23:47 +01003136 /* Increment handshake sequence number */
3137 hs->in_msg_seq++;
3138
3139 /*
3140 * Clear up handshake buffering and reassembly structure.
3141 */
3142
3143 /* Free first entry */
Hanno Beckere605b192018-08-21 15:59:07 +01003144 ssl_buffering_free_slot( ssl, 0 );
Hanno Becker0271f962018-08-16 13:23:47 +01003145
3146 /* Shift all other entries */
Hanno Beckere605b192018-08-21 15:59:07 +01003147 for( offset = 0, hs_buf = &hs->buffering.hs[0];
3148 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Hanno Becker0271f962018-08-16 13:23:47 +01003149 offset++, hs_buf++ )
3150 {
3151 *hs_buf = *(hs_buf + 1);
3152 }
3153
3154 /* Create a fresh last entry */
3155 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003156 }
3157#endif
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003158}
3159
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003160/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003161 * DTLS anti-replay: RFC 6347 4.1.2.6
3162 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003163 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3164 * Bit n is set iff record number in_window_top - n has been seen.
3165 *
3166 * Usually, in_window_top is the last record number seen and the lsb of
3167 * in_window is set. The only exception is the initial state (record number 0
3168 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00003171void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003172{
3173 ssl->in_window_top = 0;
3174 ssl->in_window = 0;
3175}
3176
3177static inline uint64_t ssl_load_six_bytes( unsigned char *buf )
3178{
3179 return( ( (uint64_t) buf[0] << 40 ) |
3180 ( (uint64_t) buf[1] << 32 ) |
3181 ( (uint64_t) buf[2] << 24 ) |
3182 ( (uint64_t) buf[3] << 16 ) |
3183 ( (uint64_t) buf[4] << 8 ) |
3184 ( (uint64_t) buf[5] ) );
3185}
3186
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003187static int mbedtls_ssl_dtls_record_replay_check( mbedtls_ssl_context *ssl, uint8_t *record_in_ctr )
3188{
Janos Follath865b3eb2019-12-16 11:46:15 +00003189 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003190 unsigned char *original_in_ctr;
3191
3192 // save original in_ctr
3193 original_in_ctr = ssl->in_ctr;
3194
3195 // use counter from record
3196 ssl->in_ctr = record_in_ctr;
3197
3198 ret = mbedtls_ssl_dtls_replay_check( (mbedtls_ssl_context const *) ssl );
3199
3200 // restore the counter
3201 ssl->in_ctr = original_in_ctr;
3202
3203 return ret;
3204}
3205
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003206/*
3207 * Return 0 if sequence number is acceptable, -1 otherwise
3208 */
Hanno Becker0183d692019-07-12 08:50:37 +01003209int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003210{
3211 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3212 uint64_t bit;
3213
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003214 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003215 return( 0 );
3216
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003217 if( rec_seqnum > ssl->in_window_top )
3218 return( 0 );
3219
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003220 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003221
3222 if( bit >= 64 )
3223 return( -1 );
3224
3225 if( ( ssl->in_window & ( (uint64_t) 1 << bit ) ) != 0 )
3226 return( -1 );
3227
3228 return( 0 );
3229}
3230
3231/*
3232 * Update replay window on new validated record
3233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003235{
3236 uint64_t rec_seqnum = ssl_load_six_bytes( ssl->in_ctr + 2 );
3237
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003238 if( ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED )
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003239 return;
3240
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003241 if( rec_seqnum > ssl->in_window_top )
3242 {
3243 /* Update window_top and the contents of the window */
3244 uint64_t shift = rec_seqnum - ssl->in_window_top;
3245
3246 if( shift >= 64 )
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003247 ssl->in_window = 1;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003248 else
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003249 {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003250 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003251 ssl->in_window |= 1;
3252 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003253
3254 ssl->in_window_top = rec_seqnum;
3255 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003256 else
3257 {
3258 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003259 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260
3261 if( bit < 64 ) /* Always true, but be extra sure */
3262 ssl->in_window |= (uint64_t) 1 << bit;
3263 }
3264}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003265#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003266
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003267#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003268/*
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003269 * Without any SSL context, check if a datagram looks like a ClientHello with
3270 * a valid cookie, and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003271 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003272 *
3273 * - if cookie is valid, return 0
3274 * - if ClientHello looks superficially valid but cookie is not,
3275 * fill obuf and set olen, then
3276 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3277 * - otherwise return a specific error code
3278 */
3279static int ssl_check_dtls_clihlo_cookie(
3280 mbedtls_ssl_cookie_write_t *f_cookie_write,
3281 mbedtls_ssl_cookie_check_t *f_cookie_check,
3282 void *p_cookie,
3283 const unsigned char *cli_id, size_t cli_id_len,
3284 const unsigned char *in, size_t in_len,
3285 unsigned char *obuf, size_t buf_len, size_t *olen )
3286{
3287 size_t sid_len, cookie_len;
3288 unsigned char *p;
3289
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003290 /*
3291 * Structure of ClientHello with record and handshake headers,
3292 * and expected values. We don't need to check a lot, more checks will be
3293 * done when actually parsing the ClientHello - skipping those checks
3294 * avoids code duplication and does not make cookie forging any easier.
3295 *
3296 * 0-0 ContentType type; copied, must be handshake
3297 * 1-2 ProtocolVersion version; copied
3298 * 3-4 uint16 epoch; copied, must be 0
3299 * 5-10 uint48 sequence_number; copied
3300 * 11-12 uint16 length; (ignored)
3301 *
3302 * 13-13 HandshakeType msg_type; (ignored)
3303 * 14-16 uint24 length; (ignored)
3304 * 17-18 uint16 message_seq; copied
3305 * 19-21 uint24 fragment_offset; copied, must be 0
3306 * 22-24 uint24 fragment_length; (ignored)
3307 *
3308 * 25-26 ProtocolVersion client_version; (ignored)
3309 * 27-58 Random random; (ignored)
3310 * 59-xx SessionID session_id; 1 byte len + sid_len content
3311 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3312 * ...
3313 *
3314 * Minimum length is 61 bytes.
3315 */
3316 if( in_len < 61 ||
3317 in[0] != MBEDTLS_SSL_MSG_HANDSHAKE ||
3318 in[3] != 0 || in[4] != 0 ||
3319 in[19] != 0 || in[20] != 0 || in[21] != 0 )
3320 {
3321 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3322 }
3323
3324 sid_len = in[59];
3325 if( sid_len > in_len - 61 )
3326 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3327
3328 cookie_len = in[60 + sid_len];
3329 if( cookie_len > in_len - 60 )
3330 return( MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO );
3331
3332 if( f_cookie_check( p_cookie, in + sid_len + 61, cookie_len,
3333 cli_id, cli_id_len ) == 0 )
3334 {
3335 /* Valid cookie */
3336 return( 0 );
3337 }
3338
3339 /*
3340 * If we get here, we've got an invalid cookie, let's prepare HVR.
3341 *
3342 * 0-0 ContentType type; copied
3343 * 1-2 ProtocolVersion version; copied
3344 * 3-4 uint16 epoch; copied
3345 * 5-10 uint48 sequence_number; copied
3346 * 11-12 uint16 length; olen - 13
3347 *
3348 * 13-13 HandshakeType msg_type; hello_verify_request
3349 * 14-16 uint24 length; olen - 25
3350 * 17-18 uint16 message_seq; copied
3351 * 19-21 uint24 fragment_offset; copied
3352 * 22-24 uint24 fragment_length; olen - 25
3353 *
3354 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3355 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3356 *
3357 * Minimum length is 28.
3358 */
3359 if( buf_len < 28 )
3360 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
3361
3362 /* Copy most fields and adapt others */
3363 memcpy( obuf, in, 25 );
3364 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3365 obuf[25] = 0xfe;
3366 obuf[26] = 0xff;
3367
3368 /* Generate and write actual cookie */
3369 p = obuf + 28;
3370 if( f_cookie_write( p_cookie,
3371 &p, obuf + buf_len, cli_id, cli_id_len ) != 0 )
3372 {
3373 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
3374 }
3375
3376 *olen = p - obuf;
3377
3378 /* Go back and fill length fields */
3379 obuf[27] = (unsigned char)( *olen - 28 );
3380
3381 obuf[14] = obuf[22] = (unsigned char)( ( *olen - 25 ) >> 16 );
3382 obuf[15] = obuf[23] = (unsigned char)( ( *olen - 25 ) >> 8 );
3383 obuf[16] = obuf[24] = (unsigned char)( ( *olen - 25 ) );
3384
3385 obuf[11] = (unsigned char)( ( *olen - 13 ) >> 8 );
3386 obuf[12] = (unsigned char)( ( *olen - 13 ) );
3387
3388 return( MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED );
3389}
3390
3391/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003392 * Handle possible client reconnect with the same UDP quadruplet
3393 * (RFC 6347 Section 4.2.8).
3394 *
3395 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3396 * that looks like a ClientHello.
3397 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003398 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003399 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003400 * - if the input looks like a ClientHello with a valid cookie,
3401 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003402 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003403 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003404 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003405 * This function is called (through ssl_check_client_reconnect()) when an
3406 * unexpected record is found in ssl_get_next_record(), which will discard the
3407 * record if we return 0, and bubble up the return value otherwise (this
3408 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3409 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003410 */
3411static int ssl_handle_possible_reconnect( mbedtls_ssl_context *ssl )
3412{
Janos Follath865b3eb2019-12-16 11:46:15 +00003413 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003414 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003415
Hanno Becker2fddd372019-07-10 14:37:41 +01003416 if( ssl->conf->f_cookie_write == NULL ||
3417 ssl->conf->f_cookie_check == NULL )
3418 {
3419 /* If we can't use cookies to verify reachability of the peer,
3420 * drop the record. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no cookie callbacks, "
3422 "can't check reconnect validity" ) );
Hanno Becker2fddd372019-07-10 14:37:41 +01003423 return( 0 );
3424 }
3425
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003426 ret = ssl_check_dtls_clihlo_cookie(
3427 ssl->conf->f_cookie_write,
3428 ssl->conf->f_cookie_check,
3429 ssl->conf->p_cookie,
3430 ssl->cli_id, ssl->cli_id_len,
3431 ssl->in_buf, ssl->in_left,
Angus Grattond8213d02016-05-25 20:56:48 +10003432 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003433
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003434 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_dtls_clihlo_cookie", ret );
3435
3436 if( ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003437 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003438 int send_ret;
3439 MBEDTLS_SSL_DEBUG_MSG( 1, ( "sending HelloVerifyRequest" ) );
3440 MBEDTLS_SSL_DEBUG_BUF( 4, "output record sent to network",
3441 ssl->out_buf, len );
Brian J Murray1903fb32016-11-06 04:45:15 -08003442 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003443 * If the error is permanent we'll catch it later,
3444 * if it's not, then hopefully it'll work next time. */
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003445 send_ret = ssl->f_send( ssl->p_bio, ssl->out_buf, len );
3446 MBEDTLS_SSL_DEBUG_RET( 2, "ssl->f_send", send_ret );
3447 (void) send_ret;
3448
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003449 return( 0 );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003450 }
3451
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003452 if( ret == 0 )
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003453 {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "cookie is valid, resetting context" ) );
Hanno Becker43aefe22020-02-05 10:44:56 +00003455 if( ( ret = mbedtls_ssl_session_reset_int( ssl, 1 ) ) != 0 )
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003456 {
3457 MBEDTLS_SSL_DEBUG_RET( 1, "reset", ret );
3458 return( ret );
3459 }
3460
3461 return( MBEDTLS_ERR_SSL_CLIENT_RECONNECT );
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003462 }
3463
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464 return( ret );
3465}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003466#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003467
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003468static int ssl_check_record_type( uint8_t record_type )
3469{
3470 if( record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
3471 record_type != MBEDTLS_SSL_MSG_ALERT &&
3472 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
3473 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
3474 {
3475 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3476 }
3477
3478 return( 0 );
3479}
3480
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003481/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003482 * ContentType type;
3483 * ProtocolVersion version;
3484 * uint16 epoch; // DTLS only
3485 * uint48 sequence_number; // DTLS only
3486 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003487 *
3488 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003489 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003490 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3491 *
3492 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003493 * 1. proceed with the record if this function returns 0
3494 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3495 * 3. return CLIENT_RECONNECT if this function return that value
3496 * 4. drop the whole datagram if this function returns anything else.
3497 * Point 2 is needed when the peer is resending, and we have already received
3498 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003499 */
Hanno Becker331de3d2019-07-12 11:10:16 +01003500static int ssl_parse_record_header( mbedtls_ssl_context const *ssl,
Hanno Beckere5e7e782019-07-11 12:29:35 +01003501 unsigned char *buf,
3502 size_t len,
3503 mbedtls_record *rec )
Paul Bakker5121ce52009-01-03 21:22:43 +00003504{
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003505 int major_ver, minor_ver;
Paul Bakker5121ce52009-01-03 21:22:43 +00003506
Hanno Beckere5e7e782019-07-11 12:29:35 +01003507 size_t const rec_hdr_type_offset = 0;
3508 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003509
Hanno Beckere5e7e782019-07-11 12:29:35 +01003510 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3511 rec_hdr_type_len;
3512 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003513
Hanno Beckere5e7e782019-07-11 12:29:35 +01003514 size_t const rec_hdr_ctr_len = 8;
3515#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003516 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003517 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3518 rec_hdr_version_len;
3519
Hanno Beckera0e20d02019-05-15 14:03:01 +01003520#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003521 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3522 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003523 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003524#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3525#endif /* MBEDTLS_SSL_PROTO_DTLS */
3526
3527 size_t rec_hdr_len_offset; /* To be determined */
3528 size_t const rec_hdr_len_len = 2;
3529
3530 /*
3531 * Check minimum lengths for record header.
3532 */
3533
3534#if defined(MBEDTLS_SSL_PROTO_DTLS)
3535 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3536 {
3537 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
3538 }
3539 else
3540#endif /* MBEDTLS_SSL_PROTO_DTLS */
3541 {
3542 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3543 }
3544
3545 if( len < rec_hdr_len_offset + rec_hdr_len_len )
3546 {
3547 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header of length %u",
3548 (unsigned) len,
3549 (unsigned)( rec_hdr_len_len + rec_hdr_len_len ) ) );
3550 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3551 }
3552
3553 /*
3554 * Parse and validate record content type
3555 */
3556
3557 rec->type = buf[ rec_hdr_type_offset ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003558
3559 /* Check record content type */
3560#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3561 rec->cid_len = 0;
3562
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003563 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 ssl->conf->cid_len != 0 &&
3565 rec->type == MBEDTLS_SSL_MSG_CID )
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003566 {
3567 /* Shift pointers to account for record header including CID
3568 * struct {
3569 * ContentType special_type = tls12_cid;
3570 * ProtocolVersion version;
3571 * uint16 epoch;
3572 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003573 * opaque cid[cid_length]; // Additional field compared to
3574 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003575 * uint16 length;
3576 * opaque enc_content[DTLSCiphertext.length];
3577 * } DTLSCiphertext;
3578 */
3579
3580 /* So far, we only support static CID lengths
3581 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003582 rec_hdr_cid_len = ssl->conf->cid_len;
3583 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003584
Hanno Beckere5e7e782019-07-11 12:29:35 +01003585 if( len < rec_hdr_len_offset + rec_hdr_len_len )
Hanno Beckere538d822019-07-10 14:50:10 +01003586 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003587 MBEDTLS_SSL_DEBUG_MSG( 1, ( "datagram of length %u too small to hold DTLS record header including CID, length %u",
3588 (unsigned) len,
3589 (unsigned)( rec_hdr_len_offset + rec_hdr_len_len ) ) );
Hanno Becker59be60e2019-07-10 14:53:43 +01003590 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Beckere538d822019-07-10 14:50:10 +01003591 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003593 /* configured CID len is guaranteed at most 255, see
3594 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3595 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003596 memcpy( rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len );
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003597 }
3598 else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003599#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003600 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003601 if( ssl_check_record_type( rec->type ) )
3602 {
Hanno Becker54229812019-07-12 14:40:00 +01003603 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type %u",
3604 (unsigned) rec->type ) );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003605 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3606 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003607 }
3608
Hanno Beckere5e7e782019-07-11 12:29:35 +01003609 /*
3610 * Parse and validate record version
3611 */
3612
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003613 rec->ver[0] = buf[ rec_hdr_version_offset + 0 ];
3614 rec->ver[1] = buf[ rec_hdr_version_offset + 1 ];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003615 mbedtls_ssl_read_version( &major_ver, &minor_ver,
3616 ssl->conf->transport,
Hanno Beckerd0b66d02019-07-26 08:07:03 +01003617 &rec->ver[0] );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003618
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01003619 if( major_ver != ssl->major_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003620 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621 MBEDTLS_SSL_DEBUG_MSG( 1, ( "major version mismatch" ) );
3622 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003623 }
3624
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003625 if( minor_ver > ssl->conf->max_minor_ver )
Paul Bakker5121ce52009-01-03 21:22:43 +00003626 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627 MBEDTLS_SSL_DEBUG_MSG( 1, ( "minor version mismatch" ) );
3628 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003629 }
3630
Hanno Beckere5e7e782019-07-11 12:29:35 +01003631 /*
3632 * Parse/Copy record sequence number.
3633 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003634
Hanno Beckere5e7e782019-07-11 12:29:35 +01003635#if defined(MBEDTLS_SSL_PROTO_DTLS)
3636 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003637 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003638 /* Copy explicit record sequence number from input buffer. */
3639 memcpy( &rec->ctr[0], buf + rec_hdr_ctr_offset,
3640 rec_hdr_ctr_len );
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003641 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003642 else
3643#endif /* MBEDTLS_SSL_PROTO_DTLS */
3644 {
3645 /* Copy implicit record sequence number from SSL context structure. */
3646 memcpy( &rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len );
3647 }
Paul Bakker40e46942009-01-03 21:51:57 +00003648
Hanno Beckere5e7e782019-07-11 12:29:35 +01003649 /*
3650 * Parse record length.
3651 */
3652
Hanno Beckere5e7e782019-07-11 12:29:35 +01003653 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Hanno Becker9eca2762019-07-25 10:16:37 +01003654 rec->data_len = ( (size_t) buf[ rec_hdr_len_offset + 0 ] << 8 ) |
3655 ( (size_t) buf[ rec_hdr_len_offset + 1 ] << 0 );
Hanno Beckere5e7e782019-07-11 12:29:35 +01003656 MBEDTLS_SSL_DEBUG_BUF( 4, "input record header", buf, rec->data_offset );
Paul Bakker5121ce52009-01-03 21:22:43 +00003657
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003658 MBEDTLS_SSL_DEBUG_MSG( 3, ( "input record: msgtype = %d, "
Hanno Becker92d30f52019-05-23 17:03:44 +01003659 "version = [%d:%d], msglen = %d",
Hanno Beckere5e7e782019-07-11 12:29:35 +01003660 rec->type,
3661 major_ver, minor_ver, rec->data_len ) );
3662
3663 rec->buf = buf;
3664 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003665
Hanno Beckerd417cc92019-07-26 08:20:27 +01003666 if( rec->data_len == 0 )
3667 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Paul Bakker5121ce52009-01-03 21:22:43 +00003668
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003669 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003670 * DTLS-related tests.
3671 * Check epoch before checking length constraint because
3672 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3673 * message gets duplicated before the corresponding Finished message,
3674 * the second ChangeCipherSpec should be discarded because it belongs
3675 * to an old epoch, but not because its length is shorter than
3676 * the minimum record length for packets using the new record transform.
3677 * Note that these two kinds of failures are handled differently,
3678 * as an unexpected record is silently skipped but an invalid
3679 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003680 */
3681#if defined(MBEDTLS_SSL_PROTO_DTLS)
3682 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3683 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003684 rec_epoch = ( rec->ctr[0] << 8 ) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003685
Hanno Becker955a5c92019-07-10 17:12:07 +01003686 /* Check that the datagram is large enough to contain a record
3687 * of the advertised length. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003688 if( len < rec->data_offset + rec->data_len )
Hanno Becker955a5c92019-07-10 17:12:07 +01003689 {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003690 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Datagram of length %u too small to contain record of advertised length %u.",
3691 (unsigned) len,
3692 (unsigned)( rec->data_offset + rec->data_len ) ) );
Hanno Becker955a5c92019-07-10 17:12:07 +01003693 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3694 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003695
Hanno Becker37cfe732019-07-10 17:20:01 +01003696 /* Records from other, non-matching epochs are silently discarded.
3697 * (The case of same-port Client reconnects must be considered in
3698 * the caller). */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003699 if( rec_epoch != ssl->in_epoch )
3700 {
3701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record from another epoch: "
3702 "expected %d, received %d",
3703 ssl->in_epoch, rec_epoch ) );
3704
Hanno Becker552f7472019-07-19 10:59:12 +01003705 /* Records from the next epoch are considered for buffering
3706 * (concretely: early Finished messages). */
3707 if( rec_epoch == (unsigned) ssl->in_epoch + 1 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003708 {
Hanno Becker552f7472019-07-19 10:59:12 +01003709 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Consider record for buffering" ) );
3710 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003712
Hanno Becker2fddd372019-07-10 14:37:41 +01003713 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003714 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003715#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003716 /* For records from the correct epoch, check whether their
3717 * sequence number has been seen before. */
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003718 else if( mbedtls_ssl_dtls_record_replay_check( (mbedtls_ssl_context *) ssl,
3719 &rec->ctr[0] ) != 0 )
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003720 {
3721 MBEDTLS_SSL_DEBUG_MSG( 1, ( "replayed record" ) );
3722 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
3723 }
3724#endif
3725 }
3726#endif /* MBEDTLS_SSL_PROTO_DTLS */
3727
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003728 return( 0 );
3729}
Paul Bakker5121ce52009-01-03 21:22:43 +00003730
Paul Bakker5121ce52009-01-03 21:22:43 +00003731
Hanno Becker2fddd372019-07-10 14:37:41 +01003732#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
3733static int ssl_check_client_reconnect( mbedtls_ssl_context *ssl )
3734{
3735 unsigned int rec_epoch = ( ssl->in_ctr[0] << 8 ) | ssl->in_ctr[1];
3736
3737 /*
3738 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3739 * access the first byte of record content (handshake type), as we
3740 * have an active transform (possibly iv_len != 0), so use the
3741 * fact that the record header len is 13 instead.
3742 */
3743 if( rec_epoch == 0 &&
3744 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
3745 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER &&
3746 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3747 ssl->in_left > 13 &&
3748 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO )
3749 {
3750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "possible client reconnect "
3751 "from the same port" ) );
3752 return( ssl_handle_possible_reconnect( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00003753 }
3754
3755 return( 0 );
3756}
Hanno Becker2fddd372019-07-10 14:37:41 +01003757#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003758
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003759/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003760 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003761 */
Hanno Beckerfdf66042019-07-11 13:07:45 +01003762static int ssl_prepare_record_content( mbedtls_ssl_context *ssl,
3763 mbedtls_record *rec )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003764{
3765 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767 MBEDTLS_SSL_DEBUG_BUF( 4, "input record from network",
Hanno Beckerfdf66042019-07-11 13:07:45 +01003768 rec->buf, rec->buf_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003769
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
3771 if( mbedtls_ssl_hw_record_read != NULL )
Paul Bakker05ef8352012-05-08 09:17:57 +00003772 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773 MBEDTLS_SSL_DEBUG_MSG( 2, ( "going for mbedtls_ssl_hw_record_read()" ) );
Paul Bakker05ef8352012-05-08 09:17:57 +00003774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775 ret = mbedtls_ssl_hw_record_read( ssl );
3776 if( ret != 0 && ret != MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH )
Paul Bakker05ef8352012-05-08 09:17:57 +00003777 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003778 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_read", ret );
3779 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Paul Bakker05ef8352012-05-08 09:17:57 +00003780 }
Paul Bakkerc7878112012-12-19 14:41:14 +01003781
3782 if( ret == 0 )
3783 done = 1;
Paul Bakker05ef8352012-05-08 09:17:57 +00003784 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003785#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker48916f92012-09-16 19:57:18 +00003786 if( !done && ssl->transform_in != NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00003787 {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003788 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003789
Hanno Beckera18d1322018-01-03 14:27:32 +00003790 if( ( ret = mbedtls_ssl_decrypt_buf( ssl, ssl->transform_in,
Hanno Beckerfdf66042019-07-11 13:07:45 +01003791 rec ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00003792 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003793 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decrypt_buf", ret );
Hanno Becker8367ccc2019-05-14 11:30:10 +01003794
Hanno Beckera0e20d02019-05-15 14:03:01 +01003795#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01003796 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
3797 ssl->conf->ignore_unexpected_cid
3798 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE )
3799 {
Hanno Beckere8d6afd2019-05-24 10:11:06 +01003800 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ignoring unexpected CID" ) );
Hanno Becker16ded982019-05-08 13:02:55 +01003801 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003802 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003803#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003804
Paul Bakker5121ce52009-01-03 21:22:43 +00003805 return( ret );
3806 }
3807
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003808 if( old_msg_type != rec->type )
Hanno Becker6430faf2019-05-08 11:57:13 +01003809 {
3810 MBEDTLS_SSL_DEBUG_MSG( 4, ( "record type after decrypt (before %d): %d",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003811 old_msg_type, rec->type ) );
Hanno Becker6430faf2019-05-08 11:57:13 +01003812 }
3813
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003814 MBEDTLS_SSL_DEBUG_BUF( 4, "input payload after decrypt",
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003815 rec->buf + rec->data_offset, rec->data_len );
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003816
Hanno Beckera0e20d02019-05-15 14:03:01 +01003817#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003818 /* We have already checked the record content type
3819 * in ssl_parse_record_header(), failing or silently
3820 * dropping the record in the case of an unknown type.
3821 *
3822 * Since with the use of CIDs, the record content type
3823 * might change during decryption, re-check the record
3824 * content type, but treat a failure as fatal this time. */
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003825 if( ssl_check_record_type( rec->type ) )
Hanno Becker6430faf2019-05-08 11:57:13 +01003826 {
3827 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unknown record type" ) );
3828 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3829 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003830#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003831
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003832 if( rec->data_len == 0 )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003833 {
3834#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3835 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_3
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003836 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003837 {
3838 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
3839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid zero-length message type: %d", ssl->in_msgtype ) );
3840 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3841 }
3842#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3843
3844 ssl->nb_zero++;
3845
3846 /*
3847 * Three or more empty messages may be a DoS attack
3848 * (excessive CPU consumption).
3849 */
3850 if( ssl->nb_zero > 3 )
3851 {
3852 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received four consecutive empty "
Hanno Becker6e7700d2019-05-08 10:38:32 +01003853 "messages, possible DoS attack" ) );
3854 /* Treat the records as if they were not properly authenticated,
3855 * thereby failing the connection if we see more than allowed
3856 * by the configured bad MAC threshold. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003857 return( MBEDTLS_ERR_SSL_INVALID_MAC );
3858 }
3859 }
3860 else
3861 ssl->nb_zero = 0;
3862
3863#if defined(MBEDTLS_SSL_PROTO_DTLS)
3864 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
3865 {
3866 ; /* in_ctr read from peer, not maintained internally */
3867 }
3868 else
3869#endif
3870 {
3871 unsigned i;
Hanno Beckerdd772292020-02-05 10:38:31 +00003872 for( i = 8; i > mbedtls_ssl_ep_len( ssl ); i-- )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003873 if( ++ssl->in_ctr[i - 1] != 0 )
3874 break;
3875
3876 /* The loop goes to its end iff the counter is wrapping */
Hanno Beckerdd772292020-02-05 10:38:31 +00003877 if( i == mbedtls_ssl_ep_len( ssl ) )
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003878 {
3879 MBEDTLS_SSL_DEBUG_MSG( 1, ( "incoming message counter would wrap" ) );
3880 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
3881 }
3882 }
3883
Paul Bakker5121ce52009-01-03 21:22:43 +00003884 }
3885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02003887 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003888 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889 mbedtls_ssl_dtls_replay_update( ssl );
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003890 }
3891#endif
3892
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003893 /* Check actual (decrypted) record content length against
3894 * configured maximum. */
3895 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
3896 {
3897 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
3898 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
3899 }
3900
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003901 return( 0 );
3902}
3903
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003904/*
3905 * Read a record.
3906 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003907 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3908 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3909 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003910 */
Hanno Becker1097b342018-08-15 14:09:41 +01003911
3912/* Helper functions for mbedtls_ssl_read_record(). */
3913static int ssl_consume_current_message( mbedtls_ssl_context *ssl );
Hanno Beckere74d5562018-08-15 14:26:08 +01003914static int ssl_get_next_record( mbedtls_ssl_context *ssl );
3915static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl );
Hanno Becker4162b112018-08-15 14:05:04 +01003916
Hanno Becker327c93b2018-08-15 13:56:18 +01003917int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
Hanno Becker3a0aad12018-08-20 09:44:02 +01003918 unsigned update_hs_digest )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003919{
Janos Follath865b3eb2019-12-16 11:46:15 +00003920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003922 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read record" ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003923
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003924 if( ssl->keep_current_message == 0 )
3925 {
3926 do {
Simon Butcher99000142016-10-13 17:21:01 +01003927
Hanno Becker26994592018-08-15 14:14:59 +01003928 ret = ssl_consume_current_message( ssl );
Hanno Becker90333da2017-10-10 11:27:13 +01003929 if( ret != 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003930 return( ret );
Hanno Becker26994592018-08-15 14:14:59 +01003931
Hanno Beckere74d5562018-08-15 14:26:08 +01003932 if( ssl_record_is_in_progress( ssl ) == 0 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003933 {
Hanno Becker40f50842018-08-15 14:48:01 +01003934#if defined(MBEDTLS_SSL_PROTO_DTLS)
3935 int have_buffered = 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01003936
Hanno Becker40f50842018-08-15 14:48:01 +01003937 /* We only check for buffered messages if the
3938 * current datagram is fully consumed. */
3939 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckeref7afdf2018-08-28 17:16:31 +01003940 ssl_next_record_is_in_datagram( ssl ) == 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01003941 {
Hanno Becker40f50842018-08-15 14:48:01 +01003942 if( ssl_load_buffered_message( ssl ) == 0 )
3943 have_buffered = 1;
3944 }
3945
3946 if( have_buffered == 0 )
3947#endif /* MBEDTLS_SSL_PROTO_DTLS */
3948 {
3949 ret = ssl_get_next_record( ssl );
3950 if( ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING )
3951 continue;
3952
3953 if( ret != 0 )
3954 {
Hanno Beckerc573ac32018-08-28 17:15:25 +01003955 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_get_next_record" ), ret );
Hanno Becker40f50842018-08-15 14:48:01 +01003956 return( ret );
3957 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003958 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003959 }
3960
3961 ret = mbedtls_ssl_handle_message_type( ssl );
3962
Hanno Becker40f50842018-08-15 14:48:01 +01003963#if defined(MBEDTLS_SSL_PROTO_DTLS)
3964 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
3965 {
3966 /* Buffer future message */
3967 ret = ssl_buffer_message( ssl );
3968 if( ret != 0 )
3969 return( ret );
3970
3971 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3972 }
3973#endif /* MBEDTLS_SSL_PROTO_DTLS */
3974
Hanno Becker90333da2017-10-10 11:27:13 +01003975 } while( MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3976 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003977
3978 if( 0 != ret )
Simon Butcher99000142016-10-13 17:21:01 +01003979 {
Hanno Becker05c4fc82017-11-09 14:34:06 +00003980 MBEDTLS_SSL_DEBUG_RET( 1, ( "mbedtls_ssl_handle_message_type" ), ret );
Simon Butcher99000142016-10-13 17:21:01 +01003981 return( ret );
3982 }
3983
Hanno Becker327c93b2018-08-15 13:56:18 +01003984 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Becker3a0aad12018-08-20 09:44:02 +01003985 update_hs_digest == 1 )
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003986 {
3987 mbedtls_ssl_update_handshake_status( ssl );
3988 }
Simon Butcher99000142016-10-13 17:21:01 +01003989 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003990 else
Simon Butcher99000142016-10-13 17:21:01 +01003991 {
Hanno Becker02f59072018-08-15 14:00:24 +01003992 MBEDTLS_SSL_DEBUG_MSG( 2, ( "reuse previously read message" ) );
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003993 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003994 }
3995
3996 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read record" ) );
3997
3998 return( 0 );
3999}
4000
Hanno Becker40f50842018-08-15 14:48:01 +01004001#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004002static int ssl_next_record_is_in_datagram( mbedtls_ssl_context *ssl )
Simon Butcher99000142016-10-13 17:21:01 +01004003{
Hanno Becker40f50842018-08-15 14:48:01 +01004004 if( ssl->in_left > ssl->next_record_offset )
4005 return( 1 );
Simon Butcher99000142016-10-13 17:21:01 +01004006
Hanno Becker40f50842018-08-15 14:48:01 +01004007 return( 0 );
4008}
4009
4010static int ssl_load_buffered_message( mbedtls_ssl_context *ssl )
4011{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004012 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker37f95322018-08-16 13:55:32 +01004013 mbedtls_ssl_hs_buffer * hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004014 int ret = 0;
4015
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004016 if( hs == NULL )
4017 return( -1 );
4018
Hanno Beckere00ae372018-08-20 09:39:42 +01004019 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_messsage" ) );
4020
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004021 if( ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4022 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4023 {
4024 /* Check if we have seen a ChangeCipherSpec before.
4025 * If yes, synthesize a CCS record. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004026 if( !hs->buffering.seen_ccs )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004027 {
4028 MBEDTLS_SSL_DEBUG_MSG( 2, ( "CCS not seen in the current flight" ) );
4029 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004030 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004031 }
4032
Hanno Becker39b8bc92018-08-28 17:17:13 +01004033 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Injecting buffered CCS message" ) );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004034 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4035 ssl->in_msglen = 1;
4036 ssl->in_msg[0] = 1;
4037
4038 /* As long as they are equal, the exact value doesn't matter. */
4039 ssl->in_left = 0;
4040 ssl->next_record_offset = 0;
4041
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004042 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004043 goto exit;
4044 }
Hanno Becker37f95322018-08-16 13:55:32 +01004045
Hanno Beckerb8f50142018-08-28 10:01:34 +01004046#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004047 /* Debug only */
4048 {
4049 unsigned offset;
4050 for( offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
4051 {
4052 hs_buf = &hs->buffering.hs[offset];
4053 if( hs_buf->is_valid == 1 )
4054 {
4055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Future message with sequence number %u %s buffered.",
4056 hs->in_msg_seq + offset,
Hanno Beckera591c482018-08-28 17:20:00 +01004057 hs_buf->is_complete ? "fully" : "partially" ) );
Hanno Becker37f95322018-08-16 13:55:32 +01004058 }
4059 }
4060 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004061#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004062
4063 /* Check if we have buffered and/or fully reassembled the
4064 * next handshake message. */
4065 hs_buf = &hs->buffering.hs[0];
4066 if( ( hs_buf->is_valid == 1 ) && ( hs_buf->is_complete == 1 ) )
4067 {
4068 /* Synthesize a record containing the buffered HS message. */
4069 size_t msg_len = ( hs_buf->data[1] << 16 ) |
4070 ( hs_buf->data[2] << 8 ) |
4071 hs_buf->data[3];
4072
4073 /* Double-check that we haven't accidentally buffered
4074 * a message that doesn't fit into the input buffer. */
4075 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
4076 {
4077 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4078 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4079 }
4080
4081 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message has been buffered - load" ) );
4082 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered handshake message (incl. header)",
4083 hs_buf->data, msg_len + 12 );
4084
4085 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4086 ssl->in_hslen = msg_len + 12;
4087 ssl->in_msglen = msg_len + 12;
4088 memcpy( ssl->in_msg, hs_buf->data, ssl->in_hslen );
4089
4090 ret = 0;
4091 goto exit;
4092 }
4093 else
4094 {
4095 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Next handshake message %u not or only partially bufffered",
4096 hs->in_msg_seq ) );
4097 }
4098
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004099 ret = -1;
4100
4101exit:
4102
4103 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_message" ) );
4104 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004105}
4106
Hanno Beckera02b0b42018-08-21 17:20:27 +01004107static int ssl_buffer_make_space( mbedtls_ssl_context *ssl,
4108 size_t desired )
4109{
4110 int offset;
4111 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Attempt to free buffered messages to have %u bytes available",
4113 (unsigned) desired ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004114
Hanno Becker01315ea2018-08-21 17:22:17 +01004115 /* Get rid of future records epoch first, if such exist. */
4116 ssl_free_buffered_record( ssl );
4117
4118 /* Check if we have enough space available now. */
4119 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4120 hs->buffering.total_bytes_buffered ) )
4121 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004122 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing future epoch record" ) );
Hanno Becker01315ea2018-08-21 17:22:17 +01004123 return( 0 );
4124 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004125
Hanno Becker4f432ad2018-08-28 10:02:32 +01004126 /* We don't have enough space to buffer the next expected handshake
4127 * message. Remove buffers used for future messages to gain space,
4128 * starting with the most distant one. */
Hanno Beckera02b0b42018-08-21 17:20:27 +01004129 for( offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4130 offset >= 0; offset-- )
4131 {
4132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Free buffering slot %d to make space for reassembly of next handshake message",
4133 offset ) );
4134
Hanno Beckerb309b922018-08-23 13:18:05 +01004135 ssl_buffering_free_slot( ssl, (uint8_t) offset );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004136
4137 /* Check if we have enough space available now. */
4138 if( desired <= ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4139 hs->buffering.total_bytes_buffered ) )
4140 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004141 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Enough space available after freeing buffered HS messages" ) );
Hanno Beckera02b0b42018-08-21 17:20:27 +01004142 return( 0 );
4143 }
4144 }
4145
4146 return( -1 );
4147}
4148
Hanno Becker40f50842018-08-15 14:48:01 +01004149static int ssl_buffer_message( mbedtls_ssl_context *ssl )
4150{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004151 int ret = 0;
4152 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4153
4154 if( hs == NULL )
4155 return( 0 );
4156
4157 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_buffer_message" ) );
4158
4159 switch( ssl->in_msgtype )
4160 {
4161 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
4162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Remember CCS message" ) );
Hanno Beckere678eaa2018-08-21 14:57:46 +01004163
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004164 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004165 break;
4166
4167 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004168 {
4169 unsigned recv_msg_seq_offset;
4170 unsigned recv_msg_seq = ( ssl->in_msg[4] << 8 ) | ssl->in_msg[5];
4171 mbedtls_ssl_hs_buffer *hs_buf;
4172 size_t msg_len = ssl->in_hslen - 12;
4173
4174 /* We should never receive an old handshake
4175 * message - double-check nonetheless. */
4176 if( recv_msg_seq < ssl->handshake->in_msg_seq )
4177 {
4178 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4179 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4180 }
4181
4182 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
4183 if( recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS )
4184 {
4185 /* Silently ignore -- message too far in the future */
4186 MBEDTLS_SSL_DEBUG_MSG( 2,
4187 ( "Ignore future HS message with sequence number %u, "
4188 "buffering window %u - %u",
4189 recv_msg_seq, ssl->handshake->in_msg_seq,
4190 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS - 1 ) );
4191
4192 goto exit;
4193 }
4194
4195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffering HS message with sequence number %u, offset %u ",
4196 recv_msg_seq, recv_msg_seq_offset ) );
4197
4198 hs_buf = &hs->buffering.hs[ recv_msg_seq_offset ];
4199
4200 /* Check if the buffering for this seq nr has already commenced. */
Hanno Becker4422bbb2018-08-20 09:40:19 +01004201 if( !hs_buf->is_valid )
Hanno Becker37f95322018-08-16 13:55:32 +01004202 {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004203 size_t reassembly_buf_sz;
4204
Hanno Becker37f95322018-08-16 13:55:32 +01004205 hs_buf->is_fragmented =
4206 ( ssl_hs_is_proper_fragment( ssl ) == 1 );
4207
4208 /* We copy the message back into the input buffer
4209 * after reassembly, so check that it's not too large.
4210 * This is an implementation-specific limitation
4211 * and not one from the standard, hence it is not
4212 * checked in ssl_check_hs_header(). */
Hanno Becker96a6c692018-08-21 15:56:03 +01004213 if( msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN )
Hanno Becker37f95322018-08-16 13:55:32 +01004214 {
4215 /* Ignore message */
4216 goto exit;
4217 }
4218
Hanno Beckere0b150f2018-08-21 15:51:03 +01004219 /* Check if we have enough space to buffer the message. */
4220 if( hs->buffering.total_bytes_buffered >
4221 MBEDTLS_SSL_DTLS_MAX_BUFFERING )
4222 {
4223 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4224 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4225 }
4226
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004227 reassembly_buf_sz = ssl_get_reassembly_buffer_size( msg_len,
4228 hs_buf->is_fragmented );
Hanno Beckere0b150f2018-08-21 15:51:03 +01004229
4230 if( reassembly_buf_sz > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4231 hs->buffering.total_bytes_buffered ) )
4232 {
4233 if( recv_msg_seq_offset > 0 )
4234 {
4235 /* If we can't buffer a future message because
4236 * of space limitations -- ignore. */
4237 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",
4238 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4239 (unsigned) hs->buffering.total_bytes_buffered ) );
4240 goto exit;
4241 }
Hanno Beckere1801392018-08-21 16:51:05 +01004242 else
4243 {
4244 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",
4245 (unsigned) msg_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4246 (unsigned) hs->buffering.total_bytes_buffered ) );
4247 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004248
Hanno Beckera02b0b42018-08-21 17:20:27 +01004249 if( ssl_buffer_make_space( ssl, reassembly_buf_sz ) != 0 )
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004250 {
Hanno Becker6e12c1e2018-08-24 14:39:15 +01004251 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",
4252 (unsigned) msg_len,
4253 (unsigned) reassembly_buf_sz,
4254 MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Beckere0b150f2018-08-21 15:51:03 +01004255 (unsigned) hs->buffering.total_bytes_buffered ) );
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004256 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4257 goto exit;
4258 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004259 }
4260
4261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "initialize reassembly, total length = %d",
4262 msg_len ) );
4263
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004264 hs_buf->data = mbedtls_calloc( 1, reassembly_buf_sz );
4265 if( hs_buf->data == NULL )
Hanno Becker37f95322018-08-16 13:55:32 +01004266 {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004267 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004268 goto exit;
4269 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004270 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004271
4272 /* Prepare final header: copy msg_type, length and message_seq,
4273 * then add standardised fragment_offset and fragment_length */
4274 memcpy( hs_buf->data, ssl->in_msg, 6 );
4275 memset( hs_buf->data + 6, 0, 3 );
4276 memcpy( hs_buf->data + 9, hs_buf->data + 1, 3 );
4277
4278 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004279
4280 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004281 }
4282 else
4283 {
4284 /* Make sure msg_type and length are consistent */
4285 if( memcmp( hs_buf->data, ssl->in_msg, 4 ) != 0 )
4286 {
4287 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Fragment header mismatch - ignore" ) );
4288 /* Ignore */
4289 goto exit;
4290 }
4291 }
4292
Hanno Becker4422bbb2018-08-20 09:40:19 +01004293 if( !hs_buf->is_complete )
Hanno Becker37f95322018-08-16 13:55:32 +01004294 {
4295 size_t frag_len, frag_off;
4296 unsigned char * const msg = hs_buf->data + 12;
4297
4298 /*
4299 * Check and copy current fragment
4300 */
4301
4302 /* Validation of header fields already done in
4303 * mbedtls_ssl_prepare_handshake_record(). */
4304 frag_off = ssl_get_hs_frag_off( ssl );
4305 frag_len = ssl_get_hs_frag_len( ssl );
4306
4307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "adding fragment, offset = %d, length = %d",
4308 frag_off, frag_len ) );
4309 memcpy( msg + frag_off, ssl->in_msg + 12, frag_len );
4310
4311 if( hs_buf->is_fragmented )
4312 {
4313 unsigned char * const bitmask = msg + msg_len;
4314 ssl_bitmask_set( bitmask, frag_off, frag_len );
4315 hs_buf->is_complete = ( ssl_bitmask_check( bitmask,
4316 msg_len ) == 0 );
4317 }
4318 else
4319 {
4320 hs_buf->is_complete = 1;
4321 }
4322
4323 MBEDTLS_SSL_DEBUG_MSG( 2, ( "message %scomplete",
4324 hs_buf->is_complete ? "" : "not yet " ) );
4325 }
4326
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004327 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004328 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004329
4330 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004331 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004332 break;
4333 }
4334
4335exit:
4336
4337 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_buffer_message" ) );
4338 return( ret );
Hanno Becker40f50842018-08-15 14:48:01 +01004339}
4340#endif /* MBEDTLS_SSL_PROTO_DTLS */
4341
Hanno Becker1097b342018-08-15 14:09:41 +01004342static int ssl_consume_current_message( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004343{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004344 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004345 * Consume last content-layer message and potentially
4346 * update in_msglen which keeps track of the contents'
4347 * consumption state.
4348 *
4349 * (1) Handshake messages:
4350 * Remove last handshake message, move content
4351 * and adapt in_msglen.
4352 *
4353 * (2) Alert messages:
4354 * Consume whole record content, in_msglen = 0.
4355 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004356 * (3) Change cipher spec:
4357 * Consume whole record content, in_msglen = 0.
4358 *
4359 * (4) Application data:
4360 * Don't do anything - the record layer provides
4361 * the application data as a stream transport
4362 * and consumes through mbedtls_ssl_read only.
4363 *
4364 */
4365
4366 /* Case (1): Handshake messages */
4367 if( ssl->in_hslen != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004368 {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004369 /* Hard assertion to be sure that no application data
4370 * is in flight, as corrupting ssl->in_msglen during
4371 * ssl->in_offt != NULL is fatal. */
4372 if( ssl->in_offt != NULL )
4373 {
4374 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4375 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4376 }
4377
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004378 /*
4379 * Get next Handshake message in the current record
4380 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004381
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004383 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004384 * current handshake content: If DTLS handshake
4385 * fragmentation is used, that's the fragment
4386 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004387 * size here is faulty and should be changed at
4388 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004389 * (2) While it doesn't seem to cause problems, one
4390 * has to be very careful not to assume that in_hslen
4391 * is always <= in_msglen in a sensible communication.
4392 * Again, it's wrong for DTLS handshake fragmentation.
4393 * The following check is therefore mandatory, and
4394 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004395 * Additionally, ssl->in_hslen might be arbitrarily out of
4396 * bounds after handling a DTLS message with an unexpected
4397 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004398 */
4399 if( ssl->in_hslen < ssl->in_msglen )
4400 {
4401 ssl->in_msglen -= ssl->in_hslen;
4402 memmove( ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4403 ssl->in_msglen );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004404
Hanno Becker4a810fb2017-05-24 16:27:30 +01004405 MBEDTLS_SSL_DEBUG_BUF( 4, "remaining content in record",
4406 ssl->in_msg, ssl->in_msglen );
4407 }
4408 else
4409 {
4410 ssl->in_msglen = 0;
4411 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004412
Hanno Becker4a810fb2017-05-24 16:27:30 +01004413 ssl->in_hslen = 0;
4414 }
4415 /* Case (4): Application data */
4416 else if( ssl->in_offt != NULL )
4417 {
4418 return( 0 );
4419 }
4420 /* Everything else (CCS & Alerts) */
4421 else
4422 {
4423 ssl->in_msglen = 0;
4424 }
4425
Hanno Becker1097b342018-08-15 14:09:41 +01004426 return( 0 );
4427}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004428
Hanno Beckere74d5562018-08-15 14:26:08 +01004429static int ssl_record_is_in_progress( mbedtls_ssl_context *ssl )
4430{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004431 if( ssl->in_msglen > 0 )
Hanno Beckere74d5562018-08-15 14:26:08 +01004432 return( 1 );
4433
4434 return( 0 );
4435}
4436
Hanno Becker5f066e72018-08-16 14:56:31 +01004437#if defined(MBEDTLS_SSL_PROTO_DTLS)
4438
4439static void ssl_free_buffered_record( mbedtls_ssl_context *ssl )
4440{
4441 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4442 if( hs == NULL )
4443 return;
4444
Hanno Becker01315ea2018-08-21 17:22:17 +01004445 if( hs->buffering.future_record.data != NULL )
Hanno Becker4a810fb2017-05-24 16:27:30 +01004446 {
Hanno Becker01315ea2018-08-21 17:22:17 +01004447 hs->buffering.total_bytes_buffered -=
4448 hs->buffering.future_record.len;
4449
4450 mbedtls_free( hs->buffering.future_record.data );
4451 hs->buffering.future_record.data = NULL;
4452 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004453}
4454
4455static int ssl_load_buffered_record( mbedtls_ssl_context *ssl )
4456{
4457 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4458 unsigned char * rec;
4459 size_t rec_len;
4460 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004461#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4462 size_t in_buf_len = ssl->in_buf_len;
4463#else
4464 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4465#endif
Hanno Becker5f066e72018-08-16 14:56:31 +01004466 if( ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM )
4467 return( 0 );
4468
4469 if( hs == NULL )
4470 return( 0 );
4471
Hanno Becker5f066e72018-08-16 14:56:31 +01004472 rec = hs->buffering.future_record.data;
4473 rec_len = hs->buffering.future_record.len;
4474 rec_epoch = hs->buffering.future_record.epoch;
4475
4476 if( rec == NULL )
4477 return( 0 );
4478
Hanno Becker4cb782d2018-08-20 11:19:05 +01004479 /* Only consider loading future records if the
4480 * input buffer is empty. */
Hanno Beckeref7afdf2018-08-28 17:16:31 +01004481 if( ssl_next_record_is_in_datagram( ssl ) == 1 )
Hanno Becker4cb782d2018-08-20 11:19:05 +01004482 return( 0 );
4483
Hanno Becker5f066e72018-08-16 14:56:31 +01004484 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> ssl_load_buffered_record" ) );
4485
4486 if( rec_epoch != ssl->in_epoch )
4487 {
4488 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffered record not from current epoch." ) );
4489 goto exit;
4490 }
4491
4492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Found buffered record from current epoch - load" ) );
4493
4494 /* Double-check that the record is not too large */
Darryl Greenb33cc762019-11-28 14:29:44 +00004495 if( rec_len > in_buf_len - (size_t)( ssl->in_hdr - ssl->in_buf ) )
Hanno Becker5f066e72018-08-16 14:56:31 +01004496 {
4497 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
4498 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
4499 }
4500
4501 memcpy( ssl->in_hdr, rec, rec_len );
4502 ssl->in_left = rec_len;
4503 ssl->next_record_offset = 0;
4504
4505 ssl_free_buffered_record( ssl );
4506
4507exit:
4508 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= ssl_load_buffered_record" ) );
4509 return( 0 );
4510}
4511
Hanno Becker519f15d2019-07-11 12:43:20 +01004512static int ssl_buffer_future_record( mbedtls_ssl_context *ssl,
4513 mbedtls_record const *rec )
Hanno Becker5f066e72018-08-16 14:56:31 +01004514{
4515 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004516
4517 /* Don't buffer future records outside handshakes. */
4518 if( hs == NULL )
4519 return( 0 );
4520
4521 /* Only buffer handshake records (we are only interested
4522 * in Finished messages). */
Hanno Becker519f15d2019-07-11 12:43:20 +01004523 if( rec->type != MBEDTLS_SSL_MSG_HANDSHAKE )
Hanno Becker5f066e72018-08-16 14:56:31 +01004524 return( 0 );
4525
4526 /* Don't buffer more than one future epoch record. */
4527 if( hs->buffering.future_record.data != NULL )
4528 return( 0 );
4529
Hanno Becker01315ea2018-08-21 17:22:17 +01004530 /* Don't buffer record if there's not enough buffering space remaining. */
Hanno Becker519f15d2019-07-11 12:43:20 +01004531 if( rec->buf_len > ( MBEDTLS_SSL_DTLS_MAX_BUFFERING -
Hanno Becker01315ea2018-08-21 17:22:17 +01004532 hs->buffering.total_bytes_buffered ) )
4533 {
4534 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 +01004535 (unsigned) rec->buf_len, MBEDTLS_SSL_DTLS_MAX_BUFFERING,
Hanno Becker01315ea2018-08-21 17:22:17 +01004536 (unsigned) hs->buffering.total_bytes_buffered ) );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004537 return( 0 );
4538 }
4539
Hanno Becker5f066e72018-08-16 14:56:31 +01004540 /* Buffer record */
4541 MBEDTLS_SSL_DEBUG_MSG( 2, ( "Buffer record from epoch %u",
4542 ssl->in_epoch + 1 ) );
Hanno Becker519f15d2019-07-11 12:43:20 +01004543 MBEDTLS_SSL_DEBUG_BUF( 3, "Buffered record", rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004544
4545 /* ssl_parse_record_header() only considers records
4546 * of the next epoch as candidates for buffering. */
4547 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004548 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004549
4550 hs->buffering.future_record.data =
4551 mbedtls_calloc( 1, hs->buffering.future_record.len );
4552 if( hs->buffering.future_record.data == NULL )
4553 {
4554 /* If we run out of RAM trying to buffer a
4555 * record from the next epoch, just ignore. */
4556 return( 0 );
4557 }
4558
Hanno Becker519f15d2019-07-11 12:43:20 +01004559 memcpy( hs->buffering.future_record.data, rec->buf, rec->buf_len );
Hanno Becker5f066e72018-08-16 14:56:31 +01004560
Hanno Becker519f15d2019-07-11 12:43:20 +01004561 hs->buffering.total_bytes_buffered += rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004562 return( 0 );
4563}
4564
4565#endif /* MBEDTLS_SSL_PROTO_DTLS */
4566
Hanno Beckere74d5562018-08-15 14:26:08 +01004567static int ssl_get_next_record( mbedtls_ssl_context *ssl )
Hanno Becker1097b342018-08-15 14:09:41 +01004568{
Janos Follath865b3eb2019-12-16 11:46:15 +00004569 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004570 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004571
Hanno Becker5f066e72018-08-16 14:56:31 +01004572#if defined(MBEDTLS_SSL_PROTO_DTLS)
4573 /* We might have buffered a future record; if so,
4574 * and if the epoch matches now, load it.
4575 * On success, this call will set ssl->in_left to
4576 * the length of the buffered record, so that
4577 * the calls to ssl_fetch_input() below will
4578 * essentially be no-ops. */
4579 ret = ssl_load_buffered_record( ssl );
4580 if( ret != 0 )
4581 return( ret );
4582#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004583
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004584 /* Ensure that we have enough space available for the default form
4585 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4586 * with no space for CIDs counted in). */
4587 ret = mbedtls_ssl_fetch_input( ssl, mbedtls_ssl_in_hdr_len( ssl ) );
4588 if( ret != 0 )
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004590 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004591 return( ret );
4592 }
4593
Hanno Beckere5e7e782019-07-11 12:29:35 +01004594 ret = ssl_parse_record_header( ssl, ssl->in_hdr, ssl->in_left, &rec );
4595 if( ret != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004596 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004597#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2fddd372019-07-10 14:37:41 +01004598 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004599 {
Hanno Becker5f066e72018-08-16 14:56:31 +01004600 if( ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE )
4601 {
Hanno Becker519f15d2019-07-11 12:43:20 +01004602 ret = ssl_buffer_future_record( ssl, &rec );
Hanno Becker5f066e72018-08-16 14:56:31 +01004603 if( ret != 0 )
4604 return( ret );
4605
4606 /* Fall through to handling of unexpected records */
4607 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4608 }
4609
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004610 if( ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD )
4611 {
Hanno Becker2fddd372019-07-10 14:37:41 +01004612#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004613 /* Reset in pointers to default state for TLS/DTLS records,
4614 * assuming no CID and no offset between record content and
4615 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004616 mbedtls_ssl_update_in_pointers( ssl );
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004617
Hanno Becker7ae20e02019-07-12 08:33:49 +01004618 /* Setup internal message pointers from record structure. */
4619 ssl->in_msgtype = rec.type;
4620#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4621 ssl->in_len = ssl->in_cid + rec.cid_len;
4622#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4623 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4624 ssl->in_msglen = rec.data_len;
4625
Hanno Becker2fddd372019-07-10 14:37:41 +01004626 ret = ssl_check_client_reconnect( ssl );
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02004627 MBEDTLS_SSL_DEBUG_RET( 2, "ssl_check_client_reconnect", ret );
Hanno Becker2fddd372019-07-10 14:37:41 +01004628 if( ret != 0 )
4629 return( ret );
4630#endif
4631
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004632 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004633 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004634
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004635 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding unexpected record "
4636 "(header)" ) );
4637 }
4638 else
4639 {
4640 /* Skip invalid record and the rest of the datagram */
4641 ssl->next_record_offset = 0;
4642 ssl->in_left = 0;
4643
4644 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record "
4645 "(header)" ) );
4646 }
4647
4648 /* Get next record */
Hanno Becker90333da2017-10-10 11:27:13 +01004649 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004650 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004651 else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004652#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004653 {
4654 return( ret );
4655 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004656 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004658#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004659 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckere65ce782017-05-22 14:47:48 +01004660 {
Hanno Beckera8814792019-07-10 15:01:45 +01004661 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004662 ssl->next_record_offset = rec.buf_len;
Hanno Beckere65ce782017-05-22 14:47:48 +01004663 if( ssl->next_record_offset < ssl->in_left )
4664 {
4665 MBEDTLS_SSL_DEBUG_MSG( 3, ( "more than one record within datagram" ) );
4666 }
4667 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004668 else
4669#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004670 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004671 /*
4672 * Fetch record contents from underlying transport.
4673 */
Hanno Beckera3175662019-07-11 12:50:29 +01004674 ret = mbedtls_ssl_fetch_input( ssl, rec.buf_len );
Hanno Beckera8814792019-07-10 15:01:45 +01004675 if( ret != 0 )
4676 {
4677 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_fetch_input", ret );
4678 return( ret );
4679 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004680
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004681 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004682 }
4683
4684 /*
4685 * Decrypt record contents.
4686 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004687
Hanno Beckerfdf66042019-07-11 13:07:45 +01004688 if( ( ret = ssl_prepare_record_content( ssl, &rec ) ) != 0 )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004689 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004691 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004692 {
4693 /* Silently discard invalid records */
Hanno Becker82e2a392019-05-03 16:36:59 +01004694 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004695 {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004696 /* Except when waiting for Finished as a bad mac here
4697 * probably means something went wrong in the handshake
4698 * (eg wrong psk used, mitm downgrade attempt, etc.) */
4699 if( ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4700 ssl->state == MBEDTLS_SSL_SERVER_FINISHED )
4701 {
4702#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4703 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
4704 {
4705 mbedtls_ssl_send_alert_message( ssl,
4706 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4707 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
4708 }
4709#endif
4710 return( ret );
4711 }
4712
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004713#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02004714 if( ssl->conf->badmac_limit != 0 &&
4715 ++ssl->badmac_seen >= ssl->conf->badmac_limit )
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004716 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004717 MBEDTLS_SSL_DEBUG_MSG( 1, ( "too many records with bad MAC" ) );
4718 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004719 }
4720#endif
4721
Hanno Becker4a810fb2017-05-24 16:27:30 +01004722 /* As above, invalid records cause
4723 * dismissal of the whole datagram. */
4724
4725 ssl->next_record_offset = 0;
4726 ssl->in_left = 0;
4727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004728 MBEDTLS_SSL_DEBUG_MSG( 1, ( "discarding invalid record (mac)" ) );
Hanno Becker90333da2017-10-10 11:27:13 +01004729 return( MBEDTLS_ERR_SSL_CONTINUE_PROCESSING );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004730 }
4731
4732 return( ret );
4733 }
4734 else
4735#endif
4736 {
4737 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004738#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
4739 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004740 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741 mbedtls_ssl_send_alert_message( ssl,
4742 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4743 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC );
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004744 }
4745#endif
4746 return( ret );
4747 }
4748 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004749
Hanno Becker44d89b22019-07-12 09:40:44 +01004750
4751 /* Reset in pointers to default state for TLS/DTLS records,
4752 * assuming no CID and no offset between record content and
4753 * record plaintext. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00004754 mbedtls_ssl_update_in_pointers( ssl );
Hanno Becker44d89b22019-07-12 09:40:44 +01004755#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4756 ssl->in_len = ssl->in_cid + rec.cid_len;
4757#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004758 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004759
Hanno Becker8685c822019-07-12 09:37:30 +01004760 /* The record content type may change during decryption,
4761 * so re-read it. */
4762 ssl->in_msgtype = rec.type;
4763 /* Also update the input buffer, because unfortunately
4764 * the server-side ssl_parse_client_hello() reparses the
4765 * record header when receiving a ClientHello initiating
4766 * a renegotiation. */
4767 ssl->in_hdr[0] = rec.type;
4768 ssl->in_msg = rec.buf + rec.data_offset;
4769 ssl->in_msglen = rec.data_len;
4770 ssl->in_len[0] = (unsigned char)( rec.data_len >> 8 );
4771 ssl->in_len[1] = (unsigned char)( rec.data_len );
4772
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01004773#if defined(MBEDTLS_ZLIB_SUPPORT)
4774 if( ssl->transform_in != NULL &&
4775 ssl->session_in->compression == MBEDTLS_SSL_COMPRESS_DEFLATE )
4776 {
4777 if( ( ret = ssl_decompress_buf( ssl ) ) != 0 )
4778 {
4779 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_decompress_buf", ret );
4780 return( ret );
4781 }
4782
4783 /* Check actual (decompress) record content length against
4784 * configured maximum. */
4785 if( ssl->in_msglen > MBEDTLS_SSL_IN_CONTENT_LEN )
4786 {
4787 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad message length" ) );
4788 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4789 }
4790 }
4791#endif /* MBEDTLS_ZLIB_SUPPORT */
4792
Simon Butcher99000142016-10-13 17:21:01 +01004793 return( 0 );
4794}
4795
4796int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl )
4797{
Janos Follath865b3eb2019-12-16 11:46:15 +00004798 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004799
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004800 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004801 * Handle particular types of records
4802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker5121ce52009-01-03 21:22:43 +00004804 {
Simon Butcher99000142016-10-13 17:21:01 +01004805 if( ( ret = mbedtls_ssl_prepare_handshake_record( ssl ) ) != 0 )
4806 {
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01004807 return( ret );
Simon Butcher99000142016-10-13 17:21:01 +01004808 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004809 }
4810
Hanno Beckere678eaa2018-08-21 14:57:46 +01004811 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004812 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004813 if( ssl->in_msglen != 1 )
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004814 {
Hanno Beckere678eaa2018-08-21 14:57:46 +01004815 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, len: %d",
4816 ssl->in_msglen ) );
4817 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004818 }
4819
Hanno Beckere678eaa2018-08-21 14:57:46 +01004820 if( ssl->in_msg[0] != 1 )
4821 {
4822 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid CCS message, content: %02x",
4823 ssl->in_msg[0] ) );
4824 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4825 }
4826
4827#if defined(MBEDTLS_SSL_PROTO_DTLS)
4828 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4829 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
4830 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC )
4831 {
4832 if( ssl->handshake == NULL )
4833 {
4834 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping ChangeCipherSpec outside handshake" ) );
4835 return( MBEDTLS_ERR_SSL_UNEXPECTED_RECORD );
4836 }
4837
4838 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received out-of-order ChangeCipherSpec - remember" ) );
4839 return( MBEDTLS_ERR_SSL_EARLY_MESSAGE );
4840 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004841#endif
Hanno Beckere678eaa2018-08-21 14:57:46 +01004842 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Paul Bakker5121ce52009-01-03 21:22:43 +00004845 {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004846 if( ssl->in_msglen != 2 )
4847 {
4848 /* Note: Standard allows for more than one 2 byte alert
4849 to be packed in a single message, but Mbed TLS doesn't
4850 currently support this. */
4851 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid alert message, len: %d",
4852 ssl->in_msglen ) );
4853 return( MBEDTLS_ERR_SSL_INVALID_RECORD );
4854 }
4855
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004856 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got an alert message, type: [%d:%d]",
Paul Bakker5121ce52009-01-03 21:22:43 +00004857 ssl->in_msg[0], ssl->in_msg[1] ) );
4858
4859 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004860 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL )
Paul Bakker5121ce52009-01-03 21:22:43 +00004863 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004864 MBEDTLS_SSL_DEBUG_MSG( 1, ( "is a fatal alert message (msg %d)",
Paul Bakker2770fbd2012-07-03 13:30:23 +00004865 ssl->in_msg[1] ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004866 return( MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00004867 }
4868
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004869 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4870 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY )
Paul Bakker5121ce52009-01-03 21:22:43 +00004871 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004872 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a close notify message" ) );
4873 return( MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY );
Paul Bakker5121ce52009-01-03 21:22:43 +00004874 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004875
4876#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
4877 if( ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4878 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION )
4879 {
Hanno Becker90333da2017-10-10 11:27:13 +01004880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no renegotiation alert" ) );
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004881 /* Will be handled when trying to parse ServerHello */
4882 return( 0 );
4883 }
4884#endif
4885
4886#if defined(MBEDTLS_SSL_PROTO_SSL3) && defined(MBEDTLS_SSL_SRV_C)
4887 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 &&
4888 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
4889 ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4890 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_CERT )
4891 {
4892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "is a SSLv3 no_cert" ) );
4893 /* Will be handled in mbedtls_ssl_parse_certificate() */
4894 return( 0 );
4895 }
4896#endif /* MBEDTLS_SSL_PROTO_SSL3 && MBEDTLS_SSL_SRV_C */
4897
4898 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004899 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004900 }
4901
Hanno Beckerc76c6192017-06-06 10:03:17 +01004902#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker37ae9522019-05-03 16:54:26 +01004903 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004904 {
Hanno Becker37ae9522019-05-03 16:54:26 +01004905 /* Drop unexpected ApplicationData records,
4906 * except at the beginning of renegotiations */
4907 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4908 ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER
4909#if defined(MBEDTLS_SSL_RENEGOTIATION)
4910 && ! ( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4911 ssl->state == MBEDTLS_SSL_SERVER_HELLO )
Hanno Beckerc76c6192017-06-06 10:03:17 +01004912#endif
Hanno Becker37ae9522019-05-03 16:54:26 +01004913 )
4914 {
4915 MBEDTLS_SSL_DEBUG_MSG( 1, ( "dropping unexpected ApplicationData" ) );
4916 return( MBEDTLS_ERR_SSL_NON_FATAL );
4917 }
4918
4919 if( ssl->handshake != NULL &&
4920 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
4921 {
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00004922 mbedtls_ssl_handshake_wrapup_free_hs_transform( ssl );
Hanno Becker37ae9522019-05-03 16:54:26 +01004923 }
4924 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004925#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004926
Paul Bakker5121ce52009-01-03 21:22:43 +00004927 return( 0 );
4928}
4929
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004931{
irwir6c0da642019-09-26 21:07:41 +03004932 return( mbedtls_ssl_send_alert_message( ssl,
4933 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4934 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE ) );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004935}
4936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004938 unsigned char level,
4939 unsigned char message )
4940{
Janos Follath865b3eb2019-12-16 11:46:15 +00004941 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004942
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004943 if( ssl == NULL || ssl->conf == NULL )
4944 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
4945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004946 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> send alert message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004947 MBEDTLS_SSL_DEBUG_MSG( 3, ( "send alert level=%u message=%u", level, message ));
Paul Bakker0a925182012-04-16 06:46:41 +00004948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004949 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004950 ssl->out_msglen = 2;
4951 ssl->out_msg[0] = level;
4952 ssl->out_msg[1] = message;
4953
Hanno Becker67bc7c32018-08-06 11:33:50 +01004954 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker0a925182012-04-16 06:46:41 +00004955 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004956 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker0a925182012-04-16 06:46:41 +00004957 return( ret );
4958 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004959 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= send alert message" ) );
Paul Bakker0a925182012-04-16 06:46:41 +00004960
4961 return( 0 );
4962}
4963
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004964int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004965{
Janos Follath865b3eb2019-12-16 11:46:15 +00004966 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004968 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004970 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004971 ssl->out_msglen = 1;
4972 ssl->out_msg[0] = 1;
4973
Paul Bakker5121ce52009-01-03 21:22:43 +00004974 ssl->state++;
4975
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004976 if( ( ret = mbedtls_ssl_write_handshake_msg( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004977 {
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02004978 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_handshake_msg", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004979 return( ret );
4980 }
4981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004982 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004983
4984 return( 0 );
4985}
4986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004987int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00004988{
Janos Follath865b3eb2019-12-16 11:46:15 +00004989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004991 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00004992
Hanno Becker327c93b2018-08-15 13:56:18 +01004993 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00004994 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004995 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00004996 return( ret );
4997 }
4998
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004999 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC )
Paul Bakker5121ce52009-01-03 21:22:43 +00005000 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005001 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad change cipher spec message" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005002 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5003 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005004 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005005 }
5006
Hanno Beckere678eaa2018-08-21 14:57:46 +01005007 /* CCS records are only accepted if they have length 1 and content '1',
5008 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005009
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005010 /*
5011 * Switch to our negotiated transform and session parameters for inbound
5012 * data.
5013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005014 MBEDTLS_SSL_DEBUG_MSG( 3, ( "switching to new transform spec for inbound data" ) );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005015 ssl->transform_in = ssl->transform_negotiate;
5016 ssl->session_in = ssl->session_negotiate;
5017
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005018#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005019 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005020 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005021#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7e8e6a62020-02-05 10:45:48 +00005022 mbedtls_ssl_dtls_replay_reset( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005023#endif
5024
5025 /* Increment epoch */
5026 if( ++ssl->in_epoch == 0 )
5027 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005028 MBEDTLS_SSL_DEBUG_MSG( 1, ( "DTLS epoch would wrap" ) );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005029 /* This is highly unlikely to happen for legitimate reasons, so
5030 treat it as an attack and don't send an alert. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005031 return( MBEDTLS_ERR_SSL_COUNTER_WRAPPING );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005032 }
5033 }
5034 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005035#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005036 memset( ssl->in_ctr, 0, 8 );
5037
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005038 mbedtls_ssl_update_in_pointers( ssl );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
5041 if( mbedtls_ssl_hw_record_activate != NULL )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005042 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005043 if( ( ret = mbedtls_ssl_hw_record_activate( ssl, MBEDTLS_SSL_CHANNEL_INBOUND ) ) != 0 )
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005044 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005045 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_hw_record_activate", ret );
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005046 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5047 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005048 return( MBEDTLS_ERR_SSL_HW_ACCEL_FAILED );
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005049 }
5050 }
5051#endif
5052
Paul Bakker5121ce52009-01-03 21:22:43 +00005053 ssl->state++;
5054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse change cipher spec" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005056
5057 return( 0 );
5058}
5059
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005060/* Once ssl->out_hdr as the address of the beginning of the
5061 * next outgoing record is set, deduce the other pointers.
5062 *
5063 * Note: For TLS, we save the implicit record sequence number
5064 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5065 * and the caller has to make sure there's space for this.
5066 */
5067
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005068static size_t ssl_transform_get_explicit_iv_len(
5069 mbedtls_ssl_transform const *transform )
5070{
5071 if( transform->minor_ver < MBEDTLS_SSL_MINOR_VERSION_2 )
5072 return( 0 );
5073
5074 return( transform->ivlen - transform->fixed_ivlen );
5075}
5076
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005077void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
5078 mbedtls_ssl_transform *transform )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005079{
5080#if defined(MBEDTLS_SSL_PROTO_DTLS)
5081 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5082 {
5083 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005084#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005085 ssl->out_cid = ssl->out_ctr + 8;
5086 ssl->out_len = ssl->out_cid;
5087 if( transform != NULL )
5088 ssl->out_len += transform->out_cid_len;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005089#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005090 ssl->out_len = ssl->out_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005091#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005092 ssl->out_iv = ssl->out_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005093 }
5094 else
5095#endif
5096 {
5097 ssl->out_ctr = ssl->out_hdr - 8;
5098 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005099#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005100 ssl->out_cid = ssl->out_len;
5101#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005102 ssl->out_iv = ssl->out_hdr + 5;
5103 }
5104
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005105 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005106 /* Adjust out_msg to make space for explicit IV, if used. */
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005107 if( transform != NULL )
5108 ssl->out_msg += ssl_transform_get_explicit_iv_len( transform );
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005109}
5110
5111/* Once ssl->in_hdr as the address of the beginning of the
5112 * next incoming record is set, deduce the other pointers.
5113 *
5114 * Note: For TLS, we save the implicit record sequence number
5115 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5116 * and the caller has to make sure there's space for this.
5117 */
5118
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005119void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl )
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005120{
Hanno Becker79594fd2019-05-08 09:38:41 +01005121 /* This function sets the pointers to match the case
5122 * of unprotected TLS/DTLS records, with both ssl->in_iv
5123 * and ssl->in_msg pointing to the beginning of the record
5124 * content.
5125 *
5126 * When decrypting a protected record, ssl->in_msg
5127 * will be shifted to point to the beginning of the
5128 * record plaintext.
5129 */
5130
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005131#if defined(MBEDTLS_SSL_PROTO_DTLS)
5132 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5133 {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005134 /* This sets the header pointers to match records
5135 * without CID. When we receive a record containing
5136 * a CID, the fields are shifted accordingly in
5137 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005138 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005139#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005140 ssl->in_cid = ssl->in_ctr + 8;
5141 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005142#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005143 ssl->in_len = ssl->in_ctr + 8;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005144#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005145 ssl->in_iv = ssl->in_len + 2;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005146 }
5147 else
5148#endif
5149 {
5150 ssl->in_ctr = ssl->in_hdr - 8;
5151 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005152#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005153 ssl->in_cid = ssl->in_len;
5154#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005155 ssl->in_iv = ssl->in_hdr + 5;
5156 }
5157
Hanno Becker79594fd2019-05-08 09:38:41 +01005158 /* This will be adjusted at record decryption time. */
5159 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005160}
5161
Paul Bakker5121ce52009-01-03 21:22:43 +00005162/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005163 * Setup an SSL context
5164 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005165
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005166void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl )
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005167{
5168 /* Set the incoming and outgoing record pointers. */
5169#if defined(MBEDTLS_SSL_PROTO_DTLS)
5170 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
5171 {
5172 ssl->out_hdr = ssl->out_buf;
5173 ssl->in_hdr = ssl->in_buf;
5174 }
5175 else
5176#endif /* MBEDTLS_SSL_PROTO_DTLS */
5177 {
5178 ssl->out_hdr = ssl->out_buf + 8;
5179 ssl->in_hdr = ssl->in_buf + 8;
5180 }
5181
5182 /* Derive other internal pointers. */
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00005183 mbedtls_ssl_update_out_pointers( ssl, NULL /* no transform enabled */ );
5184 mbedtls_ssl_update_in_pointers ( ssl );
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005185}
5186
Paul Bakker5121ce52009-01-03 21:22:43 +00005187/*
5188 * SSL get accessors
5189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005190size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005191{
5192 return( ssl->in_offt == NULL ? 0 : ssl->in_msglen );
5193}
5194
Hanno Becker8b170a02017-10-10 11:51:19 +01005195int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl )
5196{
5197 /*
5198 * Case A: We're currently holding back
5199 * a message for further processing.
5200 */
5201
5202 if( ssl->keep_current_message == 1 )
5203 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005204 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: record held back for processing" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005205 return( 1 );
5206 }
5207
5208 /*
5209 * Case B: Further records are pending in the current datagram.
5210 */
5211
5212#if defined(MBEDTLS_SSL_PROTO_DTLS)
5213 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5214 ssl->in_left > ssl->next_record_offset )
5215 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005216 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more records within current datagram" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005217 return( 1 );
5218 }
5219#endif /* MBEDTLS_SSL_PROTO_DTLS */
5220
5221 /*
5222 * Case C: A handshake message is being processed.
5223 */
5224
Hanno Becker8b170a02017-10-10 11:51:19 +01005225 if( ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen )
5226 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005227 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: more handshake messages within current record" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005228 return( 1 );
5229 }
5230
5231 /*
5232 * Case D: An application data message is being processed
5233 */
5234 if( ssl->in_offt != NULL )
5235 {
Hanno Beckera6fb0892017-10-23 13:17:48 +01005236 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: application data record is being processed" ) );
Hanno Becker8b170a02017-10-10 11:51:19 +01005237 return( 1 );
5238 }
5239
5240 /*
5241 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005242 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005243 * we implement support for multiple alerts in single records.
5244 */
5245
5246 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ssl_check_pending: nothing pending" ) );
5247 return( 0 );
5248}
5249
Paul Bakker43ca69c2011-01-15 17:35:19 +00005250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005251int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005252{
Hanno Becker3136ede2018-08-17 15:28:19 +01005253 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005254 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005255 unsigned block_size;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005256
Hanno Becker5903de42019-05-03 14:46:38 +01005257 size_t out_hdr_len = mbedtls_ssl_out_hdr_len( ssl );
5258
Hanno Becker78640902018-08-13 16:35:15 +01005259 if( transform == NULL )
Hanno Becker5903de42019-05-03 14:46:38 +01005260 return( (int) out_hdr_len );
Hanno Becker78640902018-08-13 16:35:15 +01005261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005262#if defined(MBEDTLS_ZLIB_SUPPORT)
5263 if( ssl->session_out->compression != MBEDTLS_SSL_COMPRESS_NULL )
5264 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005265#endif
5266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005267 switch( mbedtls_cipher_get_cipher_mode( &transform->cipher_ctx_enc ) )
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005268 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005269 case MBEDTLS_MODE_GCM:
5270 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005271 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005272 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005273 transform_expansion = transform->minlen;
5274 break;
5275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005276 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005277
5278 block_size = mbedtls_cipher_get_block_size(
5279 &transform->cipher_ctx_enc );
5280
Hanno Becker3136ede2018-08-17 15:28:19 +01005281 /* Expansion due to the addition of the MAC. */
5282 transform_expansion += transform->maclen;
5283
5284 /* Expansion due to the addition of CBC padding;
5285 * Theoretically up to 256 bytes, but we never use
5286 * more than the block size of the underlying cipher. */
5287 transform_expansion += block_size;
5288
5289 /* For TLS 1.1 or higher, an explicit IV is added
5290 * after the record header. */
Hanno Becker5b559ac2018-08-03 09:40:07 +01005291#if defined(MBEDTLS_SSL_PROTO_TLS1_1) || defined(MBEDTLS_SSL_PROTO_TLS1_2)
5292 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_2 )
Hanno Becker3136ede2018-08-17 15:28:19 +01005293 transform_expansion += block_size;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005294#endif /* MBEDTLS_SSL_PROTO_TLS1_1 || MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005295
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005296 break;
5297
5298 default:
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005299 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005300 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005301 }
5302
Hanno Beckera0e20d02019-05-15 14:03:01 +01005303#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6cbad552019-05-08 15:40:11 +01005304 if( transform->out_cid_len != 0 )
5305 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005306#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005307
Hanno Becker5903de42019-05-03 14:46:38 +01005308 return( (int)( out_hdr_len + transform_expansion ) );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005309}
5310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005311#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005312/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005313 * Check record counters and renegotiate if they're above the limit.
5314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005315static int ssl_check_ctr_renegotiate( mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005316{
Hanno Beckerdd772292020-02-05 10:38:31 +00005317 size_t ep_len = mbedtls_ssl_ep_len( ssl );
Andres AG2196c7f2016-12-15 17:01:16 +00005318 int in_ctr_cmp;
5319 int out_ctr_cmp;
5320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005321 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER ||
5322 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005323 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005324 {
5325 return( 0 );
5326 }
5327
Andres AG2196c7f2016-12-15 17:01:16 +00005328 in_ctr_cmp = memcmp( ssl->in_ctr + ep_len,
5329 ssl->conf->renego_period + ep_len, 8 - ep_len );
Hanno Becker19859472018-08-06 09:40:20 +01005330 out_ctr_cmp = memcmp( ssl->cur_out_ctr + ep_len,
Andres AG2196c7f2016-12-15 17:01:16 +00005331 ssl->conf->renego_period + ep_len, 8 - ep_len );
5332
5333 if( in_ctr_cmp <= 0 && out_ctr_cmp <= 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005334 {
5335 return( 0 );
5336 }
5337
Manuel Pégourié-Gonnardcb0d2122015-07-22 11:52:11 +02005338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "record counter limit reached: renegotiate" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005339 return( mbedtls_ssl_renegotiate( ssl ) );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005340}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005341#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005342
5343/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005344 * Receive application data decrypted from the SSL layer
5345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005346int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005347{
Janos Follath865b3eb2019-12-16 11:46:15 +00005348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005349 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005350
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005351 if( ssl == NULL || ssl->conf == NULL )
5352 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005356#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005357 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005358 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005359 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005360 return( ret );
5361
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005362 if( ssl->handshake != NULL &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005363 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005364 {
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02005365 if( ( ret = mbedtls_ssl_flight_transmit( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005366 return( ret );
5367 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005368 }
5369#endif
5370
Hanno Becker4a810fb2017-05-24 16:27:30 +01005371 /*
5372 * Check if renegotiation is necessary and/or handshake is
5373 * in process. If yes, perform/continue, and fall through
5374 * if an unexpected packet is received while the client
5375 * is waiting for the ServerHello.
5376 *
5377 * (There is no equivalent to the last condition on
5378 * the server-side as it is not treated as within
5379 * a handshake while waiting for the ClientHello
5380 * after a renegotiation request.)
5381 */
5382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005383#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005384 ret = ssl_check_ctr_renegotiate( ssl );
5385 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5386 ret != 0 )
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005387 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005388 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005389 return( ret );
5390 }
5391#endif
5392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005393 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005394 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395 ret = mbedtls_ssl_handshake( ssl );
Hanno Becker4a810fb2017-05-24 16:27:30 +01005396 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5397 ret != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005398 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005399 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005400 return( ret );
5401 }
5402 }
5403
Hanno Beckere41158b2017-10-23 13:30:32 +01005404 /* Loop as long as no application data record is available */
Hanno Becker90333da2017-10-10 11:27:13 +01005405 while( ssl->in_offt == NULL )
Paul Bakker5121ce52009-01-03 21:22:43 +00005406 {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005407 /* Start timer if not already running */
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005408 if( ssl->f_get_timer != NULL &&
5409 ssl->f_get_timer( ssl->p_timer ) == -1 )
5410 {
Hanno Becker0f57a652020-02-05 10:37:26 +00005411 mbedtls_ssl_set_timer( ssl, ssl->conf->read_timeout );
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005412 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005413
Hanno Becker327c93b2018-08-15 13:56:18 +01005414 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005415 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005416 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
5417 return( 0 );
Paul Bakker831a7552011-05-18 13:32:51 +00005418
Hanno Becker4a810fb2017-05-24 16:27:30 +01005419 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
5420 return( ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005421 }
5422
5423 if( ssl->in_msglen == 0 &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005424 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005425 {
5426 /*
5427 * OpenSSL sends empty messages to randomize the IV
5428 */
Hanno Becker327c93b2018-08-15 13:56:18 +01005429 if( ( ret = mbedtls_ssl_read_record( ssl, 1 ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005430 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 if( ret == MBEDTLS_ERR_SSL_CONN_EOF )
Paul Bakker831a7552011-05-18 13:32:51 +00005432 return( 0 );
5433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005435 return( ret );
5436 }
5437 }
5438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005439 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE )
Paul Bakker48916f92012-09-16 19:57:18 +00005440 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005441 MBEDTLS_SSL_DEBUG_MSG( 1, ( "received handshake message" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005442
Hanno Becker4a810fb2017-05-24 16:27:30 +01005443 /*
5444 * - For client-side, expect SERVER_HELLO_REQUEST.
5445 * - For server-side, expect CLIENT_HELLO.
5446 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5447 */
5448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005449#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005450 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005451 ( ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
Hanno Becker4a810fb2017-05-24 16:27:30 +01005452 ssl->in_hslen != mbedtls_ssl_hs_hdr_len( ssl ) ) )
Paul Bakker48916f92012-09-16 19:57:18 +00005453 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not HelloRequest)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005455
5456 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005457#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005458 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005459 {
5460 continue;
5461 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005462#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005463 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005464 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005465#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005466
Hanno Becker4a810fb2017-05-24 16:27:30 +01005467#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005468 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005469 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO )
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005470 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005471 MBEDTLS_SSL_DEBUG_MSG( 1, ( "handshake received (not ClientHello)" ) );
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005472
5473 /* With DTLS, drop the packet (probably from last handshake) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005475 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Hanno Becker90333da2017-10-10 11:27:13 +01005476 {
5477 continue;
5478 }
Manuel Pégourié-Gonnard990f9e42014-09-06 12:27:02 +02005479#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005480 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker48916f92012-09-16 19:57:18 +00005481 }
Hanno Becker4a810fb2017-05-24 16:27:30 +01005482#endif /* MBEDTLS_SSL_SRV_C */
5483
Hanno Becker21df7f92017-10-17 11:03:26 +01005484#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker4a810fb2017-05-24 16:27:30 +01005485 /* Determine whether renegotiation attempt should be accepted */
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005486 if( ! ( ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5487 ( ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5488 ssl->conf->allow_legacy_renegotiation ==
5489 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION ) ) )
5490 {
5491 /*
5492 * Accept renegotiation request
5493 */
Paul Bakker48916f92012-09-16 19:57:18 +00005494
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005495 /* DTLS clients need to know renego is server-initiated */
5496#if defined(MBEDTLS_SSL_PROTO_DTLS)
5497 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5498 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT )
5499 {
5500 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5501 }
5502#endif
Hanno Becker40cdaa12020-02-05 10:48:27 +00005503 ret = mbedtls_ssl_start_renegotiation( ssl );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005504 if( ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5505 ret != 0 )
5506 {
Hanno Becker40cdaa12020-02-05 10:48:27 +00005507 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_start_renegotiation",
5508 ret );
Hanno Beckerb4ff0aa2017-10-17 11:03:04 +01005509 return( ret );
5510 }
5511 }
5512 else
Hanno Becker21df7f92017-10-17 11:03:26 +01005513#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005514 {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005515 /*
5516 * Refuse renegotiation
5517 */
5518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005519 MBEDTLS_SSL_DEBUG_MSG( 3, ( "refusing renegotiation, sending alert" ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005521#if defined(MBEDTLS_SSL_PROTO_SSL3)
5522 if( ssl->minor_ver == MBEDTLS_SSL_MINOR_VERSION_0 )
Paul Bakker48916f92012-09-16 19:57:18 +00005523 {
Gilles Peskine92e44262017-05-10 17:27:49 +02005524 /* SSLv3 does not have a "no_renegotiation" warning, so
5525 we send a fatal alert and abort the connection. */
5526 mbedtls_ssl_send_alert_message( ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5527 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE );
5528 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005529 }
5530 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005531#endif /* MBEDTLS_SSL_PROTO_SSL3 */
5532#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
5533 defined(MBEDTLS_SSL_PROTO_TLS1_2)
5534 if( ssl->minor_ver >= MBEDTLS_SSL_MINOR_VERSION_1 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005535 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005536 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5537 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5538 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION ) ) != 0 )
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005539 {
5540 return( ret );
5541 }
Paul Bakker48916f92012-09-16 19:57:18 +00005542 }
Paul Bakkerd2f068e2013-08-27 21:19:20 +02005543 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005544#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 ||
5545 MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker577e0062013-08-28 11:57:20 +02005546 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005547 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
5548 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Paul Bakker577e0062013-08-28 11:57:20 +02005549 }
Paul Bakker48916f92012-09-16 19:57:18 +00005550 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005551
Hanno Becker90333da2017-10-10 11:27:13 +01005552 /* At this point, we don't know whether the renegotiation has been
5553 * completed or not. The cases to consider are the following:
5554 * 1) The renegotiation is complete. In this case, no new record
5555 * has been read yet.
5556 * 2) The renegotiation is incomplete because the client received
5557 * an application data record while awaiting the ServerHello.
5558 * 3) The renegotiation is incomplete because the client received
5559 * a non-handshake, non-application data message while awaiting
5560 * the ServerHello.
5561 * In each of these case, looping will be the proper action:
5562 * - For 1), the next iteration will read a new record and check
5563 * if it's application data.
5564 * - For 2), the loop condition isn't satisfied as application data
5565 * is present, hence continue is the same as break
5566 * - For 3), the loop condition is satisfied and read_record
5567 * will re-deliver the message that was held back by the client
5568 * when expecting the ServerHello.
5569 */
5570 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005571 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005572#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005573 else if( ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005574 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005575 if( ssl->conf->renego_max_records >= 0 )
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005576 {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005577 if( ++ssl->renego_records_seen > ssl->conf->renego_max_records )
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005578 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "renegotiation requested, "
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005580 "but not honored by client" ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005581 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005582 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005583 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005584 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005585#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005587 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
5588 if( ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT )
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005589 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005590 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ignoring non-fatal non-closure alert" ) );
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01005591 return( MBEDTLS_ERR_SSL_WANT_READ );
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005592 }
5593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594 if( ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA )
Paul Bakker5121ce52009-01-03 21:22:43 +00005595 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005596 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad application data message" ) );
5597 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
Paul Bakker5121ce52009-01-03 21:22:43 +00005598 }
5599
5600 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005601
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005602 /* We're going to return something now, cancel timer,
5603 * except if handshake (renegotiation) is in progress */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005604 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Hanno Becker0f57a652020-02-05 10:37:26 +00005605 mbedtls_ssl_set_timer( ssl, 0 );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005606
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005607#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005608 /* If we requested renego but received AppData, resend HelloRequest.
5609 * Do it now, after setting in_offt, to avoid taking this branch
5610 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005611#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005612 if( ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005614 {
Hanno Becker786300f2020-02-05 10:46:40 +00005615 if( ( ret = mbedtls_ssl_resend_hello_request( ssl ) ) != 0 )
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005616 {
Hanno Becker786300f2020-02-05 10:46:40 +00005617 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_resend_hello_request",
5618 ret );
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005619 return( ret );
5620 }
5621 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005622#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005623#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005624 }
5625
5626 n = ( len < ssl->in_msglen )
5627 ? len : ssl->in_msglen;
5628
5629 memcpy( buf, ssl->in_offt, n );
5630 ssl->in_msglen -= n;
5631
gabor-mezei-arma3214132020-07-15 10:55:00 +02005632 /* Zeroising the plaintext buffer to erase unused application data
5633 from the memory. */
5634 mbedtls_platform_zeroize( ssl->in_offt, n );
5635
Paul Bakker5121ce52009-01-03 21:22:43 +00005636 if( ssl->in_msglen == 0 )
Hanno Becker4a810fb2017-05-24 16:27:30 +01005637 {
5638 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005639 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005640 ssl->keep_current_message = 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005641 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005642 else
Hanno Becker4a810fb2017-05-24 16:27:30 +01005643 {
Paul Bakker5121ce52009-01-03 21:22:43 +00005644 /* more data available */
5645 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005646 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= read" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005649
Paul Bakker23986e52011-04-24 08:57:21 +00005650 return( (int) n );
Paul Bakker5121ce52009-01-03 21:22:43 +00005651}
5652
5653/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005654 * Send application data to be encrypted by the SSL layer, taking care of max
5655 * fragment length and buffer size.
5656 *
5657 * According to RFC 5246 Section 6.2.1:
5658 *
5659 * Zero-length fragments of Application data MAY be sent as they are
5660 * potentially useful as a traffic analysis countermeasure.
5661 *
5662 * Therefore, it is possible that the input message length is 0 and the
5663 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005664 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005665static int ssl_write_real( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005666 const unsigned char *buf, size_t len )
Paul Bakker5121ce52009-01-03 21:22:43 +00005667{
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005668 int ret = mbedtls_ssl_get_max_out_record_payload( ssl );
5669 const size_t max_len = (size_t) ret;
5670
5671 if( ret < 0 )
5672 {
5673 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_get_max_out_record_payload", ret );
5674 return( ret );
5675 }
5676
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005677 if( len > max_len )
5678 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02005680 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682 MBEDTLS_SSL_DEBUG_MSG( 1, ( "fragment larger than the (negotiated) "
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005683 "maximum fragment length: %d > %d",
5684 len, max_len ) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005685 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005686 }
5687 else
5688#endif
5689 len = max_len;
5690 }
Paul Bakker887bd502011-06-08 13:10:54 +00005691
Paul Bakker5121ce52009-01-03 21:22:43 +00005692 if( ssl->out_left != 0 )
5693 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005694 /*
5695 * The user has previously tried to send the data and
5696 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5697 * written. In this case, we expect the high-level write function
5698 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005700 if( ( ret = mbedtls_ssl_flush_output( ssl ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005701 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_flush_output", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005703 return( ret );
5704 }
5705 }
Paul Bakker887bd502011-06-08 13:10:54 +00005706 else
Paul Bakker1fd00bf2011-03-14 20:50:15 +00005707 {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005708 /*
5709 * The user is trying to send a message the first time, so we need to
5710 * copy the data into the internal buffers and setup the data structure
5711 * to keep track of partial writes
5712 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005713 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005715 memcpy( ssl->out_msg, buf, len );
Paul Bakker887bd502011-06-08 13:10:54 +00005716
Hanno Becker67bc7c32018-08-06 11:33:50 +01005717 if( ( ret = mbedtls_ssl_write_record( ssl, SSL_FORCE_FLUSH ) ) != 0 )
Paul Bakker887bd502011-06-08 13:10:54 +00005718 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005719 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_write_record", ret );
Paul Bakker887bd502011-06-08 13:10:54 +00005720 return( ret );
5721 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005722 }
5723
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005724 return( (int) len );
Paul Bakker5121ce52009-01-03 21:22:43 +00005725}
5726
5727/*
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005728 * Write application data, doing 1/n-1 splitting if necessary.
5729 *
5730 * With non-blocking I/O, ssl_write_real() may return WANT_WRITE,
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005731 * then the caller will call us again with the same arguments, so
Hanno Becker2b187c42017-09-18 14:58:11 +01005732 * remember whether we already did the split or not.
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005735static int ssl_write_split( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005736 const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005737{
Janos Follath865b3eb2019-12-16 11:46:15 +00005738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005739
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01005740 if( ssl->conf->cbc_record_splitting ==
5741 MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED ||
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01005742 len <= 1 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005743 ssl->minor_ver > MBEDTLS_SSL_MINOR_VERSION_1 ||
5744 mbedtls_cipher_get_cipher_mode( &ssl->transform_out->cipher_ctx_enc )
5745 != MBEDTLS_MODE_CBC )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005746 {
5747 return( ssl_write_real( ssl, buf, len ) );
5748 }
5749
5750 if( ssl->split_done == 0 )
5751 {
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005752 if( ( ret = ssl_write_real( ssl, buf, 1 ) ) <= 0 )
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005753 return( ret );
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005754 ssl->split_done = 1;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005755 }
5756
Manuel Pégourié-Gonnarda852cf42015-01-13 20:56:15 +01005757 if( ( ret = ssl_write_real( ssl, buf + 1, len - 1 ) ) <= 0 )
5758 return( ret );
5759 ssl->split_done = 0;
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005760
5761 return( ret + 1 );
5762}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005763#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01005764
5765/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005766 * Write application data (public-facing wrapper)
5767 */
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005768int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005769{
Janos Follath865b3eb2019-12-16 11:46:15 +00005770 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005771
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005772 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005773
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005774 if( ssl == NULL || ssl->conf == NULL )
5775 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5776
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005777#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005778 if( ( ret = ssl_check_ctr_renegotiate( ssl ) ) != 0 )
5779 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005780 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_check_ctr_renegotiate", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005781 return( ret );
5782 }
5783#endif
5784
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005785 if( ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005786 {
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005787 if( ( ret = mbedtls_ssl_handshake( ssl ) ) != 0 )
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005788 {
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02005789 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_handshake", ret );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005790 return( ret );
5791 }
5792 }
5793
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005794#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005795 ret = ssl_write_split( ssl, buf, len );
5796#else
5797 ret = ssl_write_real( ssl, buf, len );
5798#endif
5799
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005800 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write" ) );
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005801
5802 return( ret );
5803}
5804
5805/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005806 * Notify the peer that the connection is being closed
5807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005808int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl )
Paul Bakker5121ce52009-01-03 21:22:43 +00005809{
Janos Follath865b3eb2019-12-16 11:46:15 +00005810 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005811
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005812 if( ssl == NULL || ssl->conf == NULL )
5813 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
5814
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005815 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005816
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005817 if( ssl->out_left != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818 return( mbedtls_ssl_flush_output( ssl ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005819
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005820 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER )
Paul Bakker5121ce52009-01-03 21:22:43 +00005821 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005822 if( ( ret = mbedtls_ssl_send_alert_message( ssl,
5823 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5824 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY ) ) != 0 )
Paul Bakker5121ce52009-01-03 21:22:43 +00005825 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005826 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_send_alert_message", ret );
Paul Bakker5121ce52009-01-03 21:22:43 +00005827 return( ret );
5828 }
5829 }
5830
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005831 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write close notify" ) );
Paul Bakker5121ce52009-01-03 21:22:43 +00005832
Manuel Pégourié-Gonnarda13500f2014-08-19 16:14:04 +02005833 return( 0 );
Paul Bakker5121ce52009-01-03 21:22:43 +00005834}
5835
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005836void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform )
Paul Bakker48916f92012-09-16 19:57:18 +00005837{
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005838 if( transform == NULL )
5839 return;
5840
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005841#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker48916f92012-09-16 19:57:18 +00005842 deflateEnd( &transform->ctx_deflate );
5843 inflateEnd( &transform->ctx_inflate );
5844#endif
5845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005846 mbedtls_cipher_free( &transform->cipher_ctx_enc );
5847 mbedtls_cipher_free( &transform->cipher_ctx_dec );
Manuel Pégourié-Gonnardf71e5872013-09-23 17:12:43 +02005848
Hanno Beckerd56ed242018-01-03 15:32:51 +00005849#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005850 mbedtls_md_free( &transform->md_ctx_enc );
5851 mbedtls_md_free( &transform->md_ctx_dec );
Hanno Beckerd56ed242018-01-03 15:32:51 +00005852#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005853
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -05005854 mbedtls_platform_zeroize( transform, sizeof( mbedtls_ssl_transform ) );
Paul Bakker48916f92012-09-16 19:57:18 +00005855}
5856
Hanno Becker0271f962018-08-16 13:23:47 +01005857#if defined(MBEDTLS_SSL_PROTO_DTLS)
5858
Hanno Becker533ab5f2020-02-05 10:49:13 +00005859void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl )
Hanno Becker0271f962018-08-16 13:23:47 +01005860{
5861 unsigned offset;
5862 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5863
5864 if( hs == NULL )
5865 return;
5866
Hanno Becker283f5ef2018-08-24 09:34:47 +01005867 ssl_free_buffered_record( ssl );
5868
Hanno Becker0271f962018-08-16 13:23:47 +01005869 for( offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++ )
Hanno Beckere605b192018-08-21 15:59:07 +01005870 ssl_buffering_free_slot( ssl, offset );
5871}
5872
5873static void ssl_buffering_free_slot( mbedtls_ssl_context *ssl,
5874 uint8_t slot )
5875{
5876 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5877 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005878
5879 if( slot >= MBEDTLS_SSL_MAX_BUFFERED_HS )
5880 return;
5881
Hanno Beckere605b192018-08-21 15:59:07 +01005882 if( hs_buf->is_valid == 1 )
Hanno Becker0271f962018-08-16 13:23:47 +01005883 {
Hanno Beckere605b192018-08-21 15:59:07 +01005884 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Hanno Becker805f2e12018-10-12 16:31:41 +01005885 mbedtls_platform_zeroize( hs_buf->data, hs_buf->data_len );
Hanno Beckere605b192018-08-21 15:59:07 +01005886 mbedtls_free( hs_buf->data );
5887 memset( hs_buf, 0, sizeof( mbedtls_ssl_hs_buffer ) );
Hanno Becker0271f962018-08-16 13:23:47 +01005888 }
5889}
5890
5891#endif /* MBEDTLS_SSL_PROTO_DTLS */
5892
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005893/*
5894 * Convert version numbers to/from wire format
5895 * and, for DTLS, to/from TLS equivalent.
5896 *
5897 * For TLS this is the identity.
Brian J Murray1903fb32016-11-06 04:45:15 -08005898 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005899 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
5900 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
5901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005902void mbedtls_ssl_write_version( int major, int minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005903 unsigned char ver[2] )
5904{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005905#if defined(MBEDTLS_SSL_PROTO_DTLS)
5906 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005907 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005908 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005909 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5910
5911 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
5912 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
5913 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005914 else
5915#else
5916 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005917#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005918 {
5919 ver[0] = (unsigned char) major;
5920 ver[1] = (unsigned char) minor;
5921 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005922}
5923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005924void mbedtls_ssl_read_version( int *major, int *minor, int transport,
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005925 const unsigned char ver[2] )
5926{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005927#if defined(MBEDTLS_SSL_PROTO_DTLS)
5928 if( transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005929 {
5930 *major = 255 - ver[0] + 2;
5931 *minor = 255 - ver[1] + 1;
5932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005933 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005934 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
5935 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005936 else
5937#else
5938 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005939#endif
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005940 {
5941 *major = ver[0];
5942 *minor = ver[1];
5943 }
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005944}
5945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005946#endif /* MBEDTLS_SSL_TLS_C */