blob: 1162cca0221aad29d1ce8ee0eb7622e194ffeee2 [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/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010030
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000031#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000032#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000033#include "mbedtls/debug.h"
34#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050035#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010036#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020037#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020038#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
43#include "mbedtls/psa_util.h"
44#include "psa/crypto.h"
45#endif
46
Janos Follath23bdca02016-10-07 14:47:14 +010047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020049#endif
50
Gilles Peskine449bd832023-01-11 14:50:10 +010051static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +010052
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020053/*
54 * Start a timer.
55 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020056 */
Gilles Peskine449bd832023-01-11 14:50:10 +010057void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020058{
Gilles Peskine449bd832023-01-11 14:50:10 +010059 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020060 return;
Gilles Peskine449bd832023-01-11 14:50:10 +010061 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +020062
Gilles Peskine449bd832023-01-11 14:50:10 +010063 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
64 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020065}
66
67/*
68 * Return -1 is timer is expired, 0 if it isn't.
69 */
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 if (ssl->f_get_timer == NULL) {
73 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020074 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020075
Gilles Peskine449bd832023-01-11 14:50:10 +010076 if (ssl->f_get_timer(ssl->p_timer) == 2) {
77 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
78 return -1;
79 }
80
81 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020082}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +020083
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020084MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
86 unsigned char *buf,
87 size_t len,
88 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +020089
Gilles Peskine449bd832023-01-11 14:50:10 +010090int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
91 unsigned char *buf,
92 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +020093{
94 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +010095 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
96 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +020097
98 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +020099 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200100 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200102 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
103 goto exit;
104 }
105#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200107 mbedtls_record rec;
108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
110 if (ret != 0) {
111 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200112 goto exit;
113 }
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 if (ssl->transform_in != NULL) {
116 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
117 if (ret != 0) {
118 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200119 goto exit;
120 }
121 }
122 }
123#endif /* MBEDTLS_SSL_PROTO_DTLS */
124
125exit:
126 /* On success, we have decrypted the buffer in-place, so make
127 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200129
130 /* For the purpose of this API, treat messages with unexpected CID
131 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
133 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200134 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
135 }
136
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
138 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200139}
140
Hanno Becker67bc7c32018-08-06 11:33:50 +0100141#define SSL_DONT_FORCE_FLUSH 0
142#define SSL_FORCE_FLUSH 1
143
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100145
Hanno Beckerd5847772018-08-28 10:09:23 +0100146/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
148 uint8_t slot);
149static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200150MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100151static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200152MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100153static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200154MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100155static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200156MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100157static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
158 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200159MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100160static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100163{
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000165#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
166 size_t out_buf_len = ssl->out_buf_len;
167#else
168 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
169#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100170
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 if (mtu != 0 && mtu < out_buf_len) {
172 return mtu;
173 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100174
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100176}
177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100179static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100180{
Hanno Becker11682cc2018-08-22 14:41:02 +0100181 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100183
184 /* Double-check that the write-index hasn't gone
185 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100187 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100189 }
190
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100192}
193
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200194MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100195static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100196{
Janos Follath865b3eb2019-12-16 11:46:15 +0000197 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100198 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400199 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100200
201#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100203
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100205 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100207
208 /* By the standard (RFC 6066 Sect. 4), the MFL extension
209 * only limits the maximum record payload size, so in theory
210 * we would be allowed to pack multiple records of payload size
211 * MFL into a single datagram. However, this would mean that there's
212 * no way to explicitly communicate MTU restrictions to the peer.
213 *
214 * The following reduction of max_len makes sure that we never
215 * write datagrams larger than MFL + Record Expansion Overhead.
216 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 if (max_len <= ssl->out_left) {
218 return 0;
219 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100220
221 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100222#endif
223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224 ret = ssl_get_remaining_space_in_datagram(ssl);
225 if (ret < 0) {
226 return ret;
227 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100228 remaining = (size_t) ret;
229
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 ret = mbedtls_ssl_get_record_expansion(ssl);
231 if (ret < 0) {
232 return ret;
233 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100234 expansion = (size_t) ret;
235
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 if (remaining <= expansion) {
237 return 0;
238 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100239
240 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100242 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100244
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100246}
247
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200248/*
249 * Double the retransmit timeout value, within the allowed range,
250 * returning -1 if the maximum value has already been reached.
251 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200252MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100253static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200254{
255 uint32_t new_timeout;
256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
258 return -1;
259 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200260
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200261 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
262 * in the following way: after the initial transmission and a first
263 * retransmission, back off to a temporary estimated MTU of 508 bytes.
264 * This value is guaranteed to be deliverable (if not guaranteed to be
265 * delivered) of any compliant IPv4 (and IPv6) network, and should work
266 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200268 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400270 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200271
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200272 new_timeout = 2 * ssl->handshake->retransmit_timeout;
273
274 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 if (new_timeout < ssl->handshake->retransmit_timeout ||
276 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200277 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200278 }
279
280 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
282 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200283
Gilles Peskine449bd832023-01-11 14:50:10 +0100284 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200285}
286
Gilles Peskine449bd832023-01-11 14:50:10 +0100287static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200288{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200289 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
291 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200292}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200294
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100295/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000296 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200297 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000298
Ronald Cron6f135e12021-12-08 16:57:54 +0100299#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100300
Gilles Peskine449bd832023-01-11 14:50:10 +0100301static size_t ssl_compute_padding_length(size_t len,
302 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100303{
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100305}
306
Hanno Becker581bc1b2020-05-04 12:20:03 +0100307/* This functions transforms a (D)TLS plaintext fragment and a record content
308 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
309 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
310 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100311 *
312 * struct {
313 * opaque content[DTLSPlaintext.length];
314 * ContentType real_type;
315 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100316 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100317 *
318 * Input:
319 * - `content`: The beginning of the buffer holding the
320 * plaintext to be wrapped.
321 * - `*content_size`: The length of the plaintext in Bytes.
322 * - `max_len`: The number of Bytes available starting from
323 * `content`. This must be `>= *content_size`.
324 * - `rec_type`: The desired record content type.
325 *
326 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100327 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
328 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100329 *
330 * Returns:
331 * - `0` on success.
332 * - A negative error code if `max_len` didn't offer enough space
333 * for the expansion.
334 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200335MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100336static int ssl_build_inner_plaintext(unsigned char *content,
337 size_t *content_size,
338 size_t remaining,
339 uint8_t rec_type,
340 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100341{
342 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100343
344 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (remaining == 0) {
346 return -1;
347 }
348 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100349 len++;
350 remaining--;
351
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 if (remaining < pad) {
353 return -1;
354 }
355 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100356 len += pad;
357 remaining -= pad;
358
359 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100361}
362
Hanno Becker581bc1b2020-05-04 12:20:03 +0100363/* This function parses a (D)TLSInnerPlaintext structure.
364 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200365MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100366static int ssl_parse_inner_plaintext(unsigned char const *content,
367 size_t *content_size,
368 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100369{
370 size_t remaining = *content_size;
371
372 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 do {
374 if (remaining == 0) {
375 return -1;
376 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100377 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100379
380 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100382
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100384}
Ronald Cron6f135e12021-12-08 16:57:54 +0100385#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100386
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200387/* The size of the `add_data` structure depends on various
388 * factors, namely
389 *
390 * 1) CID functionality disabled
391 *
392 * additional_data =
393 * 8: seq_num +
394 * 1: type +
395 * 2: version +
396 * 2: length of inner plaintext +
397 *
398 * size = 13 bytes
399 *
400 * 2) CID functionality based on RFC 9146 enabled
401 *
402 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
403 * = 23 + CID-length
404 *
405 * 3) CID functionality based on legacy CID version
406 according to draft-ietf-tls-dtls-connection-id-05
407 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
408 *
409 * size = 13 + 1 + CID-length
410 *
411 * More information about the CID usage:
412 *
413 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
414 * size of the additional data structure is calculated as:
415 *
416 * additional_data =
417 * 8: seq_num +
418 * 1: tls12_cid +
419 * 2: DTLSCipherText.version +
420 * n: cid +
421 * 1: cid_length +
422 * 2: length_of_DTLSInnerPlaintext
423 *
424 * Per RFC 9146 the size of the add_data structure is calculated as:
425 *
426 * additional_data =
427 * 8: seq_num_placeholder +
428 * 1: tls12_cid +
429 * 1: cid_length +
430 * 1: tls12_cid +
431 * 2: DTLSCiphertext.version +
432 * 2: epoch +
433 * 6: sequence_number +
434 * n: cid +
435 * 2: length_of_DTLSInnerPlaintext
436 *
437 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100438static void ssl_extract_add_data_from_record(unsigned char *add_data,
439 size_t *add_data_len,
440 mbedtls_record *rec,
441 mbedtls_ssl_protocol_version
442 tls_version,
443 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000444{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200445 /* Several types of ciphers have been defined for use with TLS and DTLS,
446 * and the MAC calculations for those ciphers differ slightly. Further
447 * variants were added when the CID functionality was added with RFC 9146.
448 * This implementations also considers the use of a legacy version of the
449 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
450 * which is used in deployments.
451 *
452 * We will distinguish between the non-CID and the CID cases below.
453 *
454 * --- Non-CID cases ---
455 *
456 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100457 *
458 * additional_data = seq_num + TLSCompressed.type +
459 * TLSCompressed.version + TLSCompressed.length;
460 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100461 * For TLS 1.3, the record sequence number is dropped from the AAD
462 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000463 * Moreover, the additional data involves the length of the TLS
464 * ciphertext, not the TLS plaintext as in earlier versions.
465 * Quoting RFC 8446 (TLS 1.3):
466 *
467 * additional_data = TLSCiphertext.opaque_type ||
468 * TLSCiphertext.legacy_record_version ||
469 * TLSCiphertext.length
470 *
471 * We pass the tag length to this function in order to compute the
472 * ciphertext length from the inner plaintext length rec->data_len via
473 *
474 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
475 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200476 * --- CID cases ---
477 *
478 * RFC 9146 uses a common pattern when constructing the data
479 * passed into a MAC / AEAD cipher.
480 *
481 * Data concatenation for MACs used with block ciphers with
482 * Encrypt-then-MAC Processing (with CID):
483 *
484 * data = seq_num_placeholder +
485 * tls12_cid +
486 * cid_length +
487 * tls12_cid +
488 * DTLSCiphertext.version +
489 * epoch +
490 * sequence_number +
491 * cid +
492 * DTLSCiphertext.length +
493 * IV +
494 * ENC(content + padding + padding_length)
495 *
496 * Data concatenation for MACs used with block ciphers (with CID):
497 *
498 * data = seq_num_placeholder +
499 * tls12_cid +
500 * cid_length +
501 * tls12_cid +
502 * DTLSCiphertext.version +
503 * epoch +
504 * sequence_number +
505 * cid +
506 * length_of_DTLSInnerPlaintext +
507 * DTLSInnerPlaintext.content +
508 * DTLSInnerPlaintext.real_type +
509 * DTLSInnerPlaintext.zeros
510 *
511 * AEAD ciphers use the following additional data calculation (with CIDs):
512 *
513 * additional_data = seq_num_placeholder +
514 * tls12_cid +
515 * cid_length +
516 * tls12_cid +
517 * DTLSCiphertext.version +
518 * epoch +
519 * sequence_number +
520 * cid +
521 * length_of_DTLSInnerPlaintext
522 *
523 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
524 * defines the additional data calculation as follows:
525 *
526 * additional_data = seq_num +
527 * tls12_cid +
528 * DTLSCipherText.version +
529 * cid +
530 * cid_length +
531 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100533
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100534 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000535 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100536
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200537#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
538 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
539 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
540#endif
541
Ronald Cron6f135e12021-12-08 16:57:54 +0100542#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000544 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
545 * which differs from the length of the TLSInnerPlaintext
546 * by the length of the authentication tag. */
547 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100549#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100550 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400551 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000552 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200553
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100554#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
556 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200557 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
559 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200560
561 // tls12_cid type
562 *cur = rec->type;
563 cur++;
564
565 // cid_length
566 *cur = rec->cid_len;
567 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100569#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200570 {
571 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 memcpy(cur, rec->ctr, sizeof(rec->ctr));
573 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200574 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100575 }
576
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200577 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100578 *cur = rec->type;
579 cur++;
580
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200581 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 memcpy(cur, rec->ver, sizeof(rec->ver));
583 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100584
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200585#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
586 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
587
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200589 // CID
590 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100591 cur += rec->cid_len;
592
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200593 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100594 *cur = rec->cid_len;
595 cur++;
596
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200597 // length of inner plaintext
598 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
599 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200601#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
602 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200605 // epoch + sequence number
606 memcpy(cur, rec->ctr, sizeof(rec->ctr));
607 cur += sizeof(rec->ctr);
608
609 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200611 cur += rec->cid_len;
612
613 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100615 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100616 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100617#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100618 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100620 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100621 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100622
623 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000624}
625
Hanno Becker67a37db2020-05-28 16:27:07 +0100626#if defined(MBEDTLS_GCM_C) || \
627 defined(MBEDTLS_CCM_C) || \
628 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200629MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100630static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100632{
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100634}
635
Hanno Becker17263802020-05-28 07:05:48 +0100636/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
637 *
638 * Concretely, this occurs in two variants:
639 *
640 * a) Fixed and dynamic IV lengths add up to total IV length, giving
641 * IV = fixed_iv || dynamic_iv
642 *
Hanno Becker15952812020-06-04 13:31:46 +0100643 * This variant is used in TLS 1.2 when used with GCM or CCM.
644 *
Hanno Becker17263802020-05-28 07:05:48 +0100645 * b) Fixed IV lengths matches total IV length, giving
646 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100647 *
648 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
649 *
650 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100651 *
652 * This function has the precondition that
653 *
654 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
655 *
656 * which has to be ensured by the caller. If this precondition
657 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100658 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100659static void ssl_build_record_nonce(unsigned char *dst_iv,
660 size_t dst_iv_len,
661 unsigned char const *fixed_iv,
662 size_t fixed_iv_len,
663 unsigned char const *dynamic_iv,
664 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100665{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100666 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 memset(dst_iv, 0, dst_iv_len);
668 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100669
Hanno Becker17263802020-05-28 07:05:48 +0100670 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100672}
Hanno Becker67a37db2020-05-28 16:27:07 +0100673#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
676 mbedtls_ssl_transform *transform,
677 mbedtls_record *rec,
678 int (*f_rng)(void *, unsigned char *, size_t),
679 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000680{
Neil Armstrong136f8402022-03-30 10:58:01 +0200681 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100682 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200684 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 * the description of ssl_extract_add_data_from_record().
686 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200687#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
688 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
689#else
690 unsigned char add_data[13];
691#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100692 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000693 size_t post_avail;
694
695 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000696#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200697 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000698 ((void) ssl);
699#endif
700
701 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200702 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100703#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
704 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000705 ((void) f_rng);
706 ((void) p_rng);
707#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000708
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000710
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 if (transform == NULL) {
712 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
713 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000714 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100716 || rec->buf == NULL
717 || rec->buf_len < rec->data_offset
718 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100719#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100720 || rec->cid_len != 0
721#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 ) {
723 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
724 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100725 }
726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200728
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000729 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
731 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
732 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000733
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
735 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
736 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
737 rec->data_len,
738 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000740 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100741
Hanno Becker92313402020-05-20 13:58:58 +0100742 /* The following two code paths implement the (D)TLSInnerPlaintext
743 * structure present in TLS 1.3 and DTLS 1.2 + CID.
744 *
745 * See ssl_build_inner_plaintext() for more information.
746 *
747 * Note that this changes `rec->data_len`, and hence
748 * `post_avail` needs to be recalculated afterwards.
749 *
750 * Note also that the two code paths cannot occur simultaneously
751 * since they apply to different versions of the protocol. There
752 * is hence no risk of double-addition of the inner plaintext.
753 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100754#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100756 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 ssl_compute_padding_length(rec->data_len,
758 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
759 if (ssl_build_inner_plaintext(data,
760 &rec->data_len,
761 post_avail,
762 rec->type,
763 padding) != 0) {
764 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100765 }
766
767 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
768 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100769#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100770
Hanno Beckera0e20d02019-05-15 14:03:01 +0100771#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100772 /*
773 * Add CID information
774 */
775 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
777 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100780 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 ssl_compute_padding_length(rec->data_len,
782 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100783 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100784 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100785 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100786 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100787 * Note that this changes `rec->data_len`, and hence
788 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100789 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (ssl_build_inner_plaintext(data,
791 &rec->data_len,
792 post_avail,
793 rec->type,
794 padding) != 0) {
795 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100796 }
797
798 rec->type = MBEDTLS_SSL_MSG_CID;
799 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100800#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100803
Paul Bakker5121ce52009-01-03 21:22:43 +0000804 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100805 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000806 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000807#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
809 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
810 if (post_avail < transform->maclen) {
811 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
812 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000813 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200814#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200815 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100817#if defined(MBEDTLS_USE_PSA_CRYPTO)
818 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
819 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
820 size_t sign_mac_length = 0;
821#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +0000822
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
824 transform->tls_version,
825 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000826
Neil Armstrong26e6d672022-02-23 09:30:33 +0100827#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
829 transform->psa_mac_alg);
830 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100831 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 status = psa_mac_update(&operation, add_data, add_data_len);
835 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100836 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100838
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 status = psa_mac_update(&operation, data, rec->data_len);
840 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100841 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
845 &sign_mac_length);
846 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100847 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100849#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
851 add_data_len);
852 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100853 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 }
855 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
856 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100857 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 }
859 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
860 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100861 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 }
863 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
864 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100865 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100866 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100867#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000868
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200870#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200871
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
873 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200874
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000875 rec->data_len += transform->maclen;
876 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100877 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100878
Gilles Peskine449bd832023-01-11 14:50:10 +0100879hmac_failed_etm_disabled:
880 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +0100881#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 ret = psa_ssl_status_to_mbedtls(status);
883 status = psa_mac_abort(&operation);
884 if (ret == 0 && status != PSA_SUCCESS) {
885 ret = psa_ssl_status_to_mbedtls(status);
886 }
Neil Armstrong4313f552022-03-02 15:14:07 +0100887#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +0100888 if (ret != 0) {
889 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
890 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100891 }
Paul Bakker577e0062013-08-28 11:57:20 +0200892 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000893#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000894
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200895 /*
896 * Encrypt
897 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000898#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
900 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
901 "including %d bytes of padding",
902 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +0000903
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100904 /* The only supported stream cipher is "NULL",
905 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000907#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000908
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200909#if defined(MBEDTLS_GCM_C) || \
910 defined(MBEDTLS_CCM_C) || \
911 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100912 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200913 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100914 unsigned char *dynamic_iv;
915 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100916 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100918#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100920#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000922
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100923 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 if (post_avail < transform->taglen) {
925 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
926 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000927 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000928
Paul Bakker68884e32013-01-07 18:20:04 +0100929 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +0100930 * Build nonce for AEAD encryption.
931 *
932 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
933 * part of the IV is prepended to the ciphertext and
934 * can be chosen freely - in particular, it need not
935 * agree with the record sequence number.
936 * However, since ChaChaPoly as well as all AEAD modes
937 * in TLS 1.3 use the record sequence number as the
938 * dynamic part of the nonce, we uniformly use the
939 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +0100940 */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100941 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 ssl_build_record_nonce(iv, sizeof(iv),
945 transform->iv_enc,
946 transform->fixed_ivlen,
947 dynamic_iv,
948 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +0100949
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100950 /*
951 * Build additional data for AEAD encryption.
952 * This depends on the TLS version.
953 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
955 transform->tls_version,
956 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
959 iv, transform->ivlen);
960 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
961 dynamic_iv,
962 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
963 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
964 add_data, add_data_len);
965 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
966 "including 0 bytes of padding",
967 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +0000968
Paul Bakker68884e32013-01-07 18:20:04 +0100969 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +0200970 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200971 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 status = psa_aead_encrypt(transform->psa_key_enc,
974 transform->psa_alg,
975 iv, transform->ivlen,
976 add_data, add_data_len,
977 data, rec->data_len,
978 data, rec->buf_len - (data - rec->buf),
979 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (status != PSA_SUCCESS) {
982 ret = psa_ssl_status_to_mbedtls(status);
983 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
984 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100985 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100986#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
988 iv, transform->ivlen,
989 add_data, add_data_len,
990 data, rec->data_len, /* src */
991 data, rec->buf_len - (data - rec->buf), /* dst */
992 &rec->data_len,
993 transform->taglen)) != 0) {
994 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
995 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +0200996 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +0100997#endif /* MBEDTLS_USE_PSA_CRYPTO */
998
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1000 data + rec->data_len - transform->taglen,
1001 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001002 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001003 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001004
1005 /*
1006 * Prefix record content with dynamic IV in case it is explicit.
1007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 if (dynamic_iv_is_explicit != 0) {
1009 if (rec->data_offset < dynamic_iv_len) {
1010 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1011 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001012 }
1013
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001015 rec->data_offset -= dynamic_iv_len;
1016 rec->data_len += dynamic_iv_len;
1017 }
1018
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001019 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 } else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001021#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001022#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1024 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001025 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001026 size_t padlen, i;
1027 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001028#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001029 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001030 size_t part_len;
1031 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1032#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001033
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001034 /* Currently we're always using minimal padding
1035 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1037 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001038 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001039 }
1040
Gilles Peskine449bd832023-01-11 14:50:10 +01001041 /* Check there's enough space in the buffer for the padding. */
1042 if (post_avail < padlen + 1) {
1043 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1044 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1045 }
1046
1047 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001048 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001050
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001051 rec->data_len += padlen + 1;
1052 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001053
TRodziewicz0f82ec62021-05-12 17:49:18 +02001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001055 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001056 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001057 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (f_rng == NULL) {
1060 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1061 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001062 }
TRodziewicz345165c2021-07-06 13:42:11 +02001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 if (rec->data_offset < transform->ivlen) {
1065 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1066 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001067 }
1068
1069 /*
1070 * Generate IV
1071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1073 if (ret != 0) {
1074 return ret;
1075 }
TRodziewicz345165c2021-07-06 13:42:11 +02001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001078#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1081 "including %"
1082 MBEDTLS_PRINTF_SIZET
1083 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1084 rec->data_len, transform->ivlen,
1085 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001086
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001087#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 status = psa_cipher_encrypt_setup(&cipher_op,
1089 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (status != PSA_SUCCESS) {
1092 ret = psa_ssl_status_to_mbedtls(status);
1093 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1094 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001095 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (status != PSA_SUCCESS) {
1100 ret = psa_ssl_status_to_mbedtls(status);
1101 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1102 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001103
1104 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 status = psa_cipher_update(&cipher_op,
1107 data, rec->data_len,
1108 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 if (status != PSA_SUCCESS) {
1111 ret = psa_ssl_status_to_mbedtls(status);
1112 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1113 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001114
1115 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 status = psa_cipher_finish(&cipher_op,
1118 data + olen, rec->data_len - olen,
1119 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001120
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 if (status != PSA_SUCCESS) {
1122 ret = psa_ssl_status_to_mbedtls(status);
1123 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1124 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001125
1126 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001127
1128 olen += part_len;
1129#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1131 transform->iv_enc,
1132 transform->ivlen,
1133 data, rec->data_len,
1134 data, &olen)) != 0) {
1135 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1136 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001137 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001138#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 if (rec->data_len != olen) {
1141 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1142 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001143 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001144
TRodziewicz0f82ec62021-05-12 17:49:18 +02001145 data -= transform->ivlen;
1146 rec->data_offset -= transform->ivlen;
1147 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001151 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001152#if defined(MBEDTLS_USE_PSA_CRYPTO)
1153 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1154 size_t sign_mac_length = 0;
1155#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001156
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001157 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001158 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (post_avail < transform->maclen) {
1161 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1162 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001163 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 ssl_extract_add_data_from_record(add_data, &add_data_len,
1166 rec, transform->tls_version,
1167 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1170 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1171 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001172#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1174 transform->psa_mac_alg);
1175 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001176 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 status = psa_mac_update(&operation, add_data, add_data_len);
1180 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001181 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 status = psa_mac_update(&operation, data, rec->data_len);
1185 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001186 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1190 &sign_mac_length);
1191 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001192 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001194#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1197 add_data_len);
1198 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001199 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 }
1201 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1202 data, rec->data_len);
1203 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001204 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 }
1206 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1207 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001208 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 }
1210 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1211 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001212 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001214#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001217
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001218 rec->data_len += transform->maclen;
1219 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001220 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222hmac_failed_etm_enabled:
1223 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001224#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 ret = psa_ssl_status_to_mbedtls(status);
1226 status = psa_mac_abort(&operation);
1227 if (ret == 0 && status != PSA_SUCCESS) {
1228 ret = psa_ssl_status_to_mbedtls(status);
1229 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001230#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 if (ret != 0) {
1232 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1233 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001234 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001235 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001238#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001239 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1241 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001242 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001243
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001244 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if (auth_done != 1) {
1246 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1247 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001248 }
1249
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001253}
1254
Gilles Peskine449bd832023-01-11 14:50:10 +01001255int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1256 mbedtls_ssl_transform *transform,
1257 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001258{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001259#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001260 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001261#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001262 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001263 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001264
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001265 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001266#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001267 size_t padlen = 0, correct = 1;
1268#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001270 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001271 * the description of ssl_extract_add_data_from_record().
1272 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001273#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1274 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1275#else
1276 unsigned char add_data[13];
1277#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001278 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001279
Hanno Beckera18d1322018-01-03 14:27:32 +00001280#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001281 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001282 ((void) ssl);
1283#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1286 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001287 rec->buf == NULL ||
1288 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 rec->buf_len - rec->data_offset < rec->data_len) {
1290 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1291 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001292 }
1293
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001296
Hanno Beckera0e20d02019-05-15 14:03:01 +01001297#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001298 /*
1299 * Match record's CID with incoming CID.
1300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 if (rec->cid_len != transform->in_cid_len ||
1302 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1303 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001304 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001305#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001306
Hanno Beckerd086bf02021-03-22 13:01:27 +00001307#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001309 /* The only supported stream cipher is "NULL",
1310 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001312#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001313#if defined(MBEDTLS_GCM_C) || \
1314 defined(MBEDTLS_CCM_C) || \
1315 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001317 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001318 unsigned char *dynamic_iv;
1319 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001320#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001322#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001323
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001324 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001325 * Extract dynamic part of nonce for AEAD decryption.
1326 *
1327 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1328 * part of the IV is prepended to the ciphertext and
1329 * can be chosen freely - in particular, it need not
1330 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 dynamic_iv_len = sizeof(rec->ctr);
1333 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1334 if (rec->data_len < dynamic_iv_len) {
1335 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1336 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1337 rec->data_len,
1338 dynamic_iv_len));
1339 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001340 }
1341 dynamic_iv = data;
1342
1343 data += dynamic_iv_len;
1344 rec->data_offset += dynamic_iv_len;
1345 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001347 dynamic_iv = rec->ctr;
1348 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001349
1350 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 if (rec->data_len < transform->taglen) {
1352 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1353 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1354 rec->data_len,
1355 transform->taglen));
1356 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001357 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001358 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001359
Hanno Beckerdf8be222020-05-21 15:30:57 +01001360 /*
1361 * Prepare nonce from dynamic and static parts.
1362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 ssl_build_record_nonce(iv, sizeof(iv),
1364 transform->iv_dec,
1365 transform->fixed_ivlen,
1366 dynamic_iv,
1367 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001368
Hanno Beckerdf8be222020-05-21 15:30:57 +01001369 /*
1370 * Build additional data for AEAD encryption.
1371 * This depends on the TLS version.
1372 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1374 transform->tls_version,
1375 transform->taglen);
1376 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1377 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001378
Hanno Beckerd96a6522019-07-10 13:55:25 +01001379 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001380 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001381 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001382 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001383 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001384
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1386 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1387 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001388
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001389 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001390 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001391 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001392#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 status = psa_aead_decrypt(transform->psa_key_dec,
1394 transform->psa_alg,
1395 iv, transform->ivlen,
1396 add_data, add_data_len,
1397 data, rec->data_len + transform->taglen,
1398 data, rec->buf_len - (data - rec->buf),
1399 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 if (status != PSA_SUCCESS) {
1402 ret = psa_ssl_status_to_mbedtls(status);
1403 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1404 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001405 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001406#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1408 iv, transform->ivlen,
1409 add_data, add_data_len,
1410 data, rec->data_len + transform->taglen, /* src */
1411 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1412 transform->taglen)) != 0) {
1413 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001414
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1416 return MBEDTLS_ERR_SSL_INVALID_MAC;
1417 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001420 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001421#endif /* MBEDTLS_USE_PSA_CRYPTO */
1422
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001423 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001424
Hanno Beckerd96a6522019-07-10 13:55:25 +01001425 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if (olen != rec->data_len) {
1427 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1428 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001429 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001432#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1434 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001435 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001436#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001437 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001438 size_t part_len;
1439 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1440#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001441
Paul Bakker5121ce52009-01-03 21:22:43 +00001442 /*
Paul Bakker45829992013-01-03 14:52:21 +01001443 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001444 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001446 /* The ciphertext is prefixed with the CBC IV. */
1447 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001448#endif
Paul Bakker45829992013-01-03 14:52:21 +01001449
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001450 /* Size considerations:
1451 *
1452 * - The CBC cipher text must not be empty and hence
1453 * at least of size transform->ivlen.
1454 *
1455 * Together with the potential IV-prefix, this explains
1456 * the first of the two checks below.
1457 *
1458 * - The record must contain a MAC, either in plain or
1459 * encrypted, depending on whether Encrypt-then-MAC
1460 * is used or not.
1461 * - If it is, the message contains the IV-prefix,
1462 * the CBC ciphertext, and the MAC.
1463 * - If it is not, the padded plaintext, and hence
1464 * the CBC ciphertext, has at least length maclen + 1
1465 * because there is at least the padding length byte.
1466 *
1467 * As the CBC ciphertext is not empty, both cases give the
1468 * lower bound minlen + maclen + 1 on the record size, which
1469 * we test for in the second check below.
1470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (rec->data_len < minlen + transform->ivlen ||
1472 rec->data_len < minlen + transform->maclen + 1) {
1473 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1474 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1475 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1476 "+ 1 ) ( + expl IV )",
1477 rec->data_len,
1478 transform->ivlen,
1479 transform->maclen));
1480 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001481 }
1482
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001483 /*
1484 * Authenticate before decrypt if enabled
1485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001488#if defined(MBEDTLS_USE_PSA_CRYPTO)
1489 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1490#else
Hanno Becker992b6872017-11-09 18:57:39 +00001491 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001492#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001493
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001495
Hanno Beckerd96a6522019-07-10 13:55:25 +01001496 /* Update data_len in tandem with add_data.
1497 *
1498 * The subtraction is safe because of the previous check
1499 * data_len >= minlen + maclen + 1.
1500 *
1501 * Afterwards, we know that data + data_len is followed by at
1502 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001503 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001504 *
1505 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001506 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1508 transform->tls_version,
1509 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001510
Hanno Beckerd96a6522019-07-10 13:55:25 +01001511 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1513 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001514#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1516 transform->psa_mac_alg);
1517 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001518 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001520
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 status = psa_mac_update(&operation, add_data, add_data_len);
1522 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001523 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 status = psa_mac_update(&operation, data, rec->data_len);
1527 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001528 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001530
1531 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1533 transform->maclen);
1534 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001535 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001537#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1539 add_data_len);
1540 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001541 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 }
1543 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1544 data, rec->data_len);
1545 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001546 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 }
1548 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1549 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001550 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 }
1552 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1553 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001554 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1558 transform->maclen);
1559 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1560 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001561
Hanno Beckerd96a6522019-07-10 13:55:25 +01001562 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1564 transform->maclen) != 0) {
1565 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001566 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1567 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001568 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001569#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001570 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001571
Gilles Peskine449bd832023-01-11 14:50:10 +01001572hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001573#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 ret = psa_ssl_status_to_mbedtls(status);
1575 status = psa_mac_abort(&operation);
1576 if (ret == 0 && status != PSA_SUCCESS) {
1577 ret = psa_ssl_status_to_mbedtls(status);
1578 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001579#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001581#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 if (ret != 0) {
1583 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1584 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1585 }
1586 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001587 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001588 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001590
1591 /*
1592 * Check length sanity
1593 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001594
1595 /* We know from above that data_len > minlen >= 0,
1596 * so the following check in particular implies that
1597 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 if (rec->data_len % transform->ivlen != 0) {
1599 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1600 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1601 rec->data_len, transform->ivlen));
1602 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001603 }
1604
TRodziewicz0f82ec62021-05-12 17:49:18 +02001605#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001606 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001607 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001608 */
TRodziewicz345165c2021-07-06 13:42:11 +02001609 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001611
TRodziewicz345165c2021-07-06 13:42:11 +02001612 data += transform->ivlen;
1613 rec->data_offset += transform->ivlen;
1614 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001615#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001616
Hanno Beckerd96a6522019-07-10 13:55:25 +01001617 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1618
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001619#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 status = psa_cipher_decrypt_setup(&cipher_op,
1621 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if (status != PSA_SUCCESS) {
1624 ret = psa_ssl_status_to_mbedtls(status);
1625 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1626 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001627 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if (status != PSA_SUCCESS) {
1632 ret = psa_ssl_status_to_mbedtls(status);
1633 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1634 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001635 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 status = psa_cipher_update(&cipher_op,
1638 data, rec->data_len,
1639 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if (status != PSA_SUCCESS) {
1642 ret = psa_ssl_status_to_mbedtls(status);
1643 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1644 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001645 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 status = psa_cipher_finish(&cipher_op,
1648 data + olen, rec->data_len - olen,
1649 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 if (status != PSA_SUCCESS) {
1652 ret = psa_ssl_status_to_mbedtls(status);
1653 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1654 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001655 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001656
1657 olen += part_len;
1658#else
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1661 transform->iv_dec, transform->ivlen,
1662 data, rec->data_len, data, &olen)) != 0) {
1663 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1664 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001665 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001666#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001667
Hanno Beckerd96a6522019-07-10 13:55:25 +01001668 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 if (rec->data_len != olen) {
1670 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1671 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001672 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001673
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001674 /* Safe since data_len >= minlen + maclen + 1, so after having
1675 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001676 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1677 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001678 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 if (auth_done == 1) {
Gabor Mezei90437e32021-10-20 11:59:27 +02001681 const size_t mask = mbedtls_ct_size_mask_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 rec->data_len,
1683 padlen + 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001684 correct &= mask;
1685 padlen &= mask;
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 if (rec->data_len < transform->maclen + padlen + 1) {
1689 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1690 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1691 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1692 rec->data_len,
1693 transform->maclen,
1694 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001695 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001696#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001697
Gabor Mezei90437e32021-10-20 11:59:27 +02001698 const size_t mask = mbedtls_ct_size_mask_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 rec->data_len,
1700 transform->maclen + padlen + 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001701 correct &= mask;
1702 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001703 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001704
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001705 padlen++;
1706
1707 /* Regardless of the validity of the padding,
1708 * we have data_len >= padlen here. */
1709
TRodziewicz0f82ec62021-05-12 17:49:18 +02001710#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001711 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 * consecutive memory reads at the end of the record
1713 * plaintext buffer. In order to hide the length and
1714 * validity of the padding, always perform exactly
1715 * `min(256,plaintext_len)` reads (but take into account
1716 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001717 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001719
1720 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001722 size_t const padding_idx = rec->data_len - padlen;
1723 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1724 size_t const start_idx = rec->data_len - num_checks;
1725 size_t idx;
1726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001728 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 * (check[idx] == padlen - 1);
1730 */
1731 const size_t mask = mbedtls_ct_size_mask_ge(idx, padding_idx);
1732 const size_t equal = mbedtls_ct_size_bool_eq(check[idx],
1733 padlen - 1);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001734 pad_count += mask & equal;
1735 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 correct &= mbedtls_ct_size_bool_eq(pad_count, padlen);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (padlen > 0 && correct == 0) {
1740 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1741 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001742#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 padlen &= mbedtls_ct_size_mask(correct);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001744
TRodziewicz0f82ec62021-05-12 17:49:18 +02001745#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001746
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001747 /* If the padding was found to be invalid, padlen == 0
1748 * and the subtraction is safe. If the padding was found valid,
1749 * padlen hasn't been changed and the previous assertion
1750 * data_len >= padlen still holds. */
1751 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001753#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001754 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1756 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001757 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001758
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001759#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1761 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001762#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001763
1764 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001765 * Authenticate if not done yet.
1766 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001767 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001768#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001770 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1771 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001772
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001773 /* If the initial value of padlen was such that
1774 * data_len < maclen + padlen + 1, then padlen
1775 * got reset to 1, and the initial check
1776 * data_len >= minlen + maclen + 1
1777 * guarantees that at this point we still
1778 * have at least data_len >= maclen.
1779 *
1780 * If the initial value of padlen was such that
1781 * data_len >= maclen + padlen + 1, then we have
1782 * subtracted either padlen + 1 (if the padding was correct)
1783 * or 0 (if the padding was incorrect) since then,
1784 * hence data_len >= maclen in any case.
1785 */
1786 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1788 transform->tls_version,
1789 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001790
TRodziewicz0f82ec62021-05-12 17:49:18 +02001791#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001792 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 * The next two sizes are the minimum and maximum values of
1794 * data_len over all padlen values.
1795 *
1796 * They're independent of padlen, since we previously did
1797 * data_len -= padlen.
1798 *
1799 * Note that max_len + maclen is never more than the buffer
1800 * length, as we previously did in_msglen -= maclen too.
1801 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001802 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001804
Neil Armstronge8589962022-02-25 15:14:29 +01001805#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1807 transform->psa_mac_alg,
1808 add_data, add_data_len,
1809 data, rec->data_len, min_len, max_len,
1810 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01001811#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
1813 add_data, add_data_len,
1814 data, rec->data_len, min_len, max_len,
1815 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01001816#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 if (ret != 0) {
1818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001819 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001820 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001821
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 mbedtls_ct_memcpy_offset(mac_peer, data,
1823 rec->data_len,
1824 min_len, max_len,
1825 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001826#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001827
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001828#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1830 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001831#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1834 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001837#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001838 correct = 0;
1839 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001840 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001841
Gilles Peskine449bd832023-01-11 14:50:10 +01001842hmac_failed_etm_disabled:
1843 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1844 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1845 if (ret != 0) {
1846 return ret;
1847 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001848 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001849
1850 /*
1851 * Finally check the correct flag
1852 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (correct == 0) {
1854 return MBEDTLS_ERR_SSL_INVALID_MAC;
1855 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001856#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001857
1858 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 if (auth_done != 1) {
1860 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1861 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001862 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001863
Ronald Cron6f135e12021-12-08 16:57:54 +01001864#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001866 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1868 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (ret != 0) {
1871 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1872 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001873 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001874#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001875
Hanno Beckera0e20d02019-05-15 14:03:01 +01001876#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 if (rec->cid_len != 0) {
1878 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1879 &rec->type);
1880 if (ret != 0) {
1881 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1882 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001883 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001884#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001887
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001889}
1890
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001891#undef MAC_NONE
1892#undef MAC_PLAINTEXT
1893#undef MAC_CIPHERTEXT
1894
Paul Bakker5121ce52009-01-03 21:22:43 +00001895/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001896 * Fill the input message buffer by appending data to it.
1897 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001898 *
1899 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1900 * available (from this read and/or a previous one). Otherwise, an error code
1901 * is returned (possibly EOF or WANT_READ).
1902 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001903 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1904 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1905 * since we always read a whole datagram at once.
1906 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001907 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001908 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001910int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001911{
Janos Follath865b3eb2019-12-16 11:46:15 +00001912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001913 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001914#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1915 size_t in_buf_len = ssl->in_buf_len;
1916#else
1917 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1918#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1923 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1924 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001925 }
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1928 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1929 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001930 }
1931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001934 uint32_t timeout;
1935
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001936 /*
1937 * The point is, we need to always read a full datagram at once, so we
1938 * sometimes read more then requested, and handle the additional data.
1939 * It could be the rest of the current record (while fetching the
1940 * header) and/or some other records in the same datagram.
1941 */
1942
1943 /*
1944 * Move to the next record in the already read datagram if applicable
1945 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (ssl->next_record_offset != 0) {
1947 if (ssl->in_left < ssl->next_record_offset) {
1948 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1949 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001950 }
1951
1952 ssl->in_left -= ssl->next_record_offset;
1953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (ssl->in_left != 0) {
1955 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1956 MBEDTLS_PRINTF_SIZET,
1957 ssl->next_record_offset));
1958 memmove(ssl->in_hdr,
1959 ssl->in_hdr + ssl->next_record_offset,
1960 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001961 }
1962
1963 ssl->next_record_offset = 0;
1964 }
1965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1967 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1968 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001969
1970 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001971 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (nb_want <= ssl->in_left) {
1974 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1975 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001976 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001977
1978 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001979 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001980 * are not at the beginning of a new record, the caller did something
1981 * wrong.
1982 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 if (ssl->in_left != 0) {
1984 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1985 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001986 }
1987
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001988 /*
1989 * Don't even try to read if time's out already.
1990 * This avoids by-passing the timer when repeatedly receiving messages
1991 * that will end up being dropped.
1992 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 if (mbedtls_ssl_check_timer(ssl) != 0) {
1994 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001995 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 } else {
1997 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002000 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002002 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 if (ssl->f_recv_timeout != NULL) {
2008 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2009 timeout);
2010 } else {
2011 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2012 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (ret == 0) {
2017 return MBEDTLS_ERR_SSL_CONN_EOF;
2018 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002019 }
2020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2022 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2023 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2026 if (ssl_double_retransmit_timeout(ssl) != 0) {
2027 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2028 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002029 }
2030
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2032 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2033 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002034 }
2035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002037 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2040 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2041 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2042 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2043 ret);
2044 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002045 }
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002048 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ret < 0) {
2053 return ret;
2054 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002055
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002056 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002058#endif
2059 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2061 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2062 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002065 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002068 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 } else {
2070 if (ssl->f_recv_timeout != NULL) {
2071 ret = ssl->f_recv_timeout(ssl->p_bio,
2072 ssl->in_hdr + ssl->in_left, len,
2073 ssl->conf->read_timeout);
2074 } else {
2075 ret = ssl->f_recv(ssl->p_bio,
2076 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002077 }
2078 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2081 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2082 ssl->in_left, nb_want));
2083 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (ret == 0) {
2086 return MBEDTLS_ERR_SSL_CONN_EOF;
2087 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 if (ret < 0) {
2090 return ret;
2091 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002092
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002093 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 MBEDTLS_SSL_DEBUG_MSG(1,
2095 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2096 " were requested",
2097 ret, len));
2098 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002099 }
2100
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002101 ssl->in_left += ret;
2102 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 }
2104
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002106
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002108}
2109
2110/*
2111 * Flush any data not yet written
2112 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002114{
Janos Follath865b3eb2019-12-16 11:46:15 +00002115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002116 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (ssl->f_send == NULL) {
2121 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002123 }
2124
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002125 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (ssl->out_left == 0) {
2127 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2128 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002129 }
2130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 while (ssl->out_left > 0) {
2132 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2133 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2134 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002135
Hanno Becker2b1e3542018-08-06 11:19:13 +01002136 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 if (ret <= 0) {
2142 return ret;
2143 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002144
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002145 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 MBEDTLS_SSL_DEBUG_MSG(1,
2147 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2148 " bytes were sent",
2149 ret, ssl->out_left));
2150 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002151 }
2152
Paul Bakker5121ce52009-01-03 21:22:43 +00002153 ssl->out_left -= ret;
2154 }
2155
Hanno Becker2b1e3542018-08-06 11:19:13 +01002156#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002158 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002160#endif
2161 {
2162 ssl->out_hdr = ssl->out_buf + 8;
2163 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002169}
2170
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171/*
2172 * Functions to handle the DTLS retransmission state machine
2173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002175/*
2176 * Append current handshake message to current outgoing flight
2177 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002179static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002180{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2183 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2184 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002185
2186 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2188 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2189 sizeof(mbedtls_ssl_flight_item)));
2190 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191 }
2192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2194 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2195 ssl->out_msglen));
2196 mbedtls_free(msg);
2197 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002198 }
2199
2200 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002202 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002203 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002204 msg->next = NULL;
2205
2206 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002208 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002212 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002214 cur->next = msg;
2215 }
2216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2218 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002219}
2220
2221/*
2222 * Free the current flight of handshake messages
2223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002225{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226 mbedtls_ssl_flight_item *cur = flight;
2227 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002230 next = cur->next;
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 mbedtls_free(cur->p);
2233 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002234
2235 cur = next;
2236 }
2237}
2238
2239/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002240 * Swap transform_out and out_ctr with the alternative ones
2241 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002243static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002244{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002246 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2249 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2250 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002251 }
2252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002255 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002256 tmp_transform = ssl->transform_out;
2257 ssl->transform_out = ssl->handshake->alt_transform_out;
2258 ssl->handshake->alt_transform_out = tmp_transform;
2259
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002260 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2262 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2263 sizeof(ssl->cur_out_ctr));
2264 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2265 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002266
2267 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002271}
2272
2273/*
2274 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002276int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002277{
2278 int ret = 0;
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002287}
2288
2289/*
2290 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002291 *
2292 * Need to remember the current message in case flush_output returns
2293 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002294 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002295 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002296int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002297{
Janos Follath865b3eb2019-12-16 11:46:15 +00002298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2302 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002303
2304 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002305 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 ret = ssl_swap_epochs(ssl);
2307 if (ret != 0) {
2308 return ret;
2309 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002311 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002312 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002315 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002316 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317
Hanno Beckere1dcb032018-08-17 16:47:58 +01002318 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2320 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002321
Ronald Cron00d012f22022-03-08 15:57:12 +01002322 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002324
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002325 /* Swap epochs before sending Finished: we can't do it after
2326 * sending ChangeCipherSpec, in case write returns WANT_READ.
2327 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2329 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2330 ret = ssl_swap_epochs(ssl);
2331 if (ret != 0) {
2332 return ret;
2333 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002334 }
2335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 ret = ssl_get_remaining_payload_in_datagram(ssl);
2337 if (ret < 0) {
2338 return ret;
2339 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002340 max_frag_len = (size_t) ret;
2341
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002342 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2344 if (max_frag_len == 0) {
2345 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2346 return ret;
2347 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002348
2349 continue;
2350 }
2351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002353 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002354 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002355
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002356 /* Update position inside current message */
2357 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002359 const unsigned char * const p = ssl->handshake->cur_msg_p;
2360 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002362 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002363 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2366 if (is_finished) {
2367 ret = ssl_swap_epochs(ssl);
2368 if (ret != 0) {
2369 return ret;
2370 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002371 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2374 return ret;
2375 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002376
2377 continue;
2378 }
2379 max_hs_frag_len = max_frag_len - 12;
2380
2381 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2385 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2386 (unsigned) cur_hs_frag_len,
2387 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002388 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002389
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002390 /* Messages are stored with handshake headers as if not fragmented,
2391 * copy beginning of headers then fill fragmentation fields.
2392 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2396 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2397 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2400 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2401 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002404
Hanno Becker3f7b9732018-08-28 09:53:25 +01002405 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002407 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002408 ssl->out_msgtype = cur->type;
2409
2410 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002411 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002412 }
2413
2414 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2416 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002417 ssl->handshake->cur_msg = cur->next;
2418 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002420 ssl->handshake->cur_msg = NULL;
2421 ssl->handshake->cur_msg_p = NULL;
2422 }
2423 }
2424
2425 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2427 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2428 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002429 }
2430 }
2431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2433 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002434 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 /* Update state and set timer */
2437 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2438 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2439 } else {
2440 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2441 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2442 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2445
2446 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002447}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002448
2449/*
2450 * To be called when the last message of an incoming flight is received.
2451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002453{
2454 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002456 ssl->handshake->flight = NULL;
2457 ssl->handshake->cur_msg = NULL;
2458
2459 /* The next incoming flight will start with this msg_seq */
2460 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2461
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002462 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002463 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002464
Hanno Becker0271f962018-08-16 13:23:47 +01002465 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002467
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002468 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002470
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2472 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002477}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002478
2479/*
2480 * To be called when the last message of an outgoing flight is send.
2481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002482void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002483{
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 ssl_reset_retransmit_timeout(ssl);
2485 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2488 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002493}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002495
Paul Bakker5121ce52009-01-03 21:22:43 +00002496/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002497 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2500 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002501{
2502 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002503 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002504 * ...
2505 * HandshakeType msg_type;
2506 * uint24 length;
2507 * ...
2508 */
2509 *buf = ssl->out_msg + 4;
2510 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2511
2512 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2513 ssl->out_msg[0] = hs_type;
2514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002516}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002517
2518/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520 *
2521 * - fill in handshake headers
2522 * - update handshake checksum
2523 * - DTLS: save message for resending
2524 * - then pass to the record layer
2525 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002526 * DTLS: except for HelloRequest, messages are only queued, and will only be
2527 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002528 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002529 * Inputs:
2530 * - ssl->out_msglen: 4 + actual handshake message len
2531 * (4 is the size of handshake headers for TLS)
2532 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2533 * - ssl->out_msg + 4: the handshake message body
2534 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002535 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002536 * - ssl->out_msglen: the length of the record contents
2537 * (including handshake headers but excluding record headers)
2538 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002539 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2541 int update_checksum,
2542 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002543{
Janos Follath865b3eb2019-12-16 11:46:15 +00002544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002545 const size_t hs_len = ssl->out_msglen - 4;
2546 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002549
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002550 /*
2551 * Sanity checks
2552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2554 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2555 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2556 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002557 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002558
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002559 /* Whenever we send anything different from a
2560 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2562 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2563 ssl->handshake == NULL) {
2564 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2565 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002566 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002570 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2572 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2573 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002574 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002575#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002576
Hanno Beckerb50a2532018-08-06 11:52:54 +01002577 /* Double-check that we did not exceed the bounds
2578 * of the outgoing record buffer.
2579 * This should never fail as the various message
2580 * writing functions must obey the bounds of the
2581 * outgoing record buffer, but better be safe.
2582 *
2583 * Note: We deliberately do not check for the MTU or MFL here.
2584 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2586 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2587 "size %" MBEDTLS_PRINTF_SIZET
2588 ", maximum %" MBEDTLS_PRINTF_SIZET,
2589 ssl->out_msglen,
2590 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2591 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002592 }
2593
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002594 /*
2595 * Fill handshake headers
2596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2598 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2599 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2600 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002601
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002602 /*
2603 * DTLS has additional fields in the Handshake layer,
2604 * between the length field and the actual payload:
2605 * uint16 message_seq;
2606 * uint24 fragment_offset;
2607 * uint24 fragment_length;
2608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002611 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2613 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2614 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2615 MBEDTLS_PRINTF_SIZET,
2616 hs_len,
2617 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2618 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002619 }
2620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002622 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002623
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002624 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2626 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2627 ++(ssl->handshake->out_msg_seq);
2628 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002629 ssl->out_msg[4] = 0;
2630 ssl->out_msg[5] = 0;
2631 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002632
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002633 /* Handshake hashes are computed without fragmentation,
2634 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 memset(ssl->out_msg + 6, 0x00, 3);
2636 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002637 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002639
Hanno Becker0207e532018-08-28 10:28:28 +01002640 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002642 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2643 ssl->out_msglen);
2644 if (ret != 0) {
2645 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2646 return ret;
2647 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002649 }
2650
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002651 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2654 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2655 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2656 if ((ret = ssl_flight_append(ssl)) != 0) {
2657 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2658 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002659 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002661#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002662 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2664 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2665 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002666 }
2667 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002672}
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2675 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002676{
2677 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2678 size_t msg_with_header_len;
2679 ((void) buf_len);
2680
2681 /* Add reserved 4 bytes for handshake header */
2682 msg_with_header_len = msg_len + 4;
2683 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002685
2686cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002688}
2689
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002690/*
2691 * Record layer functions
2692 */
2693
2694/*
2695 * Write current record.
2696 *
2697 * Uses:
2698 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2699 * - ssl->out_msglen: length of the record content (excl headers)
2700 * - ssl->out_msg: record content
2701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002702int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002703{
2704 int ret, done = 0;
2705 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002706 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002709
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002711 unsigned i;
2712 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002713#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2714 size_t out_buf_len = ssl->out_buf_len;
2715#else
2716 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2717#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002718 /* Skip writing the record content type to after the encryption,
2719 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002720 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002721#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002722 /* TLS 1.3 still uses the TLS 1.2 version identifier
2723 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002725 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002727#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2729 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002730
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2732 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002735 mbedtls_record rec;
2736
2737 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002739 rec.data_len = ssl->out_msglen;
2740 rec.data_offset = ssl->out_msg - rec.buf;
2741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2743 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002744 rec.type = ssl->out_msgtype;
2745
Hanno Beckera0e20d02019-05-15 14:03:01 +01002746#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002747 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002748 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002749#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2752 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2753 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2754 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002755 }
2756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if (rec.data_offset != 0) {
2758 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2759 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002760 }
2761
Hanno Becker6430faf2019-05-08 11:57:13 +01002762 /* Update the record content type and CID. */
2763 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002764#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2765 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002766#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002767 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002769 }
2770
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002772
2773#if defined(MBEDTLS_SSL_PROTO_DTLS)
2774 /* In case of DTLS, double-check that we don't exceed
2775 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2777 ret = ssl_get_remaining_space_in_datagram(ssl);
2778 if (ret < 0) {
2779 return ret;
2780 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002783 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002785 }
2786 }
2787#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002788
Hanno Becker6430faf2019-05-08 11:57:13 +01002789 /* Now write the potentially updated record content type. */
2790 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2793 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2794 ssl->out_hdr[0], ssl->out_hdr[1],
2795 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2798 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002799
2800 ssl->out_left += protected_record_size;
2801 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2805 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002806 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 }
2808 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002809
Gabor Mezei96ae9262022-06-28 11:45:18 +02002810 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 if (i == mbedtls_ssl_ep_len(ssl)) {
2812 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2813 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002814 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002815 }
2816
Hanno Becker67bc7c32018-08-06 11:33:50 +01002817#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2819 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002820 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 ret = ssl_get_remaining_payload_in_datagram(ssl);
2822 if (ret < 0) {
2823 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2824 ret);
2825 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002826 }
2827
2828 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002830 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 } else {
2832 MBEDTLS_SSL_DEBUG_MSG(2,
2833 ("Still %u bytes available in current datagram",
2834 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002835 }
2836 }
2837#endif /* MBEDTLS_SSL_PROTO_DTLS */
2838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 if ((flush == SSL_FORCE_FLUSH) &&
2840 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2841 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2842 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002843 }
2844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002848}
2849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002851
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002852MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002853static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002854{
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (ssl->in_msglen < ssl->in_hslen ||
2856 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2857 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2858 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002859 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002861}
Hanno Becker44650b72018-08-16 12:51:11 +01002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return (ssl->in_msg[9] << 16) |
2866 (ssl->in_msg[10] << 8) |
2867 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01002868}
2869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002871{
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return (ssl->in_msg[6] << 16) |
2873 (ssl->in_msg[7] << 8) |
2874 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01002875}
2876
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002877MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002878static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002879{
2880 uint32_t msg_len, frag_off, frag_len;
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 msg_len = ssl_get_hs_total_len(ssl);
2883 frag_off = ssl_get_hs_frag_off(ssl);
2884 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 if (frag_off > msg_len) {
2887 return -1;
2888 }
Hanno Becker44650b72018-08-16 12:51:11 +01002889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 if (frag_len > msg_len - frag_off) {
2891 return -1;
2892 }
Hanno Becker44650b72018-08-16 12:51:11 +01002893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 if (frag_len + 12 > ssl->in_msglen) {
2895 return -1;
2896 }
Hanno Becker44650b72018-08-16 12:51:11 +01002897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002899}
2900
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002901/*
2902 * Mark bits in bitmask (used for DTLS HS reassembly)
2903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002905{
2906 unsigned int start_bits, end_bits;
2907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 start_bits = 8 - (offset % 8);
2909 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002910 size_t first_byte_idx = offset / 8;
2911
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002912 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (len <= start_bits) {
2914 for (; len != 0; len--) {
2915 mask[first_byte_idx] |= 1 << (start_bits - len);
2916 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002917
2918 /* Avoid potential issues with offset or len becoming invalid */
2919 return;
2920 }
2921
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002922 offset += start_bits; /* Now offset % 8 == 0 */
2923 len -= start_bits;
2924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 for (; start_bits != 0; start_bits--) {
2926 mask[first_byte_idx] |= 1 << (start_bits - 1);
2927 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002928 }
2929
2930 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 if (end_bits != 0) {
2932 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002933
2934 len -= end_bits; /* Now len % 8 == 0 */
2935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 for (; end_bits != 0; end_bits--) {
2937 mask[last_byte_idx] |= 1 << (8 - end_bits);
2938 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002939 }
2940
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002942}
2943
2944/*
2945 * Check that bitmask is full
2946 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002947MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002948static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002949{
2950 size_t i;
2951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 for (i = 0; i < len / 8; i++) {
2953 if (mask[i] != 0xFF) {
2954 return -1;
2955 }
2956 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 for (i = 0; i < len % 8; i++) {
2959 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2960 return -1;
2961 }
2962 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002965}
2966
Hanno Becker56e205e2018-08-16 09:06:12 +01002967/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002968static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2969 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002970{
Hanno Becker56e205e2018-08-16 09:06:12 +01002971 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002972
Hanno Becker56e205e2018-08-16 09:06:12 +01002973 alloc_len = 12; /* Handshake header */
2974 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (add_bitmap) {
2977 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 }
2980 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002981}
Hanno Becker56e205e2018-08-16 09:06:12 +01002982
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002986{
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 return (ssl->in_msg[1] << 16) |
2988 (ssl->in_msg[2] << 8) |
2989 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01002990}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002993{
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2995 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2996 ssl->in_msglen));
2997 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002998 }
2999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3003 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3004 MBEDTLS_PRINTF_SIZET,
3005 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003009 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if (ssl_check_hs_header(ssl) != 0) {
3013 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3014 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003015 }
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (ssl->handshake != NULL &&
3018 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3019 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3020 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3021 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3022 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3023 MBEDTLS_SSL_DEBUG_MSG(2,
3024 (
3025 "received future handshake message of sequence number %u (next %u)",
3026 recv_msg_seq,
3027 ssl->handshake->in_msg_seq));
3028 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003029 }
3030
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003031 /* Retransmit only on last message from previous flight, to avoid
3032 * too many retransmissions.
3033 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3035 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3036 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3037 "message_seq = %u, start_of_flight = %u",
3038 recv_msg_seq,
3039 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3042 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3043 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003044 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 } else {
3046 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3047 "message_seq = %u, expected = %u",
3048 recv_msg_seq,
3049 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003050 }
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003053 }
3054 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003055
Hanno Becker6d97ef52018-08-16 13:09:04 +01003056 /* Message reassembly is handled alongside buffering of future
3057 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003058 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003059 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3061 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3062 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003063 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003066 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 if (ssl->in_msglen < ssl->in_hslen) {
3068 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3069 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003070 }
3071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003073}
3074
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003075int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003076{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003077 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003078 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003081 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3082 if (ret != 0) {
3083 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3084 return ret;
3085 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003086 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003087
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003088 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3091 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003092 unsigned offset;
3093 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003094
Hanno Becker0271f962018-08-16 13:23:47 +01003095 /* Increment handshake sequence number */
3096 hs->in_msg_seq++;
3097
3098 /*
3099 * Clear up handshake buffering and reassembly structure.
3100 */
3101
3102 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003104
3105 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003107 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003109 *hs_buf = *(hs_buf + 1);
3110 }
3111
3112 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003114 }
3115#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003116 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003117}
3118
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003119/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003120 * DTLS anti-replay: RFC 6347 4.1.2.6
3121 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003122 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3123 * Bit n is set iff record number in_window_top - n has been seen.
3124 *
3125 * Usually, in_window_top is the last record number seen and the lsb of
3126 * in_window is set. The only exception is the initial state (record number 0
3127 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003130void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003131{
3132 ssl->in_window_top = 0;
3133 ssl->in_window = 0;
3134}
3135
Gilles Peskine449bd832023-01-11 14:50:10 +01003136static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003137{
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return ((uint64_t) buf[0] << 40) |
3139 ((uint64_t) buf[1] << 32) |
3140 ((uint64_t) buf[2] << 24) |
3141 ((uint64_t) buf[3] << 16) |
3142 ((uint64_t) buf[4] << 8) |
3143 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003144}
3145
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003146MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003147static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003148{
Janos Follath865b3eb2019-12-16 11:46:15 +00003149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003150 unsigned char *original_in_ctr;
3151
3152 // save original in_ctr
3153 original_in_ctr = ssl->in_ctr;
3154
3155 // use counter from record
3156 ssl->in_ctr = record_in_ctr;
3157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003159
3160 // restore the counter
3161 ssl->in_ctr = original_in_ctr;
3162
3163 return ret;
3164}
3165
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003166/*
3167 * Return 0 if sequence number is acceptable, -1 otherwise
3168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003169int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003170{
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003172 uint64_t bit;
3173
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3175 return 0;
3176 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 if (rec_seqnum > ssl->in_window_top) {
3179 return 0;
3180 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003181
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003182 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003183
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 if (bit >= 64) {
3185 return -1;
3186 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003187
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3189 return -1;
3190 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003193}
3194
3195/*
3196 * Update replay window on new validated record
3197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003198void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003199{
Gilles Peskine449bd832023-01-11 14:50:10 +01003200 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003203 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003205
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003207 /* Update window_top and the contents of the window */
3208 uint64_t shift = rec_seqnum - ssl->in_window_top;
3209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003211 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003213 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003214 ssl->in_window |= 1;
3215 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003216
3217 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003219 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003220 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003221
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003223 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003225 }
3226}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003227#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003228
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003229#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003230/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003231 * Check if a datagram looks like a ClientHello with a valid cookie,
3232 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003233 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003234 *
3235 * - if cookie is valid, return 0
3236 * - if ClientHello looks superficially valid but cookie is not,
3237 * fill obuf and set olen, then
3238 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3239 * - otherwise return a specific error code
3240 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003241MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003242MBEDTLS_STATIC_TESTABLE
3243int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 mbedtls_ssl_context *ssl,
3245 const unsigned char *cli_id, size_t cli_id_len,
3246 const unsigned char *in, size_t in_len,
3247 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003248{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003249 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003250 unsigned char *p;
3251
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003252 /*
3253 * Structure of ClientHello with record and handshake headers,
3254 * and expected values. We don't need to check a lot, more checks will be
3255 * done when actually parsing the ClientHello - skipping those checks
3256 * avoids code duplication and does not make cookie forging any easier.
3257 *
3258 * 0-0 ContentType type; copied, must be handshake
3259 * 1-2 ProtocolVersion version; copied
3260 * 3-4 uint16 epoch; copied, must be 0
3261 * 5-10 uint48 sequence_number; copied
3262 * 11-12 uint16 length; (ignored)
3263 *
3264 * 13-13 HandshakeType msg_type; (ignored)
3265 * 14-16 uint24 length; (ignored)
3266 * 17-18 uint16 message_seq; copied
3267 * 19-21 uint24 fragment_offset; copied, must be 0
3268 * 22-24 uint24 fragment_length; (ignored)
3269 *
3270 * 25-26 ProtocolVersion client_version; (ignored)
3271 * 27-58 Random random; (ignored)
3272 * 59-xx SessionID session_id; 1 byte len + sid_len content
3273 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3274 * ...
3275 *
3276 * Minimum length is 61 bytes.
3277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3279 (unsigned) in_len));
3280 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3281 if (in_len < 61) {
3282 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3283 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003284 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3287 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3290 fragment_offset != 0) {
3291 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3292 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3293 in[0], (unsigned) epoch,
3294 (unsigned) fragment_offset));
3295 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003296 }
3297
3298 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 if (59 + 1 + sid_len + 1 > in_len) {
3300 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3301 (unsigned) sid_len,
3302 (unsigned) in_len - 61));
3303 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003304 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3306 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003307
3308 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3310 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3311 (unsigned) cookie_len,
3312 (unsigned) (in_len - sid_len - 61)));
3313 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003314 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003315
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3317 in + sid_len + 61, cookie_len);
3318 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3319 in + sid_len + 61, cookie_len,
3320 cli_id, cli_id_len) == 0) {
3321 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3322 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003323 }
3324
3325 /*
3326 * If we get here, we've got an invalid cookie, let's prepare HVR.
3327 *
3328 * 0-0 ContentType type; copied
3329 * 1-2 ProtocolVersion version; copied
3330 * 3-4 uint16 epoch; copied
3331 * 5-10 uint48 sequence_number; copied
3332 * 11-12 uint16 length; olen - 13
3333 *
3334 * 13-13 HandshakeType msg_type; hello_verify_request
3335 * 14-16 uint24 length; olen - 25
3336 * 17-18 uint16 message_seq; copied
3337 * 19-21 uint24 fragment_offset; copied
3338 * 22-24 uint24 fragment_length; olen - 25
3339 *
3340 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3341 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3342 *
3343 * Minimum length is 28.
3344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003345 if (buf_len < 28) {
3346 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3347 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003348
3349 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003351 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3352 obuf[25] = 0xfe;
3353 obuf[26] = 0xff;
3354
3355 /* Generate and write actual cookie */
3356 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003357 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3358 &p, obuf + buf_len,
3359 cli_id, cli_id_len) != 0) {
3360 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003361 }
3362
3363 *olen = p - obuf;
3364
3365 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003367
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3369 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3370 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003373
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003375}
3376
3377/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003378 * Handle possible client reconnect with the same UDP quadruplet
3379 * (RFC 6347 Section 4.2.8).
3380 *
3381 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3382 * that looks like a ClientHello.
3383 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003384 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003385 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003386 * - if the input looks like a ClientHello with a valid cookie,
3387 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003388 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003389 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003390 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003391 * This function is called (through ssl_check_client_reconnect()) when an
3392 * unexpected record is found in ssl_get_next_record(), which will discard the
3393 * record if we return 0, and bubble up the return value otherwise (this
3394 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3395 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003396 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003398static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003399{
Janos Follath865b3eb2019-12-16 11:46:15 +00003400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003401 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003402
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 if (ssl->conf->f_cookie_write == NULL ||
3404 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003405 /* If we can't use cookies to verify reachability of the peer,
3406 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3408 "can't check reconnect validity"));
3409 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003410 }
3411
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003412 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 ssl,
3414 ssl->cli_id, ssl->cli_id_len,
3415 ssl->in_buf, ssl->in_left,
3416 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003421 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3423 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3424 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003425 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003426 * If the error is permanent we'll catch it later,
3427 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3429 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003430 (void) send_ret;
3431
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003433 }
3434
Gilles Peskine449bd832023-01-11 14:50:10 +01003435 if (ret == 0) {
3436 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3437 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3438 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3439 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003440 }
3441
Gilles Peskine449bd832023-01-11 14:50:10 +01003442 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003443 }
3444
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003446}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003447#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003448
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003449MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003450static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003451{
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003453 record_type != MBEDTLS_SSL_MSG_ALERT &&
3454 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3456 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003457 }
3458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003460}
3461
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003463 * ContentType type;
3464 * ProtocolVersion version;
3465 * uint16 epoch; // DTLS only
3466 * uint48 sequence_number; // DTLS only
3467 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003468 *
3469 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003470 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003471 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3472 *
3473 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003474 * 1. proceed with the record if this function returns 0
3475 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3476 * 3. return CLIENT_RECONNECT if this function return that value
3477 * 4. drop the whole datagram if this function returns anything else.
3478 * Point 2 is needed when the peer is resending, and we have already received
3479 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003480 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003482static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3483 unsigned char *buf,
3484 size_t len,
3485 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003486{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003487 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003488
Hanno Beckere5e7e782019-07-11 12:29:35 +01003489 size_t const rec_hdr_type_offset = 0;
3490 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003491
Hanno Beckere5e7e782019-07-11 12:29:35 +01003492 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3493 rec_hdr_type_len;
3494 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003495
Hanno Beckere5e7e782019-07-11 12:29:35 +01003496 size_t const rec_hdr_ctr_len = 8;
3497#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003498 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003499 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3500 rec_hdr_version_len;
3501
Hanno Beckera0e20d02019-05-15 14:03:01 +01003502#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003503 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3504 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003505 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003506#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3507#endif /* MBEDTLS_SSL_PROTO_DTLS */
3508
3509 size_t rec_hdr_len_offset; /* To be determined */
3510 size_t const rec_hdr_len_len = 2;
3511
3512 /*
3513 * Check minimum lengths for record header.
3514 */
3515
3516#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003518 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003519 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003520#endif /* MBEDTLS_SSL_PROTO_DTLS */
3521 {
3522 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3523 }
3524
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3526 MBEDTLS_SSL_DEBUG_MSG(1,
3527 (
3528 "datagram of length %u too small to hold DTLS record header of length %u",
3529 (unsigned) len,
3530 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3531 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003532 }
3533
3534 /*
3535 * Parse and validate record content type
3536 */
3537
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003539
3540 /* Check record content type */
3541#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3542 rec->cid_len = 0;
3543
Gilles Peskine449bd832023-01-11 14:50:10 +01003544 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003545 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003546 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003547 /* Shift pointers to account for record header including CID
3548 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003549 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003550 * ProtocolVersion version;
3551 * uint16 epoch;
3552 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003553 * opaque cid[cid_length]; // Additional field compared to
3554 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003555 * uint16 length;
3556 * opaque enc_content[DTLSCiphertext.length];
3557 * } DTLSCiphertext;
3558 */
3559
3560 /* So far, we only support static CID lengths
3561 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562 rec_hdr_cid_len = ssl->conf->cid_len;
3563 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003564
Gilles Peskine449bd832023-01-11 14:50:10 +01003565 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3566 MBEDTLS_SSL_DEBUG_MSG(1,
3567 (
3568 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3569 (unsigned) len,
3570 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3571 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003572 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003573
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003574 /* configured CID len is guaranteed at most 255, see
3575 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3576 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003577 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3578 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003579#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003580 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 if (ssl_check_record_type(rec->type)) {
3582 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3583 (unsigned) rec->type));
3584 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003585 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003586 }
3587
Hanno Beckere5e7e782019-07-11 12:29:35 +01003588 /*
3589 * Parse and validate record version
3590 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3592 rec->ver[1] = buf[rec_hdr_version_offset + 1];
3593 tls_version = mbedtls_ssl_read_version(buf + rec_hdr_version_offset,
3594 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003595
Gilles Peskine449bd832023-01-11 14:50:10 +01003596 if (tls_version > ssl->conf->max_tls_version) {
3597 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3598 (unsigned) tls_version,
3599 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003600
Gilles Peskine449bd832023-01-11 14:50:10 +01003601 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003602 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003603 /*
3604 * Parse/Copy record sequence number.
3605 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003606
Hanno Beckere5e7e782019-07-11 12:29:35 +01003607#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003609 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003610 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3611 rec_hdr_ctr_len);
3612 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003613#endif /* MBEDTLS_SSL_PROTO_DTLS */
3614 {
3615 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003616 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003617 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003618
Hanno Beckere5e7e782019-07-11 12:29:35 +01003619 /*
3620 * Parse record length.
3621 */
3622
Hanno Beckere5e7e782019-07-11 12:29:35 +01003623 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003624 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3625 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3626 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003627
Gilles Peskine449bd832023-01-11 14:50:10 +01003628 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3629 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3630 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003631
3632 rec->buf = buf;
3633 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003634
Gilles Peskine449bd832023-01-11 14:50:10 +01003635 if (rec->data_len == 0) {
3636 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3637 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003638
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003639 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003640 * DTLS-related tests.
3641 * Check epoch before checking length constraint because
3642 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3643 * message gets duplicated before the corresponding Finished message,
3644 * the second ChangeCipherSpec should be discarded because it belongs
3645 * to an old epoch, but not because its length is shorter than
3646 * the minimum record length for packets using the new record transform.
3647 * Note that these two kinds of failures are handled differently,
3648 * as an unexpected record is silently skipped but an invalid
3649 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003650 */
3651#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003652 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3653 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003654
Hanno Becker955a5c92019-07-10 17:12:07 +01003655 /* Check that the datagram is large enough to contain a record
3656 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003657 if (len < rec->data_offset + rec->data_len) {
3658 MBEDTLS_SSL_DEBUG_MSG(1,
3659 (
3660 "Datagram of length %u too small to contain record of advertised length %u.",
3661 (unsigned) len,
3662 (unsigned) (rec->data_offset + rec->data_len)));
3663 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003664 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003665
Hanno Becker37cfe732019-07-10 17:20:01 +01003666 /* Records from other, non-matching epochs are silently discarded.
3667 * (The case of same-port Client reconnects must be considered in
3668 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 if (rec_epoch != ssl->in_epoch) {
3670 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3671 "expected %u, received %lu",
3672 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003673
Hanno Becker552f7472019-07-19 10:59:12 +01003674 /* Records from the next epoch are considered for buffering
3675 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3677 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3678 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003679 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003680
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003682 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003683#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003684 /* For records from the correct epoch, check whether their
3685 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3687 &rec->ctr[0]) != 0) {
3688 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3689 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003690 }
3691#endif
3692 }
3693#endif /* MBEDTLS_SSL_PROTO_DTLS */
3694
Gilles Peskine449bd832023-01-11 14:50:10 +01003695 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003696}
Paul Bakker5121ce52009-01-03 21:22:43 +00003697
Paul Bakker5121ce52009-01-03 21:22:43 +00003698
Hanno Becker2fddd372019-07-10 14:37:41 +01003699#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003700MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003701static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003702{
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003704
3705 /*
3706 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3707 * access the first byte of record content (handshake type), as we
3708 * have an active transform (possibly iv_len != 0), so use the
3709 * fact that the record header len is 13 instead.
3710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003711 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003712 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003713 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003714 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3715 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003716 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3717 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3718 "from the same port"));
3719 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003720 }
3721
Gilles Peskine449bd832023-01-11 14:50:10 +01003722 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003723}
Hanno Becker2fddd372019-07-10 14:37:41 +01003724#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003725
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003726/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003727 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003728 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003729MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003730static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3731 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003732{
3733 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003734
Gilles Peskine449bd832023-01-11 14:50:10 +01003735 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3736 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003737
Ronald Cron7e38cba2021-11-24 12:43:39 +01003738 /*
3739 * In TLS 1.3, always treat ChangeCipherSpec records
3740 * as unencrypted. The only thing we do with them is
3741 * check the length and content and ignore them.
3742 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003743#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003744 if (ssl->transform_in != NULL &&
3745 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3746 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003747 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003749 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003750#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003751
Gilles Peskine449bd832023-01-11 14:50:10 +01003752 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003753 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003754
Gilles Peskine449bd832023-01-11 14:50:10 +01003755 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3756 rec)) != 0) {
3757 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003758
Hanno Beckera0e20d02019-05-15 14:03:01 +01003759#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003761 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3763 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003764 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003765 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003766#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003767
Gilles Peskine449bd832023-01-11 14:50:10 +01003768 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003769 }
3770
Gilles Peskine449bd832023-01-11 14:50:10 +01003771 if (old_msg_type != rec->type) {
3772 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3773 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003774 }
3775
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3777 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003778
Hanno Beckera0e20d02019-05-15 14:03:01 +01003779#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003780 /* We have already checked the record content type
3781 * in ssl_parse_record_header(), failing or silently
3782 * dropping the record in the case of an unknown type.
3783 *
3784 * Since with the use of CIDs, the record content type
3785 * might change during decryption, re-check the record
3786 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 if (ssl_check_record_type(rec->type)) {
3788 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3789 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003790 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003791#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003792
Gilles Peskine449bd832023-01-11 14:50:10 +01003793 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003794#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003795 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3796 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003797 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3799 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003800 }
3801#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3802
3803 ssl->nb_zero++;
3804
3805 /*
3806 * Three or more empty messages may be a DoS attack
3807 * (excessive CPU consumption).
3808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003809 if (ssl->nb_zero > 3) {
3810 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3811 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003812 /* Treat the records as if they were not properly authenticated,
3813 * thereby failing the connection if we see more than allowed
3814 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003816 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003817 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003818 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003820
3821#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003823 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003825#endif
3826 {
3827 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003828 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3829 i > mbedtls_ssl_ep_len(ssl); i--) {
3830 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003831 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003833 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003834
3835 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 if (i == mbedtls_ssl_ep_len(ssl)) {
3837 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3838 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003839 }
3840 }
3841
Paul Bakker5121ce52009-01-03 21:22:43 +00003842 }
3843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003844#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003845 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3846 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003847 }
3848#endif
3849
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003850 /* Check actual (decrypted) record content length against
3851 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
3853 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
3854 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003855 }
3856
Gilles Peskine449bd832023-01-11 14:50:10 +01003857 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003858}
3859
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003860/*
3861 * Read a record.
3862 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003863 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3864 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3865 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003866 */
Hanno Becker1097b342018-08-15 14:09:41 +01003867
3868/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003869MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003870static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003871MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003872static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003874static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01003875
Gilles Peskine449bd832023-01-11 14:50:10 +01003876int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
3877 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003878{
Janos Follath865b3eb2019-12-16 11:46:15 +00003879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003882
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003884 do {
Simon Butcher99000142016-10-13 17:21:01 +01003885
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 ret = ssl_consume_current_message(ssl);
3887 if (ret != 0) {
3888 return ret;
3889 }
Hanno Becker26994592018-08-15 14:14:59 +01003890
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01003892 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01003893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01003894
Hanno Becker40f50842018-08-15 14:48:01 +01003895 /* We only check for buffered messages if the
3896 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3898 ssl_next_record_is_in_datagram(ssl) == 0) {
3899 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01003900 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 }
Hanno Becker40f50842018-08-15 14:48:01 +01003902 }
3903
Hanno Becker40f50842018-08-15 14:48:01 +01003904#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 if (dtls_have_buffered == 0) {
3906 ret = ssl_get_next_record(ssl);
3907 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01003908 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 }
Hanno Becker40f50842018-08-15 14:48:01 +01003910
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 if (ret != 0) {
3912 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
3913 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01003914 }
Hanno Beckere74d5562018-08-15 14:26:08 +01003915 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003916 }
3917
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003919
Hanno Becker40f50842018-08-15 14:48:01 +01003920#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01003922 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 ret = ssl_buffer_message(ssl);
3924 if (ret != 0) {
3925 return ret;
3926 }
Hanno Becker40f50842018-08-15 14:48:01 +01003927
3928 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3929 }
3930#endif /* MBEDTLS_SSL_PROTO_DTLS */
3931
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
3933 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003934
Gilles Peskine449bd832023-01-11 14:50:10 +01003935 if (0 != ret) {
3936 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
3937 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01003938 }
3939
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3941 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003942 ret = mbedtls_ssl_update_handshake_status(ssl);
3943 if (0 != ret) {
3944 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
3945 return ret;
3946 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003947 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003948 } else {
3949 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01003950 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01003951 }
3952
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01003954
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003956}
3957
Hanno Becker40f50842018-08-15 14:48:01 +01003958#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003960static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003961{
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 if (ssl->in_left > ssl->next_record_offset) {
3963 return 1;
3964 }
Simon Butcher99000142016-10-13 17:21:01 +01003965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01003967}
3968
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003969MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003970static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01003971{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003972 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003974 int ret = 0;
3975
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 if (hs == NULL) {
3977 return -1;
3978 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003979
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01003981
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
3983 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003984 /* Check if we have seen a ChangeCipherSpec before.
3985 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if (!hs->buffering.seen_ccs) {
3987 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003988 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01003989 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003990 }
3991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01003993 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
3994 ssl->in_msglen = 1;
3995 ssl->in_msg[0] = 1;
3996
3997 /* As long as they are equal, the exact value doesn't matter. */
3998 ssl->in_left = 0;
3999 ssl->next_record_offset = 0;
4000
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004001 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004002 goto exit;
4003 }
Hanno Becker37f95322018-08-16 13:55:32 +01004004
Hanno Beckerb8f50142018-08-28 10:01:34 +01004005#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004006 /* Debug only */
4007 {
4008 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004009 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004010 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (hs_buf->is_valid == 1) {
4012 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4013 hs->in_msg_seq + offset,
4014 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004015 }
4016 }
4017 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004018#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004019
4020 /* Check if we have buffered and/or fully reassembled the
4021 * next handshake message. */
4022 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004024 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 size_t msg_len = (hs_buf->data[1] << 16) |
4026 (hs_buf->data[2] << 8) |
4027 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004028
4029 /* Double-check that we haven't accidentally buffered
4030 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004031 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4032 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4033 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004034 }
4035
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4037 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4038 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004039
4040 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4041 ssl->in_hslen = msg_len + 12;
4042 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004044
4045 ret = 0;
4046 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 } else {
4048 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4049 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004050 }
4051
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004052 ret = -1;
4053
4054exit:
4055
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4057 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004058}
4059
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004061static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4062 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004063{
4064 int offset;
4065 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4067 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004068
Hanno Becker01315ea2018-08-21 17:22:17 +01004069 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004071
4072 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004073 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4074 hs->buffering.total_bytes_buffered)) {
4075 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4076 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004077 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004078
Hanno Becker4f432ad2018-08-28 10:02:32 +01004079 /* We don't have enough space to buffer the next expected handshake
4080 * message. Remove buffers used for future messages to gain space,
4081 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4083 offset >= 0; offset--) {
4084 MBEDTLS_SSL_DEBUG_MSG(2,
4085 (
4086 "Free buffering slot %d to make space for reassembly of next handshake message",
4087 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004088
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004090
4091 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004092 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4093 hs->buffering.total_bytes_buffered)) {
4094 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4095 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004096 }
4097 }
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004100}
4101
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004103static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004104{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004105 int ret = 0;
4106 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (hs == NULL) {
4109 return 0;
4110 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004115 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004116 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004117
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004118 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004119 break;
4120
4121 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004122 {
4123 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004125 mbedtls_ssl_hs_buffer *hs_buf;
4126 size_t msg_len = ssl->in_hslen - 12;
4127
4128 /* We should never receive an old handshake
4129 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004130 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4131 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4132 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004133 }
4134
4135 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004137 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 MBEDTLS_SSL_DEBUG_MSG(2,
4139 ("Ignore future HS message with sequence number %u, "
4140 "buffering window %u - %u",
4141 recv_msg_seq, ssl->handshake->in_msg_seq,
4142 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4143 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004144
4145 goto exit;
4146 }
4147
Gilles Peskine449bd832023-01-11 14:50:10 +01004148 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4149 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004150
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004152
4153 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004155 size_t reassembly_buf_sz;
4156
Hanno Becker37f95322018-08-16 13:55:32 +01004157 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004159
4160 /* We copy the message back into the input buffer
4161 * after reassembly, so check that it's not too large.
4162 * This is an implementation-specific limitation
4163 * and not one from the standard, hence it is not
4164 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004166 /* Ignore message */
4167 goto exit;
4168 }
4169
Hanno Beckere0b150f2018-08-21 15:51:03 +01004170 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (hs->buffering.total_bytes_buffered >
4172 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4173 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4174 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004175 }
4176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4178 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4181 hs->buffering.total_bytes_buffered)) {
4182 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004183 /* If we can't buffer a future message because
4184 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 MBEDTLS_SSL_DEBUG_MSG(2,
4186 ("Buffering of future message of size %"
4187 MBEDTLS_PRINTF_SIZET
4188 " would exceed the compile-time limit %"
4189 MBEDTLS_PRINTF_SIZET
4190 " (already %" MBEDTLS_PRINTF_SIZET
4191 " bytes buffered) -- ignore\n",
4192 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4193 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 } else {
4196 MBEDTLS_SSL_DEBUG_MSG(2,
4197 ("Buffering of future message of size %"
4198 MBEDTLS_PRINTF_SIZET
4199 " would exceed the compile-time limit %"
4200 MBEDTLS_PRINTF_SIZET
4201 " (already %" MBEDTLS_PRINTF_SIZET
4202 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4203 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4204 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004205 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4208 MBEDTLS_SSL_DEBUG_MSG(2,
4209 ("Reassembly of next message of size %"
4210 MBEDTLS_PRINTF_SIZET
4211 " (%" MBEDTLS_PRINTF_SIZET
4212 " with bitmap) would exceed"
4213 " the compile-time limit %"
4214 MBEDTLS_PRINTF_SIZET
4215 " (already %" MBEDTLS_PRINTF_SIZET
4216 " bytes buffered) -- fail\n",
4217 msg_len,
4218 reassembly_buf_sz,
4219 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4220 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004221 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4222 goto exit;
4223 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004224 }
4225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 MBEDTLS_SSL_DEBUG_MSG(2,
4227 ("initialize reassembly, total length = %"
4228 MBEDTLS_PRINTF_SIZET,
4229 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4232 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004233 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004234 goto exit;
4235 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004236 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004237
4238 /* Prepare final header: copy msg_type, length and message_seq,
4239 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 memcpy(hs_buf->data, ssl->in_msg, 6);
4241 memset(hs_buf->data + 6, 0, 3);
4242 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004243
4244 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004245
4246 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004247 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004248 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4250 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004251 /* Ignore */
4252 goto exit;
4253 }
4254 }
4255
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004257 size_t frag_len, frag_off;
4258 unsigned char * const msg = hs_buf->data + 12;
4259
4260 /*
4261 * Check and copy current fragment
4262 */
4263
4264 /* Validation of header fields already done in
4265 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 frag_off = ssl_get_hs_frag_off(ssl);
4267 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004268
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4270 ", length = %" MBEDTLS_PRINTF_SIZET,
4271 frag_off, frag_len));
4272 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004275 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 ssl_bitmask_set(bitmask, frag_off, frag_len);
4277 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4278 msg_len) == 0);
4279 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004280 hs_buf->is_complete = 1;
4281 }
4282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4284 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004285 }
4286
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004287 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004288 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004289
4290 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004291 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004292 break;
4293 }
4294
4295exit:
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4298 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004299}
4300#endif /* MBEDTLS_SSL_PROTO_DTLS */
4301
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004302MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004303static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004304{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004305 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004306 * Consume last content-layer message and potentially
4307 * update in_msglen which keeps track of the contents'
4308 * consumption state.
4309 *
4310 * (1) Handshake messages:
4311 * Remove last handshake message, move content
4312 * and adapt in_msglen.
4313 *
4314 * (2) Alert messages:
4315 * Consume whole record content, in_msglen = 0.
4316 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004317 * (3) Change cipher spec:
4318 * Consume whole record content, in_msglen = 0.
4319 *
4320 * (4) Application data:
4321 * Don't do anything - the record layer provides
4322 * the application data as a stream transport
4323 * and consumes through mbedtls_ssl_read only.
4324 *
4325 */
4326
4327 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004329 /* Hard assertion to be sure that no application data
4330 * is in flight, as corrupting ssl->in_msglen during
4331 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (ssl->in_offt != NULL) {
4333 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4334 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004335 }
4336
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004337 /*
4338 * Get next Handshake message in the current record
4339 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004340
Hanno Becker4a810fb2017-05-24 16:27:30 +01004341 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004342 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004343 * current handshake content: If DTLS handshake
4344 * fragmentation is used, that's the fragment
4345 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004346 * size here is faulty and should be changed at
4347 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004348 * (2) While it doesn't seem to cause problems, one
4349 * has to be very careful not to assume that in_hslen
4350 * is always <= in_msglen in a sensible communication.
4351 * Again, it's wrong for DTLS handshake fragmentation.
4352 * The following check is therefore mandatory, and
4353 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004354 * Additionally, ssl->in_hslen might be arbitrarily out of
4355 * bounds after handling a DTLS message with an unexpected
4356 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004359 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4361 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4364 ssl->in_msg, ssl->in_msglen);
4365 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004366 ssl->in_msglen = 0;
4367 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004368
Hanno Becker4a810fb2017-05-24 16:27:30 +01004369 ssl->in_hslen = 0;
4370 }
4371 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 else if (ssl->in_offt != NULL) {
4373 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004374 }
4375 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004377 ssl->in_msglen = 0;
4378 }
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004381}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004382
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004383MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004384static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004385{
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 if (ssl->in_msglen > 0) {
4387 return 1;
4388 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004391}
4392
Hanno Becker5f066e72018-08-16 14:56:31 +01004393#if defined(MBEDTLS_SSL_PROTO_DTLS)
4394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004396{
4397 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004399 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004403 hs->buffering.total_bytes_buffered -=
4404 hs->buffering.future_record.len;
4405
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004407 hs->buffering.future_record.data = NULL;
4408 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004409}
4410
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004412static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004413{
4414 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004416 size_t rec_len;
4417 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004418#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4419 size_t in_buf_len = ssl->in_buf_len;
4420#else
4421 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4422#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4424 return 0;
4425 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 if (hs == NULL) {
4428 return 0;
4429 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004430
Hanno Becker5f066e72018-08-16 14:56:31 +01004431 rec = hs->buffering.future_record.data;
4432 rec_len = hs->buffering.future_record.len;
4433 rec_epoch = hs->buffering.future_record.epoch;
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 if (rec == NULL) {
4436 return 0;
4437 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004438
Hanno Becker4cb782d2018-08-20 11:19:05 +01004439 /* Only consider loading future records if the
4440 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4442 return 0;
4443 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004444
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (rec_epoch != ssl->in_epoch) {
4448 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004449 goto exit;
4450 }
4451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004453
4454 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4456 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4457 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004458 }
4459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004461 ssl->in_left = rec_len;
4462 ssl->next_record_offset = 0;
4463
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004465
4466exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4468 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004469}
4470
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004471MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004472static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4473 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004474{
4475 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004476
4477 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (hs == NULL) {
4479 return 0;
4480 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004481
4482 /* Only buffer handshake records (we are only interested
4483 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4485 return 0;
4486 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004487
4488 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (hs->buffering.future_record.data != NULL) {
4490 return 0;
4491 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004492
Hanno Becker01315ea2018-08-21 17:22:17 +01004493 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4495 hs->buffering.total_bytes_buffered)) {
4496 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4497 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4498 " (already %" MBEDTLS_PRINTF_SIZET
4499 " bytes buffered) -- ignore\n",
4500 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4501 hs->buffering.total_bytes_buffered));
4502 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004503 }
4504
Hanno Becker5f066e72018-08-16 14:56:31 +01004505 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4507 ssl->in_epoch + 1U));
4508 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004509
4510 /* ssl_parse_record_header() only considers records
4511 * of the next epoch as candidates for buffering. */
4512 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004513 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004514
4515 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 mbedtls_calloc(1, hs->buffering.future_record.len);
4517 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004518 /* If we run out of RAM trying to buffer a
4519 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004521 }
4522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004524
Hanno Becker519f15d2019-07-11 12:43:20 +01004525 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004527}
4528
4529#endif /* MBEDTLS_SSL_PROTO_DTLS */
4530
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004531MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004532static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004533{
Janos Follath865b3eb2019-12-16 11:46:15 +00004534 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004535 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004536
Hanno Becker5f066e72018-08-16 14:56:31 +01004537#if defined(MBEDTLS_SSL_PROTO_DTLS)
4538 /* We might have buffered a future record; if so,
4539 * and if the epoch matches now, load it.
4540 * On success, this call will set ssl->in_left to
4541 * the length of the buffered record, so that
4542 * the calls to ssl_fetch_input() below will
4543 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = ssl_load_buffered_record(ssl);
4545 if (ret != 0) {
4546 return ret;
4547 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004548#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004549
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004550 /* Ensure that we have enough space available for the default form
4551 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4552 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4554 if (ret != 0) {
4555 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4556 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004557 }
4558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4560 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004561#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4563 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4564 ret = ssl_buffer_future_record(ssl, &rec);
4565 if (ret != 0) {
4566 return ret;
4567 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004568
4569 /* Fall through to handling of unexpected records */
4570 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4571 }
4572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004574#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004575 /* Reset in pointers to default state for TLS/DTLS records,
4576 * assuming no CID and no offset between record content and
4577 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004579
Hanno Becker7ae20e02019-07-12 08:33:49 +01004580 /* Setup internal message pointers from record structure. */
4581 ssl->in_msgtype = rec.type;
4582#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4583 ssl->in_len = ssl->in_cid + rec.cid_len;
4584#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4585 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4586 ssl->in_msglen = rec.data_len;
4587
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 ret = ssl_check_client_reconnect(ssl);
4589 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4590 if (ret != 0) {
4591 return ret;
4592 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004593#endif
4594
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004595 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004596 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4599 "(header)"));
4600 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004601 /* Skip invalid record and the rest of the datagram */
4602 ssl->next_record_offset = 0;
4603 ssl->in_left = 0;
4604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4606 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004607 }
4608
4609 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4611 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004612#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004613 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004615 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004616 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004618#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004620 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004621 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (ssl->next_record_offset < ssl->in_left) {
4623 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004624 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004626#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004627 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004628 /*
4629 * Fetch record contents from underlying transport.
4630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4632 if (ret != 0) {
4633 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4634 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004635 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004636
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004637 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004638 }
4639
4640 /*
4641 * Decrypt record contents.
4642 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004647 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004649 /* Except when waiting for Finished as a bad mac here
4650 * probably means something went wrong in the handshake
4651 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4653 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004654#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4656 mbedtls_ssl_send_alert_message(ssl,
4657 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4658 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004659 }
4660#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004662 }
4663
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 if (ssl->conf->badmac_limit != 0 &&
4665 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4666 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4667 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004668 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004669
Hanno Becker4a810fb2017-05-24 16:27:30 +01004670 /* As above, invalid records cause
4671 * dismissal of the whole datagram. */
4672
4673 ssl->next_record_offset = 0;
4674 ssl->in_left = 0;
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4677 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004678 }
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 return ret;
4681 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004682#endif
4683 {
4684 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004685#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4687 mbedtls_ssl_send_alert_message(ssl,
4688 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4689 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004690 }
4691#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004693 }
4694 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004695
Hanno Becker44d89b22019-07-12 09:40:44 +01004696
4697 /* Reset in pointers to default state for TLS/DTLS records,
4698 * assuming no CID and no offset between record content and
4699 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004701#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4702 ssl->in_len = ssl->in_cid + rec.cid_len;
4703#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004704 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004705
Hanno Becker8685c822019-07-12 09:37:30 +01004706 /* The record content type may change during decryption,
4707 * so re-read it. */
4708 ssl->in_msgtype = rec.type;
4709 /* Also update the input buffer, because unfortunately
4710 * the server-side ssl_parse_client_hello() reparses the
4711 * record header when receiving a ClientHello initiating
4712 * a renegotiation. */
4713 ssl->in_hdr[0] = rec.type;
4714 ssl->in_msg = rec.buf + rec.data_offset;
4715 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004719}
4720
Gilles Peskine449bd832023-01-11 14:50:10 +01004721int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004722{
Janos Follath865b3eb2019-12-16 11:46:15 +00004723 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004724
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004725 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004726 * Handle particular types of records
4727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4729 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4730 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004731 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004732 }
4733
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4735 if (ssl->in_msglen != 1) {
4736 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4737 ssl->in_msglen));
4738 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004739 }
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (ssl->in_msg[0] != 1) {
4742 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4743 ssl->in_msg[0]));
4744 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004745 }
4746
4747#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004749 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4751 if (ssl->handshake == NULL) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4753 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004754 }
4755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4757 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004758 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004759#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004760
Ronald Cron6f135e12021-12-08 16:57:54 +01004761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004763#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 MBEDTLS_SSL_DEBUG_MSG(1,
4765 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4766 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004767#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 MBEDTLS_SSL_DEBUG_MSG(1,
4769 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
4770 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004771#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
4772 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004774 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004775
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4777 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004778 /* Note: Standard allows for more than one 2 byte alert
4779 to be packed in a single message, but Mbed TLS doesn't
4780 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4782 ssl->in_msglen));
4783 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004784 }
4785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4787 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004788
4789 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004790 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004791 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4793 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4794 ssl->in_msg[1]));
4795 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004796 }
4797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4799 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4800 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4801 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004802 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004803
4804#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4806 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4807 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004808 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004809 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004810 }
4811#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004812 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004813 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004814 }
4815
Hanno Beckerc76c6192017-06-06 10:03:17 +01004816#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004818 /* Drop unexpected ApplicationData records,
4819 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4821 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004822#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4824 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004825#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 ) {
4827 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4828 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004829 }
4830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (ssl->handshake != NULL &&
4832 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4833 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004834 }
4835 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004836#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004839}
4840
Gilles Peskine449bd832023-01-11 14:50:10 +01004841int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004842{
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 return mbedtls_ssl_send_alert_message(ssl,
4844 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4845 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004846}
4847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4849 unsigned char level,
4850 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00004851{
Janos Follath865b3eb2019-12-16 11:46:15 +00004852 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004853
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 if (ssl == NULL || ssl->conf == NULL) {
4855 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4856 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 if (ssl->out_left != 0) {
4859 return mbedtls_ssl_flush_output(ssl);
4860 }
Hanno Becker5e18f742018-08-06 11:35:16 +01004861
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
4863 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00004864
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004865 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00004866 ssl->out_msglen = 2;
4867 ssl->out_msg[0] = level;
4868 ssl->out_msg[1] = message;
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
4871 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
4872 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00004873 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00004877}
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004880{
Janos Follath865b3eb2019-12-16 11:46:15 +00004881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004885 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00004886 ssl->out_msglen = 1;
4887 ssl->out_msg[0] = 1;
4888
Paul Bakker5121ce52009-01-03 21:22:43 +00004889 ssl->state++;
4890
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4892 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4893 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004894 }
4895
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004899}
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004902{
Janos Follath865b3eb2019-12-16 11:46:15 +00004903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
4908 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
4909 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004910 }
4911
Gilles Peskine449bd832023-01-11 14:50:10 +01004912 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4913 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
4914 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4915 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
4916 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004917 }
4918
Hanno Beckere678eaa2018-08-21 14:57:46 +01004919 /* CCS records are only accepted if they have length 1 and content '1',
4920 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00004921
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004922 /*
4923 * Switch to our negotiated transform and session parameters for inbound
4924 * data.
4925 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08004927#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004928 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08004929#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004930 ssl->session_in = ssl->session_negotiate;
4931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004932#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004934#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004936#endif
4937
4938 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if (++ssl->in_epoch == 0) {
4940 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02004941 /* This is highly unlikely to happen for legitimate reasons, so
4942 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004944 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004946#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02004950
Paul Bakker5121ce52009-01-03 21:22:43 +00004951 ssl->state++;
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004956}
4957
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004958/* Once ssl->out_hdr as the address of the beginning of the
4959 * next outgoing record is set, deduce the other pointers.
4960 *
4961 * Note: For TLS, we save the implicit record sequence number
4962 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
4963 * and the caller has to make sure there's space for this.
4964 */
4965
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004966static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004968{
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004970}
4971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
4973 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004974{
4975#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004977 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004978#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08004979 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004980 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004982 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004984#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08004985 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004986#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01004987 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004989#endif
4990 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004991 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01004992#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01004993 ssl->out_cid = ssl->out_len;
4994#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004995 ssl->out_iv = ssl->out_hdr + 5;
4996 }
4997
Hanno Beckerc0eefa82020-05-28 07:17:36 +01004998 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01004999 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005000 if (transform != NULL) {
5001 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5002 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005003}
5004
5005/* Once ssl->in_hdr as the address of the beginning of the
5006 * next incoming record is set, deduce the other pointers.
5007 *
5008 * Note: For TLS, we save the implicit record sequence number
5009 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5010 * and the caller has to make sure there's space for this.
5011 */
5012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005014{
Hanno Becker79594fd2019-05-08 09:38:41 +01005015 /* This function sets the pointers to match the case
5016 * of unprotected TLS/DTLS records, with both ssl->in_iv
5017 * and ssl->in_msg pointing to the beginning of the record
5018 * content.
5019 *
5020 * When decrypting a protected record, ssl->in_msg
5021 * will be shifted to point to the beginning of the
5022 * record plaintext.
5023 */
5024
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005025#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005027 /* This sets the header pointers to match records
5028 * without CID. When we receive a record containing
5029 * a CID, the fields are shifted accordingly in
5030 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005031 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005032#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005033 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005034 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005035#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005036 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005037#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005038 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005040#endif
5041 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005042 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005043 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005044#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005045 ssl->in_cid = ssl->in_len;
5046#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005047 ssl->in_iv = ssl->in_hdr + 5;
5048 }
5049
Hanno Becker79594fd2019-05-08 09:38:41 +01005050 /* This will be adjusted at record decryption time. */
5051 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005052}
5053
Paul Bakker5121ce52009-01-03 21:22:43 +00005054/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005055 * Setup an SSL context
5056 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005059{
5060 /* Set the incoming and outgoing record pointers. */
5061#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005063 ssl->out_hdr = ssl->out_buf;
5064 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005066#endif /* MBEDTLS_SSL_PROTO_DTLS */
5067 {
Hanno Becker12078f42021-03-02 15:28:41 +00005068 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005069 ssl->out_hdr = ssl->out_buf + 8;
5070 ssl->in_hdr = ssl->in_buf + 8;
5071 }
5072
5073 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005074 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5075 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005076}
5077
Paul Bakker5121ce52009-01-03 21:22:43 +00005078/*
5079 * SSL get accessors
5080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005081size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005082{
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005084}
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005087{
5088 /*
5089 * Case A: We're currently holding back
5090 * a message for further processing.
5091 */
5092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 if (ssl->keep_current_message == 1) {
5094 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5095 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005096 }
5097
5098 /*
5099 * Case B: Further records are pending in the current datagram.
5100 */
5101
5102#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5104 ssl->in_left > ssl->next_record_offset) {
5105 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5106 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005107 }
5108#endif /* MBEDTLS_SSL_PROTO_DTLS */
5109
5110 /*
5111 * Case C: A handshake message is being processed.
5112 */
5113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5115 MBEDTLS_SSL_DEBUG_MSG(3,
5116 ("ssl_check_pending: more handshake messages within current record"));
5117 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005118 }
5119
5120 /*
5121 * Case D: An application data message is being processed
5122 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (ssl->in_offt != NULL) {
5124 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5125 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005126 }
5127
5128 /*
5129 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005130 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005131 * we implement support for multiple alerts in single records.
5132 */
5133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5135 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005136}
5137
Paul Bakker43ca69c2011-01-15 17:35:19 +00005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005140{
Hanno Becker3136ede2018-08-17 15:28:19 +01005141 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005142 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005143 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005144#if defined(MBEDTLS_USE_PSA_CRYPTO)
5145 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5146 psa_key_type_t key_type;
5147#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005150
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (transform == NULL) {
5152 return (int) out_hdr_len;
5153 }
Hanno Becker78640902018-08-13 16:35:15 +01005154
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005155
5156#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 if (transform->psa_alg == PSA_ALG_GCM ||
5158 transform->psa_alg == PSA_ALG_CCM ||
5159 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5160 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5161 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005162 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5164 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5165 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005166
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005168
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005169 /* Expansion due to the addition of the MAC. */
5170 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005171
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005172 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005173 * Theoretically up to 256 bytes, but we never use
5174 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005175 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005176
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005177 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005178 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005179#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005180 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005181#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 } else {
5183 MBEDTLS_SSL_DEBUG_MSG(1,
5184 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5185 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005186 }
5187#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005189 case MBEDTLS_MODE_GCM:
5190 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005191 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005192 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005193 transform_expansion = transform->minlen;
5194 break;
5195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005196 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005197
5198 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005200
Hanno Becker3136ede2018-08-17 15:28:19 +01005201 /* Expansion due to the addition of the MAC. */
5202 transform_expansion += transform->maclen;
5203
5204 /* Expansion due to the addition of CBC padding;
5205 * Theoretically up to 256 bytes, but we never use
5206 * more than the block size of the underlying cipher. */
5207 transform_expansion += block_size;
5208
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005209 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005210 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005211#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005212 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005213#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005214
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005215 break;
5216
5217 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5219 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005220 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005221#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005222
Hanno Beckera0e20d02019-05-15 14:03:01 +01005223#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005225 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005227#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005230}
5231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005232#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005233/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005234 * Check record counters and renegotiate if they're above the limit.
5235 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005236MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005237static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005238{
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005240 int in_ctr_cmp;
5241 int out_ctr_cmp;
5242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005244 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5246 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005247 }
5248
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5250 &ssl->conf->renego_period[ep_len],
5251 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5252 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005253 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5257 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005258 }
5259
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5261 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005262}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005263#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005264
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005265#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5266
5267#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005268MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005269static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005270{
5271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5273 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5274 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005275 }
5276
5277 ssl->keep_current_message = 1;
5278
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5280 mbedtls_ssl_handshake_set_state(ssl,
5281 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005284}
5285#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5286
Jerry Yua0446a02022-07-13 11:22:55 +08005287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005288static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005289{
5290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005292
5293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5295 int ret = ssl_tls13_check_new_session_ticket(ssl);
5296 if (ret != 0) {
5297 return ret;
5298 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005299 }
5300#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5301
5302 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005304}
5305#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5306
5307#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005308/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005309 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005310 * may only be sent for the purpose of initiating renegotiations.
5311 *
5312 * This function is introduced as a separate helper since the handling
5313 * of post-handshake handshake messages changes significantly in TLS 1.3,
5314 * and having a helper function allows to distinguish between TLS <= 1.2 and
5315 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5316 */
Jerry Yua0446a02022-07-13 11:22:55 +08005317MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005318static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005319{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005321
5322 /*
5323 * - For client-side, expect SERVER_HELLO_REQUEST.
5324 * - For server-side, expect CLIENT_HELLO.
5325 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5326 */
5327
5328#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5330 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5331 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5332 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005333
5334 /* With DTLS, drop the packet (probably from last handshake) */
5335#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5337 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005338 }
5339#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005341 }
5342#endif /* MBEDTLS_SSL_CLI_C */
5343
5344#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5346 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5347 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005348
5349 /* With DTLS, drop the packet (probably from last handshake) */
5350#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5352 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005353 }
5354#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005356 }
5357#endif /* MBEDTLS_SSL_SRV_C */
5358
5359#if defined(MBEDTLS_SSL_RENEGOTIATION)
5360 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5362 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5363 ssl->conf->allow_legacy_renegotiation ==
5364 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005365 /*
5366 * Accept renegotiation request
5367 */
5368
5369 /* DTLS clients need to know renego is server-initiated */
5370#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5372 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005373 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5374 }
5375#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 ret = mbedtls_ssl_start_renegotiation(ssl);
5377 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5378 ret != 0) {
5379 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5380 ret);
5381 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005382 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005384#endif /* MBEDTLS_SSL_RENEGOTIATION */
5385 {
5386 /*
5387 * Refuse renegotiation
5388 */
5389
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5393 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5394 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5395 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005396 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005397 }
5398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005400}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005401#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5402
5403MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005404static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005405{
5406 /* Check protocol version and dispatch accordingly. */
5407#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5409 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005410 }
5411#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5412
5413#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5415 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005416 }
5417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5418
5419 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005421}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005422
Paul Bakker48916f92012-09-16 19:57:18 +00005423/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005424 * Receive application data decrypted from the SSL layer
5425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005426int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005427{
Janos Follath865b3eb2019-12-16 11:46:15 +00005428 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005429 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005430
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if (ssl == NULL || ssl->conf == NULL) {
5432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5433 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005437#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5439 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5440 return ret;
5441 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005442
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 if (ssl->handshake != NULL &&
5444 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5445 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5446 return ret;
5447 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005448 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005449 }
5450#endif
5451
Hanno Becker4a810fb2017-05-24 16:27:30 +01005452 /*
5453 * Check if renegotiation is necessary and/or handshake is
5454 * in process. If yes, perform/continue, and fall through
5455 * if an unexpected packet is received while the client
5456 * is waiting for the ServerHello.
5457 *
5458 * (There is no equivalent to the last condition on
5459 * the server-side as it is not treated as within
5460 * a handshake while waiting for the ClientHello
5461 * after a renegotiation request.)
5462 */
5463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005464#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 ret = ssl_check_ctr_renegotiate(ssl);
5466 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5467 ret != 0) {
5468 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5469 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005470 }
5471#endif
5472
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5474 ret = mbedtls_ssl_handshake(ssl);
5475 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5476 ret != 0) {
5477 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5478 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005479 }
5480 }
5481
Hanno Beckere41158b2017-10-23 13:30:32 +01005482 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005484 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (ssl->f_get_timer != NULL &&
5486 ssl->f_get_timer(ssl->p_timer) == -1) {
5487 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005488 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5491 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5492 return 0;
5493 }
Paul Bakker831a7552011-05-18 13:32:51 +00005494
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5496 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005497 }
5498
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 if (ssl->in_msglen == 0 &&
5500 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005501 /*
5502 * OpenSSL sends empty messages to randomize the IV
5503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5505 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5506 return 0;
5507 }
Paul Bakker831a7552011-05-18 13:32:51 +00005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5510 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005511 }
5512 }
5513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5515 ret = ssl_handle_hs_message_post_handshake(ssl);
5516 if (ret != 0) {
5517 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5518 ret);
5519 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005520 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005521
Hanno Beckerf26cc722021-04-21 07:30:13 +01005522 /* At this point, we don't know whether the renegotiation triggered
5523 * by the post-handshake message has been completed or not. The cases
5524 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005525 * 1) The renegotiation is complete. In this case, no new record
5526 * has been read yet.
5527 * 2) The renegotiation is incomplete because the client received
5528 * an application data record while awaiting the ServerHello.
5529 * 3) The renegotiation is incomplete because the client received
5530 * a non-handshake, non-application data message while awaiting
5531 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005532 *
5533 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005534 * - For 1), the next iteration will read a new record and check
5535 * if it's application data.
5536 * - For 2), the loop condition isn't satisfied as application data
5537 * is present, hence continue is the same as break
5538 * - For 3), the loop condition is satisfied and read_record
5539 * will re-deliver the message that was held back by the client
5540 * when expecting the ServerHello.
5541 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005542
Hanno Becker90333da2017-10-10 11:27:13 +01005543 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005544 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005545#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5547 if (ssl->conf->renego_max_records >= 0) {
5548 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5549 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5550 "but not honored by client"));
5551 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005552 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005553 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005554 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005555#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005557 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5559 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5560 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005561 }
5562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5564 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5565 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005566 }
5567
5568 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005569
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005570 /* We're going to return something now, cancel timer,
5571 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5573 mbedtls_ssl_set_timer(ssl, 0);
5574 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005575
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005576#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005577 /* If we requested renego but received AppData, resend HelloRequest.
5578 * Do it now, after setting in_offt, to avoid taking this branch
5579 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005580#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005581 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5582 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5583 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5584 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5585 ret);
5586 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005587 }
5588 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005589#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005590#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005591 }
5592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005594 ? len : ssl->in_msglen;
5595
Ashley Duncan358f94a2022-02-11 09:57:18 +13005596 if (buf) {
5597 memcpy(buf, ssl->in_offt, n);
5598 ssl->in_msglen -= n;
5599 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005600
gabor-mezei-arma3214132020-07-15 10:55:00 +02005601 /* Zeroising the plaintext buffer to erase unused application data
5602 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005604
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005606 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005607 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005608 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005610 /* more data available */
5611 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005612 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005613
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005615
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005617}
5618
5619/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005620 * Send application data to be encrypted by the SSL layer, taking care of max
5621 * fragment length and buffer size.
5622 *
5623 * According to RFC 5246 Section 6.2.1:
5624 *
5625 * Zero-length fragments of Application data MAY be sent as they are
5626 * potentially useful as a traffic analysis countermeasure.
5627 *
5628 * Therefore, it is possible that the input message length is 0 and the
5629 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005630 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005632static int ssl_write_real(mbedtls_ssl_context *ssl,
5633 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005634{
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005636 const size_t max_len = (size_t) ret;
5637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (ret < 0) {
5639 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5640 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005641 }
5642
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005644#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5646 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5647 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5648 " > %" MBEDTLS_PRINTF_SIZET,
5649 len, max_len));
5650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5651 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005652#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005654 }
Paul Bakker887bd502011-06-08 13:10:54 +00005655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005657 /*
5658 * The user has previously tried to send the data and
5659 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5660 * written. In this case, we expect the high-level write function
5661 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5662 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5664 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5665 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005666 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005668 /*
5669 * The user is trying to send a message the first time, so we need to
5670 * copy the data into the internal buffers and setup the data structure
5671 * to keep track of partial writes
5672 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005673 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005674 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 memcpy(ssl->out_msg, buf, len);
Paul Bakker887bd502011-06-08 13:10:54 +00005676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5678 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5679 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005680 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005681 }
5682
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005684}
5685
5686/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005687 * Write application data (public-facing wrapper)
5688 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005689int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005690{
Janos Follath865b3eb2019-12-16 11:46:15 +00005691 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005692
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (ssl == NULL || ssl->conf == NULL) {
5696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5697 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005698
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005699#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5701 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5702 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005703 }
5704#endif
5705
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5707 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5708 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5709 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005710 }
5711 }
5712
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005714
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005716
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005718}
5719
5720/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005721 * Notify the peer that the connection is being closed
5722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005723int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005724{
Janos Follath865b3eb2019-12-16 11:46:15 +00005725 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005726
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (ssl == NULL || ssl->conf == NULL) {
5728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5729 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005732
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5734 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5735 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5736 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5737 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5738 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005739 }
5740 }
5741
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005745}
5746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005748{
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005750 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005752
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005753#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 psa_destroy_key(transform->psa_key_enc);
5755 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005756#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 mbedtls_cipher_free(&transform->cipher_ctx_enc);
5758 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005759#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005760
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005761#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005762#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 psa_destroy_key(transform->psa_mac_enc);
5764 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005765#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 mbedtls_md_free(&transform->md_ctx_enc);
5767 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01005768#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00005769#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02005770
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00005772}
5773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
5775 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08005776{
Jerry Yuc7875b52021-09-05 21:05:50 +08005777 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08005779}
5780
Gilles Peskine449bd832023-01-11 14:50:10 +01005781void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
5782 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08005783{
5784 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08005786}
5787
Hanno Becker0271f962018-08-16 13:23:47 +01005788#if defined(MBEDTLS_SSL_PROTO_DTLS)
5789
Gilles Peskine449bd832023-01-11 14:50:10 +01005790void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01005791{
5792 unsigned offset;
5793 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01005796 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 }
Hanno Becker0271f962018-08-16 13:23:47 +01005798
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01005800
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
5802 ssl_buffering_free_slot(ssl, offset);
5803 }
Hanno Beckere605b192018-08-21 15:59:07 +01005804}
5805
Gilles Peskine449bd832023-01-11 14:50:10 +01005806static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
5807 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01005808{
5809 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
5810 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01005811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01005813 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 }
Hanno Beckerb309b922018-08-23 13:18:05 +01005815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01005817 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 mbedtls_platform_zeroize(hs_buf->data, hs_buf->data_len);
5819 mbedtls_free(hs_buf->data);
5820 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01005821 }
5822}
5823
5824#endif /* MBEDTLS_SSL_PROTO_DTLS */
5825
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005826/*
5827 * Convert version numbers to/from wire format
5828 * and, for DTLS, to/from TLS equivalent.
5829 *
5830 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005831 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005832 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005833 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005835void mbedtls_ssl_write_version(unsigned char version[2], int transport,
5836 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005837{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005838#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005840 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
5842 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005843#else
5844 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005845#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 MBEDTLS_PUT_UINT16_BE(tls_version, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005847}
5848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
5850 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005851{
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005853#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005855 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
5857 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01005858#else
5859 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005860#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04005861 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01005862}
5863
Jerry Yue7047812021-09-13 19:26:39 +08005864/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08005865 * Send pending fatal alert.
5866 * 0, No alert message.
5867 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
5868 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08005869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005870int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08005871{
5872 int ret;
5873
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005874 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 if (ssl->send_alert == 0) {
5876 return 0;
5877 }
Jerry Yu394ece62021-09-14 22:17:21 +08005878
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 ret = mbedtls_ssl_send_alert_message(ssl,
5880 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5881 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005882
Jerry Yu3bf1f972021-09-22 21:37:18 +08005883 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
5884 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005885 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005887 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08005888 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005889
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 if (ret != 0) {
5891 return ret;
5892 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08005893
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08005895}
5896
Jerry Yu394ece62021-09-14 22:17:21 +08005897/*
5898 * Set pending fatal alert flag.
5899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005900void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
5901 unsigned char alert_type,
5902 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08005903{
5904 ssl->send_alert = 1;
5905 ssl->alert_type = alert_type;
5906 ssl->alert_reason = alert_reason;
5907}
5908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005909#endif /* MBEDTLS_SSL_TLS_C */