blob: 731cbc8eceb3aabcc4fdcdc3e7a976a84debcb80 [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
Dave Rodgman16799db2023-11-02 19:47:20 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00007 */
8/*
Paul Bakker5121ce52009-01-03 21:22:43 +00009 * http://www.ietf.org/rfc/rfc2246.txt
10 * http://www.ietf.org/rfc/rfc4346.txt
11 */
12
Harry Ramsey0f6bc412024-10-04 10:36:54 +010013#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020015#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000016
SimonBd5800b72016-04-26 07:43:27 +010017#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010018
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000019#include "mbedtls/ssl.h"
Valerio Settib4f50762024-01-17 10:24:52 +010020#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000021#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050022#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010023#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020024#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020025#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020026
Rich Evans00ab4702015-02-06 13:43:58 +000027#include <string.h>
28
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020029#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031
Janos Follath23bdca02016-10-07 14:47:14 +010032#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000033#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020034#endif
35
Andrzej Kurek00644842023-05-30 05:45:00 -040036/* Define a local translating function to save code size by not using too many
37 * arguments in each translating place. */
38static int local_err_translation(psa_status_t status)
39{
40 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040041 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040042 psa_generic_status_to_mbedtls);
43}
44#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050045
Dave Rodgman2801f7f2023-05-09 11:00:07 +010046#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
47
Dave Rodgman2801f7f2023-05-09 11:00:07 +010048
49#if defined(PSA_WANT_ALG_SHA_384)
50#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
51#elif defined(PSA_WANT_ALG_SHA_256)
52#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
53#else /* See check_config.h */
54#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
55#endif
56
57MBEDTLS_STATIC_TESTABLE
58int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
59 psa_algorithm_t mac_alg,
60 const unsigned char *add_data,
61 size_t add_data_len,
62 const unsigned char *data,
63 size_t data_len_secret,
64 size_t min_data_len,
65 size_t max_data_len,
66 unsigned char *output)
67{
68 /*
69 * This function breaks the HMAC abstraction and uses psa_hash_clone()
70 * extension in order to get constant-flow behaviour.
71 *
72 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
73 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
74 * patterns (see RFC 2104, sec. 2).
75 *
76 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
77 * hashing up to minlen, then cloning the context, and for each byte up
78 * to maxlen finishing up the hash computation, keeping only the
79 * correct result.
80 *
81 * Then we only need to compute HASH(okey + inner_hash) and we're done.
82 */
83 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
84 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
85 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
86 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
87 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
88 size_t hash_length;
89
90 unsigned char aux_out[PSA_HASH_MAX_SIZE];
91 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
92 size_t offset;
93 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
94
95 size_t mac_key_length;
96 size_t i;
97
98#define PSA_CHK(func_call) \
99 do { \
100 status = (func_call); \
101 if (status != PSA_SUCCESS) \
102 goto cleanup; \
103 } while (0)
104
105 /* Export MAC key
106 * We assume key length is always exactly the output size
107 * which is never more than the block size, thus we use block_size
108 * as the key buffer size.
109 */
110 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
111
112 /* Calculate ikey */
113 for (i = 0; i < mac_key_length; i++) {
114 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
115 }
116 for (; i < block_size; ++i) {
117 key_buf[i] = 0x36;
118 }
119
120 PSA_CHK(psa_hash_setup(&operation, hash_alg));
121
122 /* Now compute inner_hash = HASH(ikey + msg) */
123 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
124 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
125 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
126
127 /* Fill the hash buffer in advance with something that is
128 * not a valid hash (barring an attack on the hash and
129 * deliberately-crafted input), in case the caller doesn't
130 * check the return status properly. */
131 memset(output, '!', hash_size);
132
133 /* For each possible length, compute the hash up to that point */
134 for (offset = min_data_len; offset <= max_data_len; offset++) {
135 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
136 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
137 PSA_HASH_MAX_SIZE, &hash_length));
138 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100139 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100140 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100141
142 if (offset < max_data_len) {
143 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
144 }
145 }
146
147 /* Abort current operation to prepare for final operation */
148 PSA_CHK(psa_hash_abort(&operation));
149
150 /* Calculate okey */
151 for (i = 0; i < mac_key_length; i++) {
152 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
153 }
154 for (; i < block_size; ++i) {
155 key_buf[i] = 0x5C;
156 }
157
158 /* Now compute HASH(okey + inner_hash) */
159 PSA_CHK(psa_hash_setup(&operation, hash_alg));
160 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
161 PSA_CHK(psa_hash_update(&operation, output, hash_size));
162 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
163
164#undef PSA_CHK
165
166cleanup:
167 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
168 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
169
170 psa_hash_abort(&operation);
171 psa_hash_abort(&aux_operation);
172 return PSA_TO_MBEDTLS_ERR(status);
173}
174
175#undef MAX_HASH_BLOCK_LENGTH
176
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100177
178#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100181
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200182/*
183 * Start a timer.
184 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200185 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100186void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200187{
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200189 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200191
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
193 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200194}
195
196/*
197 * Return -1 is timer is expired, 0 if it isn't.
198 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100199int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200200{
Gilles Peskine449bd832023-01-11 14:50:10 +0100201 if (ssl->f_get_timer == NULL) {
202 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200203 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 if (ssl->f_get_timer(ssl->p_timer) == 2) {
206 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
207 return -1;
208 }
209
210 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200211}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200212
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100214static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
215 unsigned char *buf,
216 size_t len,
217 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200218
Gilles Peskine449bd832023-01-11 14:50:10 +0100219int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
220 unsigned char *buf,
221 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200222{
223 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100224 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
225 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200226
227 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200228 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200229 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200231 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
232 goto exit;
233 }
234#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200236 mbedtls_record rec;
237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
239 if (ret != 0) {
240 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200241 goto exit;
242 }
243
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (ssl->transform_in != NULL) {
245 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
246 if (ret != 0) {
247 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200248 goto exit;
249 }
250 }
251 }
252#endif /* MBEDTLS_SSL_PROTO_DTLS */
253
254exit:
255 /* On success, we have decrypted the buffer in-place, so make
256 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200258
259 /* For the purpose of this API, treat messages with unexpected CID
260 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
262 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200263 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
264 }
265
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
267 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200268}
269
Hanno Becker67bc7c32018-08-06 11:33:50 +0100270#define SSL_DONT_FORCE_FLUSH 0
271#define SSL_FORCE_FLUSH 1
272
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200273#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100274
Hanno Beckerd5847772018-08-28 10:09:23 +0100275/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100276static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
277 uint8_t slot);
278static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200279MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100280static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100282static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200283MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100284static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100286static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
287 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100289static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100292{
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000294#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
295 size_t out_buf_len = ssl->out_buf_len;
296#else
297 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
298#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (mtu != 0 && mtu < out_buf_len) {
301 return mtu;
302 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100305}
306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100308static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100309{
Hanno Becker11682cc2018-08-22 14:41:02 +0100310 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100312
313 /* Double-check that the write-index hasn't gone
314 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100316 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100318 }
319
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100321}
322
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100324static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100325{
Janos Follath865b3eb2019-12-16 11:46:15 +0000326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100327 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400328 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100329
330#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100332
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100334 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100336
337 /* By the standard (RFC 6066 Sect. 4), the MFL extension
338 * only limits the maximum record payload size, so in theory
339 * we would be allowed to pack multiple records of payload size
340 * MFL into a single datagram. However, this would mean that there's
341 * no way to explicitly communicate MTU restrictions to the peer.
342 *
343 * The following reduction of max_len makes sure that we never
344 * write datagrams larger than MFL + Record Expansion Overhead.
345 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 if (max_len <= ssl->out_left) {
347 return 0;
348 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100349
350 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100351#endif
352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 ret = ssl_get_remaining_space_in_datagram(ssl);
354 if (ret < 0) {
355 return ret;
356 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100357 remaining = (size_t) ret;
358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 ret = mbedtls_ssl_get_record_expansion(ssl);
360 if (ret < 0) {
361 return ret;
362 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100363 expansion = (size_t) ret;
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (remaining <= expansion) {
366 return 0;
367 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100368
369 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100371 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100373
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100375}
376
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200377/*
378 * Double the retransmit timeout value, within the allowed range,
379 * returning -1 if the maximum value has already been reached.
380 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200381MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100382static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200383{
384 uint32_t new_timeout;
385
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
387 return -1;
388 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200389
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200390 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
391 * in the following way: after the initial transmission and a first
392 * retransmission, back off to a temporary estimated MTU of 508 bytes.
393 * This value is guaranteed to be deliverable (if not guaranteed to be
394 * delivered) of any compliant IPv4 (and IPv6) network, and should work
395 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200397 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400399 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200400
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200401 new_timeout = 2 * ssl->handshake->retransmit_timeout;
402
403 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 if (new_timeout < ssl->handshake->retransmit_timeout ||
405 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200406 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200407 }
408
409 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
411 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200412
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200414}
415
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200417{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200418 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
420 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200421}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200423
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100424/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000425 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200426 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000427
Ronald Cron6f135e12021-12-08 16:57:54 +0100428#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static size_t ssl_compute_padding_length(size_t len,
431 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100432{
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100434}
435
Hanno Becker581bc1b2020-05-04 12:20:03 +0100436/* This functions transforms a (D)TLS plaintext fragment and a record content
437 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
438 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
439 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100440 *
441 * struct {
442 * opaque content[DTLSPlaintext.length];
443 * ContentType real_type;
444 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100445 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100446 *
447 * Input:
448 * - `content`: The beginning of the buffer holding the
449 * plaintext to be wrapped.
450 * - `*content_size`: The length of the plaintext in Bytes.
451 * - `max_len`: The number of Bytes available starting from
452 * `content`. This must be `>= *content_size`.
453 * - `rec_type`: The desired record content type.
454 *
455 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100456 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
457 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100458 *
459 * Returns:
460 * - `0` on success.
461 * - A negative error code if `max_len` didn't offer enough space
462 * for the expansion.
463 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100465static int ssl_build_inner_plaintext(unsigned char *content,
466 size_t *content_size,
467 size_t remaining,
468 uint8_t rec_type,
469 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100470{
471 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100472
473 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 if (remaining == 0) {
475 return -1;
476 }
477 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100478 len++;
479 remaining--;
480
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (remaining < pad) {
482 return -1;
483 }
484 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100485 len += pad;
486 remaining -= pad;
487
488 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100490}
491
Hanno Becker581bc1b2020-05-04 12:20:03 +0100492/* This function parses a (D)TLSInnerPlaintext structure.
493 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200494MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static int ssl_parse_inner_plaintext(unsigned char const *content,
496 size_t *content_size,
497 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100498{
499 size_t remaining = *content_size;
500
501 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 do {
503 if (remaining == 0) {
504 return -1;
505 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100506 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100508
509 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100513}
Ronald Cron6f135e12021-12-08 16:57:54 +0100514#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100515
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200516/* The size of the `add_data` structure depends on various
517 * factors, namely
518 *
519 * 1) CID functionality disabled
520 *
521 * additional_data =
522 * 8: seq_num +
523 * 1: type +
524 * 2: version +
525 * 2: length of inner plaintext +
526 *
527 * size = 13 bytes
528 *
529 * 2) CID functionality based on RFC 9146 enabled
530 *
531 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
532 * = 23 + CID-length
533 *
534 * 3) CID functionality based on legacy CID version
535 according to draft-ietf-tls-dtls-connection-id-05
536 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
537 *
538 * size = 13 + 1 + CID-length
539 *
540 * More information about the CID usage:
541 *
542 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
543 * size of the additional data structure is calculated as:
544 *
545 * additional_data =
546 * 8: seq_num +
547 * 1: tls12_cid +
548 * 2: DTLSCipherText.version +
549 * n: cid +
550 * 1: cid_length +
551 * 2: length_of_DTLSInnerPlaintext
552 *
553 * Per RFC 9146 the size of the add_data structure is calculated as:
554 *
555 * additional_data =
556 * 8: seq_num_placeholder +
557 * 1: tls12_cid +
558 * 1: cid_length +
559 * 1: tls12_cid +
560 * 2: DTLSCiphertext.version +
561 * 2: epoch +
562 * 6: sequence_number +
563 * n: cid +
564 * 2: length_of_DTLSInnerPlaintext
565 *
566 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100567static void ssl_extract_add_data_from_record(unsigned char *add_data,
568 size_t *add_data_len,
569 mbedtls_record *rec,
570 mbedtls_ssl_protocol_version
571 tls_version,
572 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000573{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200574 /* Several types of ciphers have been defined for use with TLS and DTLS,
575 * and the MAC calculations for those ciphers differ slightly. Further
576 * variants were added when the CID functionality was added with RFC 9146.
577 * This implementations also considers the use of a legacy version of the
578 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
579 * which is used in deployments.
580 *
581 * We will distinguish between the non-CID and the CID cases below.
582 *
583 * --- Non-CID cases ---
584 *
585 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100586 *
587 * additional_data = seq_num + TLSCompressed.type +
588 * TLSCompressed.version + TLSCompressed.length;
589 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100590 * For TLS 1.3, the record sequence number is dropped from the AAD
591 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000592 * Moreover, the additional data involves the length of the TLS
593 * ciphertext, not the TLS plaintext as in earlier versions.
594 * Quoting RFC 8446 (TLS 1.3):
595 *
596 * additional_data = TLSCiphertext.opaque_type ||
597 * TLSCiphertext.legacy_record_version ||
598 * TLSCiphertext.length
599 *
600 * We pass the tag length to this function in order to compute the
601 * ciphertext length from the inner plaintext length rec->data_len via
602 *
603 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
604 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200605 * --- CID cases ---
606 *
607 * RFC 9146 uses a common pattern when constructing the data
608 * passed into a MAC / AEAD cipher.
609 *
610 * Data concatenation for MACs used with block ciphers with
611 * Encrypt-then-MAC Processing (with CID):
612 *
613 * data = seq_num_placeholder +
614 * tls12_cid +
615 * cid_length +
616 * tls12_cid +
617 * DTLSCiphertext.version +
618 * epoch +
619 * sequence_number +
620 * cid +
621 * DTLSCiphertext.length +
622 * IV +
623 * ENC(content + padding + padding_length)
624 *
625 * Data concatenation for MACs used with block ciphers (with CID):
626 *
627 * data = seq_num_placeholder +
628 * tls12_cid +
629 * cid_length +
630 * tls12_cid +
631 * DTLSCiphertext.version +
632 * epoch +
633 * sequence_number +
634 * cid +
635 * length_of_DTLSInnerPlaintext +
636 * DTLSInnerPlaintext.content +
637 * DTLSInnerPlaintext.real_type +
638 * DTLSInnerPlaintext.zeros
639 *
640 * AEAD ciphers use the following additional data calculation (with CIDs):
641 *
642 * additional_data = seq_num_placeholder +
643 * tls12_cid +
644 * cid_length +
645 * tls12_cid +
646 * DTLSCiphertext.version +
647 * epoch +
648 * sequence_number +
649 * cid +
650 * length_of_DTLSInnerPlaintext
651 *
652 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
653 * defines the additional data calculation as follows:
654 *
655 * additional_data = seq_num +
656 * tls12_cid +
657 * DTLSCipherText.version +
658 * cid +
659 * cid_length +
660 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100662
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100663 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000664 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100665
Ben Taylor4a438042025-07-11 09:47:39 +0100666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200667 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
668#endif
669
Ronald Cron6f135e12021-12-08 16:57:54 +0100670#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000672 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
673 * which differs from the length of the TLSInnerPlaintext
674 * by the length of the authentication tag. */
675 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100677#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100678 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400679 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000680 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200681
Ben Taylor4a438042025-07-11 09:47:39 +0100682#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200684 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
686 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200687
688 // tls12_cid type
689 *cur = rec->type;
690 cur++;
691
692 // cid_length
693 *cur = rec->cid_len;
694 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100696#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200697 {
698 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 memcpy(cur, rec->ctr, sizeof(rec->ctr));
700 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200701 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100702 }
703
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200704 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100705 *cur = rec->type;
706 cur++;
707
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200708 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 memcpy(cur, rec->ver, sizeof(rec->ver));
710 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100711
Ben Taylor4a438042025-07-11 09:47:39 +0100712#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200715 // epoch + sequence number
716 memcpy(cur, rec->ctr, sizeof(rec->ctr));
717 cur += sizeof(rec->ctr);
718
719 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200721 cur += rec->cid_len;
722
723 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100725 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100727#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100728 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100730 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100731 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100732
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000733 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000734}
735
Valerio Settie5707042023-10-11 11:54:42 +0200736#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200737MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100738static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100740{
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100742}
743
Hanno Becker17263802020-05-28 07:05:48 +0100744/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
745 *
746 * Concretely, this occurs in two variants:
747 *
748 * a) Fixed and dynamic IV lengths add up to total IV length, giving
749 * IV = fixed_iv || dynamic_iv
750 *
Hanno Becker15952812020-06-04 13:31:46 +0100751 * This variant is used in TLS 1.2 when used with GCM or CCM.
752 *
Hanno Becker17263802020-05-28 07:05:48 +0100753 * b) Fixed IV lengths matches total IV length, giving
754 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100755 *
756 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
757 *
758 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100759 *
760 * This function has the precondition that
761 *
762 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
763 *
764 * which has to be ensured by the caller. If this precondition
765 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100766 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767static void ssl_build_record_nonce(unsigned char *dst_iv,
768 size_t dst_iv_len,
769 unsigned char const *fixed_iv,
770 size_t fixed_iv_len,
771 unsigned char const *dynamic_iv,
772 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100773{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100774 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 memset(dst_iv, 0, dst_iv_len);
776 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100777
Hanno Becker17263802020-05-28 07:05:48 +0100778 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100780}
Valerio Settie5707042023-10-11 11:54:42 +0200781#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
784 mbedtls_ssl_transform *transform,
Ben Taylor602b2962025-03-07 15:52:50 +0000785 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +0000786{
Neil Armstrong136f8402022-03-30 10:58:01 +0200787 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100788 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200790 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 * the description of ssl_extract_add_data_from_record().
792 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200793#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
794 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
795#else
796 unsigned char add_data[13];
797#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100798 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000799 size_t post_avail;
800
801 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000802#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200803 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000804 ((void) ssl);
805#endif
806
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000808
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 if (transform == NULL) {
810 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
811 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000812 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100813 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100814 || rec->buf == NULL
815 || rec->buf_len < rec->data_offset
816 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100817#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100818 || rec->cid_len != 0
819#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 ) {
821 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
822 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100823 }
824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200826
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000827 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
829 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
830 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
833 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
834 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
835 rec->data_len,
836 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000838 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100839
Hanno Becker92313402020-05-20 13:58:58 +0100840 /* The following two code paths implement the (D)TLSInnerPlaintext
841 * structure present in TLS 1.3 and DTLS 1.2 + CID.
842 *
843 * See ssl_build_inner_plaintext() for more information.
844 *
845 * Note that this changes `rec->data_len`, and hence
846 * `post_avail` needs to be recalculated afterwards.
847 *
848 * Note also that the two code paths cannot occur simultaneously
849 * since they apply to different versions of the protocol. There
850 * is hence no risk of double-addition of the inner plaintext.
851 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100852#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100854 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 ssl_compute_padding_length(rec->data_len,
856 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
857 if (ssl_build_inner_plaintext(data,
858 &rec->data_len,
859 post_avail,
860 rec->type,
861 padding) != 0) {
862 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100863 }
864
865 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
866 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100867#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100868
Hanno Beckera0e20d02019-05-15 14:03:01 +0100869#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100870 /*
871 * Add CID information
872 */
873 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100874 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
875 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100876
Gilles Peskine449bd832023-01-11 14:50:10 +0100877 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100878 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 ssl_compute_padding_length(rec->data_len,
880 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100881 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100882 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100883 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100884 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100885 * Note that this changes `rec->data_len`, and hence
886 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100887 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100888 if (ssl_build_inner_plaintext(data,
889 &rec->data_len,
890 post_avail,
891 rec->type,
892 padding) != 0) {
893 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100894 }
895
896 rec->type = MBEDTLS_SSL_MSG_CID;
897 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100898#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100899
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100901
Paul Bakker5121ce52009-01-03 21:22:43 +0000902 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100903 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000904 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000905#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
907 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
908 if (post_avail < transform->maclen) {
909 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
910 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000911 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200912#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200913 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100914 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100915 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
917 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000918
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
920 transform->tls_version,
921 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000922
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
924 transform->psa_mac_alg);
925 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100926 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 status = psa_mac_update(&operation, add_data, add_data_len);
930 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100931 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100933
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 status = psa_mac_update(&operation, data, rec->data_len);
935 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100936 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100938
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
940 &sign_mac_length);
941 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100942 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000944
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200946#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200947
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
949 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200950
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000951 rec->data_len += transform->maclen;
952 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100953 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955hmac_failed_etm_disabled:
956 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500957 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 status = psa_mac_abort(&operation);
959 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500960 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 if (ret != 0) {
963 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
964 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100965 }
Paul Bakker577e0062013-08-28 11:57:20 +0200966 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000967#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000968
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200969 /*
970 * Encrypt
971 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000972#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
974 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
975 "including %d bytes of padding",
976 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +0000977
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100978 /* The only supported stream cipher is "NULL",
979 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000981#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000982
Valerio Settie5707042023-10-11 11:54:42 +0200983#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +0200985 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +0100986 unsigned char *dynamic_iv;
987 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +0100988 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +0100990 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +0100991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +0000992
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +0100993 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 if (post_avail < transform->taglen) {
995 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
996 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000997 }
Paul Bakkerca4ab492012-04-18 14:23:57 +0000998
Paul Bakker68884e32013-01-07 18:20:04 +0100999 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001000 * Build nonce for AEAD encryption.
1001 *
1002 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1003 * part of the IV is prepended to the ciphertext and
1004 * can be chosen freely - in particular, it need not
1005 * agree with the record sequence number.
1006 * However, since ChaChaPoly as well as all AEAD modes
1007 * in TLS 1.3 use the record sequence number as the
1008 * dynamic part of the nonce, we uniformly use the
1009 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001010 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001011 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001013
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 ssl_build_record_nonce(iv, sizeof(iv),
1015 transform->iv_enc,
1016 transform->fixed_ivlen,
1017 dynamic_iv,
1018 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001019
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001020 /*
1021 * Build additional data for AEAD encryption.
1022 * This depends on the TLS version.
1023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1025 transform->tls_version,
1026 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1029 iv, transform->ivlen);
1030 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1031 dynamic_iv,
1032 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1033 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1034 add_data, add_data_len);
1035 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1036 "including 0 bytes of padding",
1037 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001038
Paul Bakker68884e32013-01-07 18:20:04 +01001039 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001040 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001041 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 status = psa_aead_encrypt(transform->psa_key_enc,
1043 transform->psa_alg,
1044 iv, transform->ivlen,
1045 add_data, add_data_len,
1046 data, rec->data_len,
1047 data, rec->buf_len - (data - rec->buf),
1048 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001049
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001051 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1053 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001054 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001055
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1057 data + rec->data_len - transform->taglen,
1058 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001059 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001060 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001061
1062 /*
1063 * Prefix record content with dynamic IV in case it is explicit.
1064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (dynamic_iv_is_explicit != 0) {
1066 if (rec->data_offset < dynamic_iv_len) {
1067 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1068 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001069 }
1070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001072 rec->data_offset -= dynamic_iv_len;
1073 rec->data_len += dynamic_iv_len;
1074 }
1075
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001076 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 } else
Valerio Settie5707042023-10-11 11:54:42 +02001078#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001079#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1081 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001082 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001083 size_t padlen, i;
1084 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001085 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001086 size_t part_len;
1087 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001088
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001089 /* Currently we're always using minimal padding
1090 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1092 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001093 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001094 }
1095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 /* Check there's enough space in the buffer for the padding. */
1097 if (post_avail < padlen + 1) {
1098 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1099 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1100 }
1101
1102 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001103 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001105
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001106 rec->data_len += padlen + 1;
1107 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001108
TRodziewicz0f82ec62021-05-12 17:49:18 +02001109#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001110 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001111 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001112 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001113 */
TRodziewicz345165c2021-07-06 13:42:11 +02001114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 if (rec->data_offset < transform->ivlen) {
1116 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1117 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001118 }
1119
1120 /*
1121 * Generate IV
1122 */
Ben Taylor602b2962025-03-07 15:52:50 +00001123 ret = psa_generate_random(transform->iv_enc, transform->ivlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 if (ret != 0) {
1125 return ret;
1126 }
TRodziewicz345165c2021-07-06 13:42:11 +02001127
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001130
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1132 "including %"
1133 MBEDTLS_PRINTF_SIZET
1134 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1135 rec->data_len, transform->ivlen,
1136 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 status = psa_cipher_encrypt_setup(&cipher_op,
1139 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001142 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1144 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001145 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001148
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001150 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1152 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001153
1154 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 status = psa_cipher_update(&cipher_op,
1157 data, rec->data_len,
1158 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001161 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1163 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001164
1165 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 status = psa_cipher_finish(&cipher_op,
1168 data + olen, rec->data_len - olen,
1169 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001172 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1174 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001175
1176 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001177
1178 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 if (rec->data_len != olen) {
1181 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1182 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001183 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001184
TRodziewicz0f82ec62021-05-12 17:49:18 +02001185 data -= transform->ivlen;
1186 rec->data_offset -= transform->ivlen;
1187 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001191 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001192 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1193 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001194
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001195 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001196 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (post_avail < transform->maclen) {
1199 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1200 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001201 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001202
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 ssl_extract_add_data_from_record(add_data, &add_data_len,
1204 rec, transform->tls_version,
1205 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001206
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1208 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1209 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1211 transform->psa_mac_alg);
1212 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001213 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 status = psa_mac_update(&operation, add_data, add_data_len);
1217 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001218 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 status = psa_mac_update(&operation, data, rec->data_len);
1222 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001223 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1227 &sign_mac_length);
1228 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001229 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001233
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001234 rec->data_len += transform->maclen;
1235 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001236 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001237
Gilles Peskine449bd832023-01-11 14:50:10 +01001238hmac_failed_etm_enabled:
1239 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001240 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 status = psa_mac_abort(&operation);
1242 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001243 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if (ret != 0) {
1246 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1247 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001248 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001249 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001252#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001253 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1255 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001256 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001257
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001258 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 if (auth_done != 1) {
1260 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1261 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001262 }
1263
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001265
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001267}
1268
Gilles Peskine449bd832023-01-11 14:50:10 +01001269int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1270 mbedtls_ssl_transform *transform,
1271 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001272{
Valerio Settie5707042023-10-11 11:54:42 +02001273#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001274 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001275#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001276 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001277 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001278
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001279 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001280#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001281 size_t padlen = 0;
1282 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001283#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001285 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 * the description of ssl_extract_add_data_from_record().
1287 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001288#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1289 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1290#else
1291 unsigned char add_data[13];
1292#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001293 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001294
Hanno Beckera18d1322018-01-03 14:27:32 +00001295#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001296 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001297 ((void) ssl);
1298#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001299
Gilles Peskine449bd832023-01-11 14:50:10 +01001300 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1301 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001302 rec->buf == NULL ||
1303 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 rec->buf_len - rec->data_offset < rec->data_len) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1306 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001307 }
1308
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001311
Hanno Beckera0e20d02019-05-15 14:03:01 +01001312#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001313 /*
1314 * Match record's CID with incoming CID.
1315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 if (rec->cid_len != transform->in_cid_len ||
1317 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1318 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001319 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001320#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001321
Hanno Beckerd086bf02021-03-22 13:01:27 +00001322#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001324 if (rec->data_len < transform->maclen) {
1325 MBEDTLS_SSL_DEBUG_MSG(1,
1326 ("Record too short for MAC:"
1327 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1328 rec->data_len, transform->maclen));
1329 return MBEDTLS_ERR_SSL_INVALID_MAC;
1330 }
1331
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001332 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001333 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001335#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001336#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001338 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001339 unsigned char *dynamic_iv;
1340 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001342
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001343 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001344 * Extract dynamic part of nonce for AEAD decryption.
1345 *
1346 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1347 * part of the IV is prepended to the ciphertext and
1348 * can be chosen freely - in particular, it need not
1349 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 dynamic_iv_len = sizeof(rec->ctr);
1352 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1353 if (rec->data_len < dynamic_iv_len) {
1354 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1355 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1356 rec->data_len,
1357 dynamic_iv_len));
1358 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001359 }
1360 dynamic_iv = data;
1361
1362 data += dynamic_iv_len;
1363 rec->data_offset += dynamic_iv_len;
1364 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001366 dynamic_iv = rec->ctr;
1367 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001368
1369 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if (rec->data_len < transform->taglen) {
1371 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1372 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1373 rec->data_len,
1374 transform->taglen));
1375 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001376 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001377 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001378
Hanno Beckerdf8be222020-05-21 15:30:57 +01001379 /*
1380 * Prepare nonce from dynamic and static parts.
1381 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 ssl_build_record_nonce(iv, sizeof(iv),
1383 transform->iv_dec,
1384 transform->fixed_ivlen,
1385 dynamic_iv,
1386 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001387
Hanno Beckerdf8be222020-05-21 15:30:57 +01001388 /*
1389 * Build additional data for AEAD encryption.
1390 * This depends on the TLS version.
1391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1393 transform->tls_version,
1394 transform->taglen);
1395 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1396 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001397
Hanno Beckerd96a6522019-07-10 13:55:25 +01001398 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001399 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001400 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001401 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001402 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1405 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1406 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001407
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001408 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001409 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 status = psa_aead_decrypt(transform->psa_key_dec,
1412 transform->psa_alg,
1413 iv, transform->ivlen,
1414 add_data, add_data_len,
1415 data, rec->data_len + transform->taglen,
1416 data, rec->buf_len - (data - rec->buf),
1417 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001420 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1422 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001423 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001424
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001425 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001426
Hanno Beckerd96a6522019-07-10 13:55:25 +01001427 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 if (olen != rec->data_len) {
1429 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1430 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001431 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 } else
Valerio Settie5707042023-10-11 11:54:42 +02001433#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001434#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1436 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001437 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001438 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001439 size_t part_len;
1440 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
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 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001491
Hanno Beckerd96a6522019-07-10 13:55:25 +01001492 /* Update data_len in tandem with add_data.
1493 *
1494 * The subtraction is safe because of the previous check
1495 * data_len >= minlen + maclen + 1.
1496 *
1497 * Afterwards, we know that data + data_len is followed by at
1498 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001499 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001500 *
1501 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001502 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1504 transform->tls_version,
1505 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001506
Hanno Beckerd96a6522019-07-10 13:55:25 +01001507 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1509 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1511 transform->psa_mac_alg);
1512 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001513 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001515
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 status = psa_mac_update(&operation, add_data, add_data_len);
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, data, rec->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
1526 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1528 transform->maclen);
1529 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001530 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001532 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001535 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 status = psa_mac_abort(&operation);
1537 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001538 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 if (ret != 0) {
1541 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1542 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1543 }
1544 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001545 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001546 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001548
1549 /*
1550 * Check length sanity
1551 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001552
1553 /* We know from above that data_len > minlen >= 0,
1554 * so the following check in particular implies that
1555 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 if (rec->data_len % transform->ivlen != 0) {
1557 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1558 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1559 rec->data_len, transform->ivlen));
1560 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001561 }
1562
TRodziewicz0f82ec62021-05-12 17:49:18 +02001563#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001564 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001565 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001566 */
TRodziewicz345165c2021-07-06 13:42:11 +02001567 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001569
TRodziewicz345165c2021-07-06 13:42:11 +02001570 data += transform->ivlen;
1571 rec->data_offset += transform->ivlen;
1572 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001573#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001574
Hanno Beckerd96a6522019-07-10 13:55:25 +01001575 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1576
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 status = psa_cipher_decrypt_setup(&cipher_op,
1578 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001581 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1583 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001584 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001589 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1591 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001592 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 status = psa_cipher_update(&cipher_op,
1595 data, rec->data_len,
1596 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001597
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001599 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1601 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001602 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 status = psa_cipher_finish(&cipher_op,
1605 data + olen, rec->data_len - olen,
1606 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001609 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1611 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001612 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001613
1614 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001615
Hanno Beckerd96a6522019-07-10 13:55:25 +01001616 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 if (rec->data_len != olen) {
1618 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1619 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001620 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001621
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001622 /* Safe since data_len >= minlen + maclen + 1, so after having
1623 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001624 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1625 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001626 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001629 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 rec->data_len,
1631 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001632 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001633 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 if (rec->data_len < transform->maclen + padlen + 1) {
1637 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1638 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1639 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1640 rec->data_len,
1641 transform->maclen,
1642 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001643 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001644#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001645 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 rec->data_len,
1647 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001648 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001649 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001650 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001651
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001652 padlen++;
1653
1654 /* Regardless of the validity of the padding,
1655 * we have data_len >= padlen here. */
1656
TRodziewicz0f82ec62021-05-12 17:49:18 +02001657#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001658 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 * consecutive memory reads at the end of the record
1660 * plaintext buffer. In order to hide the length and
1661 * validity of the padding, always perform exactly
1662 * `min(256,plaintext_len)` reads (but take into account
1663 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001664 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001666
1667 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001669 size_t const padding_idx = rec->data_len - padlen;
1670 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1671 size_t const start_idx = rec->data_len - num_checks;
1672 size_t idx;
1673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001675 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 * (check[idx] == padlen - 1);
1677 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001678 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001679 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001680 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001681 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001682 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001683 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001684 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001687 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1689 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001690#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001691 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001692
TRodziewicz0f82ec62021-05-12 17:49:18 +02001693#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001694
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001695 /* If the padding was found to be invalid, padlen == 0
1696 * and the subtraction is safe. If the padding was found valid,
1697 * padlen hasn't been changed and the previous assertion
1698 * data_len >= padlen still holds. */
1699 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001701#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001702 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001705 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001706
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001707#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1709 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001710#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001711
1712 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001713 * Authenticate if not done yet.
1714 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001715 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001716#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001718 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1719 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001720
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001721 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001722 * data_len < maclen + padlen + 1, then padlen
1723 * got reset to 1, and the initial check
1724 * data_len >= minlen + maclen + 1
1725 * guarantees that at this point we still
1726 * have at least data_len >= maclen.
1727 *
1728 * If the initial value of padlen was such that
1729 * data_len >= maclen + padlen + 1, then we have
1730 * subtracted either padlen + 1 (if the padding was correct)
1731 * or 0 (if the padding was incorrect) since then,
1732 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001733 *
1734 * For stream ciphers, we checked above that
1735 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001736 */
1737 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1739 transform->tls_version,
1740 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001741
TRodziewicz0f82ec62021-05-12 17:49:18 +02001742#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001743 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 * The next two sizes are the minimum and maximum values of
1745 * data_len over all padlen values.
1746 *
1747 * They're independent of padlen, since we previously did
1748 * data_len -= padlen.
1749 *
1750 * Note that max_len + maclen is never more than the buffer
1751 * length, as we previously did in_msglen -= maclen too.
1752 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001753 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1757 transform->psa_mac_alg,
1758 add_data, add_data_len,
1759 data, rec->data_len, min_len, max_len,
1760 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if (ret != 0) {
1762 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001763 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001764 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 mbedtls_ct_memcpy_offset(mac_peer, data,
1767 rec->data_len,
1768 min_len, max_len,
1769 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001770#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001771
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001772#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1774 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001775#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001776
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1778 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001781#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001782 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001783 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001784 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786hmac_failed_etm_disabled:
1787 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1788 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1789 if (ret != 0) {
1790 return ret;
1791 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001792 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001793
1794 /*
1795 * Finally check the correct flag
1796 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001797 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 return MBEDTLS_ERR_SSL_INVALID_MAC;
1799 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001800#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001801
1802 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (auth_done != 1) {
1804 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1805 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001806 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001807
Ronald Cron6f135e12021-12-08 16:57:54 +01001808#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001810 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1812 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 if (ret != 0) {
1815 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1816 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001817 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001818#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001819
Hanno Beckera0e20d02019-05-15 14:03:01 +01001820#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 if (rec->cid_len != 0) {
1822 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1823 &rec->type);
1824 if (ret != 0) {
1825 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1826 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001827 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001828#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001829
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001831
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001833}
1834
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001835#undef MAC_NONE
1836#undef MAC_PLAINTEXT
1837#undef MAC_CIPHERTEXT
1838
Paul Bakker5121ce52009-01-03 21:22:43 +00001839/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001840 * Fill the input message buffer by appending data to it.
1841 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001842 *
1843 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1844 * available (from this read and/or a previous one). Otherwise, an error code
1845 * is returned (possibly EOF or WANT_READ).
1846 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001847 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1848 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1849 * since we always read a whole datagram at once.
1850 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001851 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001852 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001853 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001854int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001855{
Janos Follath865b3eb2019-12-16 11:46:15 +00001856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001857 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001858#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1859 size_t in_buf_len = ssl->in_buf_len;
1860#else
1861 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1862#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1867 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001869 }
1870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1872 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1873 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001874 }
1875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001878 uint32_t timeout;
1879
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001880 /*
1881 * The point is, we need to always read a full datagram at once, so we
1882 * sometimes read more then requested, and handle the additional data.
1883 * It could be the rest of the current record (while fetching the
1884 * header) and/or some other records in the same datagram.
1885 */
1886
1887 /*
1888 * Move to the next record in the already read datagram if applicable
1889 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (ssl->next_record_offset != 0) {
1891 if (ssl->in_left < ssl->next_record_offset) {
1892 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1893 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001894 }
1895
1896 ssl->in_left -= ssl->next_record_offset;
1897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 if (ssl->in_left != 0) {
1899 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1900 MBEDTLS_PRINTF_SIZET,
1901 ssl->next_record_offset));
1902 memmove(ssl->in_hdr,
1903 ssl->in_hdr + ssl->next_record_offset,
1904 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001905 }
1906
1907 ssl->next_record_offset = 0;
1908 }
1909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1911 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1912 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001913
1914 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001915 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (nb_want <= ssl->in_left) {
1918 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1919 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001920 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001921
1922 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001923 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001924 * are not at the beginning of a new record, the caller did something
1925 * wrong.
1926 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (ssl->in_left != 0) {
1928 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1929 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001930 }
1931
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001932 /*
1933 * Don't even try to read if time's out already.
1934 * This avoids by-passing the timer when repeatedly receiving messages
1935 * that will end up being dropped.
1936 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (mbedtls_ssl_check_timer(ssl) != 0) {
1938 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001939 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001941 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001944 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001946 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001948
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001950
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (ssl->f_recv_timeout != NULL) {
1952 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1953 timeout);
1954 } else {
1955 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1956 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001959
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (ret == 0) {
1961 return MBEDTLS_ERR_SSL_CONN_EOF;
1962 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963 }
1964
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1966 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
1967 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
1970 if (ssl_double_retransmit_timeout(ssl) != 0) {
1971 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
1972 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001973 }
1974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
1976 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
1977 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001978 }
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001981 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
1984 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
1985 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
1986 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
1987 ret);
1988 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001989 }
1990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02001992 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001994 }
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 if (ret < 0) {
1997 return ret;
1998 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001999
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002000 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002002#endif
2003 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2005 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2006 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002007
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002009 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002012 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 } else {
2014 if (ssl->f_recv_timeout != NULL) {
2015 ret = ssl->f_recv_timeout(ssl->p_bio,
2016 ssl->in_hdr + ssl->in_left, len,
2017 ssl->conf->read_timeout);
2018 } else {
2019 ret = ssl->f_recv(ssl->p_bio,
2020 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002021 }
2022 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2025 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2026 ssl->in_left, nb_want));
2027 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 if (ret == 0) {
2030 return MBEDTLS_ERR_SSL_CONN_EOF;
2031 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 if (ret < 0) {
2034 return ret;
2035 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002036
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002037 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 MBEDTLS_SSL_DEBUG_MSG(1,
2039 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2040 " were requested",
2041 ret, len));
2042 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002043 }
2044
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002045 ssl->in_left += ret;
2046 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002047 }
2048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002052}
2053
2054/*
2055 * Flush any data not yet written
2056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002058{
Janos Follath865b3eb2019-12-16 11:46:15 +00002059 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002060 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (ssl->f_send == NULL) {
2065 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002067 }
2068
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002069 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 if (ssl->out_left == 0) {
2071 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2072 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002073 }
2074
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 while (ssl->out_left > 0) {
2076 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2077 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2078 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002079
Hanno Becker2b1e3542018-08-06 11:19:13 +01002080 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (ret <= 0) {
2086 return ret;
2087 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002088
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002089 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 MBEDTLS_SSL_DEBUG_MSG(1,
2091 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2092 " bytes were sent",
2093 ret, ssl->out_left));
2094 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002095 }
2096
Paul Bakker5121ce52009-01-03 21:22:43 +00002097 ssl->out_left -= ret;
2098 }
2099
Hanno Becker2b1e3542018-08-06 11:19:13 +01002100#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002102 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002104#endif
2105 {
2106 ssl->out_hdr = ssl->out_buf + 8;
2107 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002113}
2114
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002115/*
2116 * Functions to handle the DTLS retransmission state machine
2117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002119/*
2120 * Append current handshake message to current outgoing flight
2121 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002122MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002123static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002124{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2127 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2128 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002129
2130 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2132 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2133 sizeof(mbedtls_ssl_flight_item)));
2134 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002135 }
2136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2138 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2139 ssl->out_msglen));
2140 mbedtls_free(msg);
2141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002142 }
2143
2144 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002146 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002147 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148 msg->next = NULL;
2149
2150 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002152 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002156 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002158 cur->next = msg;
2159 }
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2162 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163}
2164
2165/*
2166 * Free the current flight of handshake messages
2167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002168void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002169{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170 mbedtls_ssl_flight_item *cur = flight;
2171 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002172
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002174 next = cur->next;
2175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 mbedtls_free(cur->p);
2177 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002178
2179 cur = next;
2180 }
2181}
2182
2183/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002184 * Swap transform_out and out_ctr with the alternative ones
2185 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002186MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002187static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002188{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002190 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2193 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2194 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002195 }
2196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002198
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002199 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002200 tmp_transform = ssl->transform_out;
2201 ssl->transform_out = ssl->handshake->alt_transform_out;
2202 ssl->handshake->alt_transform_out = tmp_transform;
2203
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002204 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2206 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2207 sizeof(ssl->cur_out_ctr));
2208 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2209 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002210
2211 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002215}
2216
2217/*
2218 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002219 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002220int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002221{
2222 int ret = 0;
2223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002227
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002231}
2232
2233/*
2234 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002235 *
2236 * Need to remember the current message in case flush_output returns
2237 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002238 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002240int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002241{
Janos Follath865b3eb2019-12-16 11:46:15 +00002242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2246 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002247
2248 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002249 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 ret = ssl_swap_epochs(ssl);
2251 if (ret != 0) {
2252 return ret;
2253 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002256 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002259 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002260 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002261
Hanno Beckere1dcb032018-08-17 16:47:58 +01002262 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2264 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002265
Ronald Cron00d012f22022-03-08 15:57:12 +01002266 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002268
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002269 /* Swap epochs before sending Finished: we can't do it after
2270 * sending ChangeCipherSpec, in case write returns WANT_READ.
2271 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2273 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2274 ret = ssl_swap_epochs(ssl);
2275 if (ret != 0) {
2276 return ret;
2277 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002278 }
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 ret = ssl_get_remaining_payload_in_datagram(ssl);
2281 if (ret < 0) {
2282 return ret;
2283 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002284 max_frag_len = (size_t) ret;
2285
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002286 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2288 if (max_frag_len == 0) {
2289 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2290 return ret;
2291 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002292
2293 continue;
2294 }
2295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002297 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002298 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002299
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002300 /* Update position inside current message */
2301 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002303 const unsigned char * const p = ssl->handshake->cur_msg_p;
2304 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002305 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002306 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002307 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2310 if (is_finished) {
2311 ret = ssl_swap_epochs(ssl);
2312 if (ret != 0) {
2313 return ret;
2314 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002315 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2318 return ret;
2319 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002320
2321 continue;
2322 }
2323 max_hs_frag_len = max_frag_len - 12;
2324
2325 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2329 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2330 (unsigned) cur_hs_frag_len,
2331 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002332 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002333
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002334 /* Messages are stored with handshake headers as if not fragmented,
2335 * copy beginning of headers then fill fragmentation fields.
2336 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2340 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2341 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2344 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2345 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002348
Hanno Becker3f7b9732018-08-28 09:53:25 +01002349 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002351 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002352 ssl->out_msgtype = cur->type;
2353
2354 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002355 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002356 }
2357
2358 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2360 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002361 ssl->handshake->cur_msg = cur->next;
2362 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002364 ssl->handshake->cur_msg = NULL;
2365 ssl->handshake->cur_msg_p = NULL;
2366 }
2367 }
2368
2369 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2371 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2372 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002373 }
2374 }
2375
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2377 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002378 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 /* Update state and set timer */
2381 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2382 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2383 } else {
2384 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2385 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2386 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002387
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2389
2390 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002391}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002392
2393/*
2394 * To be called when the last message of an incoming flight is received.
2395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002396void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002397{
2398 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002400 ssl->handshake->flight = NULL;
2401 ssl->handshake->cur_msg = NULL;
2402
2403 /* The next incoming flight will start with this msg_seq */
2404 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2405
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002406 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002407 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002408
Hanno Becker0271f962018-08-16 13:23:47 +01002409 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002411
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002412 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2416 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002421}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002422
2423/*
2424 * To be called when the last message of an outgoing flight is send.
2425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002426void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002427{
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 ssl_reset_retransmit_timeout(ssl);
2429 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002430
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2432 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002437}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002439
Paul Bakker5121ce52009-01-03 21:22:43 +00002440/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002441 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002442 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002443int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002445{
2446 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002447 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002448 * ...
2449 * HandshakeType msg_type;
2450 * uint24 length;
2451 * ...
2452 */
2453 *buf = ssl->out_msg + 4;
2454 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2455
2456 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2457 ssl->out_msg[0] = hs_type;
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002460}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002461
2462/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002463 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002464 *
2465 * - fill in handshake headers
2466 * - update handshake checksum
2467 * - DTLS: save message for resending
2468 * - then pass to the record layer
2469 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002470 * DTLS: except for HelloRequest, messages are only queued, and will only be
2471 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002472 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002473 * Inputs:
2474 * - ssl->out_msglen: 4 + actual handshake message len
2475 * (4 is the size of handshake headers for TLS)
2476 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2477 * - ssl->out_msg + 4: the handshake message body
2478 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002479 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002480 * - ssl->out_msglen: the length of the record contents
2481 * (including handshake headers but excluding record headers)
2482 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002484int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2485 int update_checksum,
2486 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002487{
Janos Follath865b3eb2019-12-16 11:46:15 +00002488 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002489 const size_t hs_len = ssl->out_msglen - 4;
2490 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002493
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002494 /*
2495 * Sanity checks
2496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2498 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2499 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2500 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002501 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002502
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002503 /* Whenever we send anything different from a
2504 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2506 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2507 ssl->handshake == NULL) {
2508 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2509 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002510 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002514 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2516 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2517 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002518 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002519#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002520
Hanno Beckerb50a2532018-08-06 11:52:54 +01002521 /* Double-check that we did not exceed the bounds
2522 * of the outgoing record buffer.
2523 * This should never fail as the various message
2524 * writing functions must obey the bounds of the
2525 * outgoing record buffer, but better be safe.
2526 *
2527 * Note: We deliberately do not check for the MTU or MFL here.
2528 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2530 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2531 "size %" MBEDTLS_PRINTF_SIZET
2532 ", maximum %" MBEDTLS_PRINTF_SIZET,
2533 ssl->out_msglen,
2534 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2535 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002536 }
2537
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002538 /*
2539 * Fill handshake headers
2540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2542 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2543 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2544 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002545
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002546 /*
2547 * DTLS has additional fields in the Handshake layer,
2548 * between the length field and the actual payload:
2549 * uint16 message_seq;
2550 * uint24 fragment_offset;
2551 * uint24 fragment_length;
2552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002555 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2557 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2558 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2559 MBEDTLS_PRINTF_SIZET,
2560 hs_len,
2561 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2562 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002563 }
2564
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002566 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002567
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002568 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2570 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2571 ++(ssl->handshake->out_msg_seq);
2572 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002573 ssl->out_msg[4] = 0;
2574 ssl->out_msg[5] = 0;
2575 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002576
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002577 /* Handshake hashes are computed without fragmentation,
2578 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 memset(ssl->out_msg + 6, 0x00, 3);
2580 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002581 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002583
Hanno Becker0207e532018-08-28 10:28:28 +01002584 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002586 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2587 ssl->out_msglen);
2588 if (ret != 0) {
2589 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2590 return ret;
2591 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002593 }
2594
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002595 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2598 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2599 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2600 if ((ret = ssl_flight_append(ssl)) != 0) {
2601 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2602 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002603 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002605#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002606 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2608 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2609 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 }
2611 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002616}
2617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2619 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002620{
2621 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2622 size_t msg_with_header_len;
2623 ((void) buf_len);
2624
2625 /* Add reserved 4 bytes for handshake header */
2626 msg_with_header_len = msg_len + 4;
2627 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002629
2630cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002632}
2633
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002634/*
2635 * Record layer functions
2636 */
2637
2638/*
2639 * Write current record.
2640 *
2641 * Uses:
2642 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2643 * - ssl->out_msglen: length of the record content (excl headers)
2644 * - ssl->out_msg: record content
2645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002647{
2648 int ret, done = 0;
2649 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002650 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002655 unsigned i;
2656 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002657#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2658 size_t out_buf_len = ssl->out_buf_len;
2659#else
2660 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2661#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002662 /* Skip writing the record content type to after the encryption,
2663 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002664 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002665#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002666 /* TLS 1.3 still uses the TLS 1.2 version identifier
2667 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002669 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002671#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2673 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2676 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002679 mbedtls_record rec;
2680
2681 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002682 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002683 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002684 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2687 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002688 rec.type = ssl->out_msgtype;
2689
Hanno Beckera0e20d02019-05-15 14:03:01 +01002690#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002691 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002692 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002693#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002694
Ben Taylor602b2962025-03-07 15:52:50 +00002695 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2697 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002698 }
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 if (rec.data_offset != 0) {
2701 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2702 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002703 }
2704
Hanno Becker6430faf2019-05-08 11:57:13 +01002705 /* Update the record content type and CID. */
2706 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002707#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2708 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002709#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002710 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002712 }
2713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002715
2716#if defined(MBEDTLS_SSL_PROTO_DTLS)
2717 /* In case of DTLS, double-check that we don't exceed
2718 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2720 ret = ssl_get_remaining_space_in_datagram(ssl);
2721 if (ret < 0) {
2722 return ret;
2723 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002726 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002728 }
2729 }
2730#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002731
Hanno Becker6430faf2019-05-08 11:57:13 +01002732 /* Now write the potentially updated record content type. */
2733 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2736 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2737 ssl->out_hdr[0], ssl->out_hdr[1],
2738 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2741 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002742
2743 ssl->out_left += protected_record_size;
2744 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2748 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002749 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 }
2751 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002752
Gabor Mezei96ae9262022-06-28 11:45:18 +02002753 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (i == mbedtls_ssl_ep_len(ssl)) {
2755 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2756 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002757 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002758 }
2759
Hanno Becker67bc7c32018-08-06 11:33:50 +01002760#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2762 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002763 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 ret = ssl_get_remaining_payload_in_datagram(ssl);
2765 if (ret < 0) {
2766 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2767 ret);
2768 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002769 }
2770
2771 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002773 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 } else {
2775 MBEDTLS_SSL_DEBUG_MSG(2,
2776 ("Still %u bytes available in current datagram",
2777 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002778 }
2779 }
2780#endif /* MBEDTLS_SSL_PROTO_DTLS */
2781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if ((flush == SSL_FORCE_FLUSH) &&
2783 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2784 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2785 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002786 }
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002791}
2792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002794
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002795MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002796static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002797{
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 if (ssl->in_msglen < ssl->in_hslen ||
2799 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2800 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2801 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002804}
Hanno Becker44650b72018-08-16 12:51:11 +01002805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002807{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002808 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002809}
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002812{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002813 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002814}
2815
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002816MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002817static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002818{
2819 uint32_t msg_len, frag_off, frag_len;
2820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 msg_len = ssl_get_hs_total_len(ssl);
2822 frag_off = ssl_get_hs_frag_off(ssl);
2823 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 if (frag_off > msg_len) {
2826 return -1;
2827 }
Hanno Becker44650b72018-08-16 12:51:11 +01002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (frag_len > msg_len - frag_off) {
2830 return -1;
2831 }
Hanno Becker44650b72018-08-16 12:51:11 +01002832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 if (frag_len + 12 > ssl->in_msglen) {
2834 return -1;
2835 }
Hanno Becker44650b72018-08-16 12:51:11 +01002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002838}
2839
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002840/*
2841 * Mark bits in bitmask (used for DTLS HS reassembly)
2842 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002843static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002844{
2845 unsigned int start_bits, end_bits;
2846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 start_bits = 8 - (offset % 8);
2848 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002849 size_t first_byte_idx = offset / 8;
2850
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002851 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (len <= start_bits) {
2853 for (; len != 0; len--) {
2854 mask[first_byte_idx] |= 1 << (start_bits - len);
2855 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002856
2857 /* Avoid potential issues with offset or len becoming invalid */
2858 return;
2859 }
2860
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002861 offset += start_bits; /* Now offset % 8 == 0 */
2862 len -= start_bits;
2863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 for (; start_bits != 0; start_bits--) {
2865 mask[first_byte_idx] |= 1 << (start_bits - 1);
2866 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002867 }
2868
2869 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (end_bits != 0) {
2871 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002872
2873 len -= end_bits; /* Now len % 8 == 0 */
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 for (; end_bits != 0; end_bits--) {
2876 mask[last_byte_idx] |= 1 << (8 - end_bits);
2877 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002878 }
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002881}
2882
2883/*
2884 * Check that bitmask is full
2885 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002886MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002887static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002888{
2889 size_t i;
2890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 for (i = 0; i < len / 8; i++) {
2892 if (mask[i] != 0xFF) {
2893 return -1;
2894 }
2895 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 for (i = 0; i < len % 8; i++) {
2898 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2899 return -1;
2900 }
2901 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002904}
2905
Hanno Becker56e205e2018-08-16 09:06:12 +01002906/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2908 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002909{
Hanno Becker56e205e2018-08-16 09:06:12 +01002910 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002911
Hanno Becker56e205e2018-08-16 09:06:12 +01002912 alloc_len = 12; /* Handshake header */
2913 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 if (add_bitmap) {
2916 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 }
2919 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002920}
Hanno Becker56e205e2018-08-16 09:06:12 +01002921
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002922#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002925{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002926 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002927}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002928
Gilles Peskine449bd832023-01-11 14:50:10 +01002929int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002930{
Gilles Peskine7a176962025-02-28 21:59:12 +01002931 if (ssl->in_hsfraglen == 0) {
2932 /* The handshake message must at least include the header.
2933 * We may not have the full message yet in case of fragmentation.
2934 * To simplify the code, we insist on having the header (and in
2935 * particular the handshake message length) in the first
2936 * fragment. */
2937 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2938 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2939 ssl->in_msglen));
2940 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2941 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002942
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002943 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002944 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2947 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2948 MBEDTLS_PRINTF_SIZET,
2949 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002950
Gilles Peskine235eae92025-02-28 22:02:52 +01002951 if (ssl->transform_in != NULL) {
2952 MBEDTLS_SSL_DEBUG_MSG(4, ("decrypted handshake message:"
2953 " iv-buf=%d hdr-buf=%d hdr-buf=%d",
2954 (int) (ssl->in_iv - ssl->in_buf),
2955 (int) (ssl->in_hdr - ssl->in_buf),
2956 (int) (ssl->in_msg - ssl->in_buf)));
2957 }
2958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002962 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (ssl_check_hs_header(ssl) != 0) {
2965 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2966 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002967 }
2968
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 if (ssl->handshake != NULL &&
2970 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2971 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2972 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
2973 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
2974 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
2975 MBEDTLS_SSL_DEBUG_MSG(2,
2976 (
2977 "received future handshake message of sequence number %u (next %u)",
2978 recv_msg_seq,
2979 ssl->handshake->in_msg_seq));
2980 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01002981 }
2982
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002983 /* Retransmit only on last message from previous flight, to avoid
2984 * too many retransmissions.
2985 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
2987 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
2988 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
2989 "message_seq = %u, start_of_flight = %u",
2990 recv_msg_seq,
2991 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2994 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2995 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002996 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 } else {
2998 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
2999 "message_seq = %u, expected = %u",
3000 recv_msg_seq,
3001 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003002 }
3003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003005 }
3006 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003007
Hanno Becker6d97ef52018-08-16 13:09:04 +01003008 /* Message reassembly is handled alongside buffering of future
3009 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003010 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003011 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3013 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3014 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskinee85ece62025-02-28 22:24:56 +01003018 {
3019 unsigned char *const reassembled_record_start =
3020 ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3021 unsigned char *const payload_start =
3022 reassembled_record_start + mbedtls_ssl_in_hdr_len(ssl);
3023 unsigned char *payload_end = payload_start + ssl->in_hsfraglen;
Gilles Peskine15c072f2025-03-06 19:03:00 +01003024 /* How many more bytes we want to have a complete handshake message. */
3025 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
3026 /* How many bytes of the current record are part of the first
3027 * handshake message. There may be more handshake messages (possibly
3028 * incomplete) in the same record; if so, we leave them after the
3029 * current record, and ssl_consume_current_message() will take
3030 * care of consuming the next handshake message. */
3031 const size_t hs_this_fragment_len =
3032 ssl->in_msglen > hs_remain ? hs_remain : ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003033 (void) hs_this_fragment_len;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003034
Gilles Peskineafb254c2025-03-06 19:23:22 +01003035 MBEDTLS_SSL_DEBUG_MSG(3,
3036 ("%s handshake fragment: %" MBEDTLS_PRINTF_SIZET
3037 ", %" MBEDTLS_PRINTF_SIZET
3038 "..%" MBEDTLS_PRINTF_SIZET
3039 " of %" MBEDTLS_PRINTF_SIZET,
3040 (ssl->in_hsfraglen != 0 ?
3041 "subsequent" :
3042 hs_this_fragment_len == ssl->in_hslen ?
3043 "sole" :
3044 "initial"),
3045 ssl->in_msglen,
3046 ssl->in_hsfraglen,
3047 ssl->in_hsfraglen + hs_this_fragment_len,
3048 ssl->in_hslen));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003049
3050 /* Move the received handshake fragment to have the whole message
3051 * (at least the part received so far) in a single segment at a
3052 * known offset in the input buffer.
3053 * - When receiving a non-initial handshake fragment, append it to
3054 * the initial segment.
3055 * - Even the initial handshake fragment is moved, if it was
3056 * encrypted with an explicit IV: decryption leaves the payload
3057 * after the explicit IV, but here we move it to start where the
3058 * IV was.
3059 */
3060#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3061 size_t const in_buf_len = ssl->in_buf_len;
3062#else
3063 size_t const in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3064#endif
Gilles Peskine0851ec92025-03-06 15:15:20 +01003065 if (payload_end + ssl->in_msglen > ssl->in_buf + in_buf_len) {
Gilles Peskinee85ece62025-02-28 22:24:56 +01003066 MBEDTLS_SSL_DEBUG_MSG(1,
3067 ("Shouldn't happen: no room to move handshake fragment %"
3068 MBEDTLS_PRINTF_SIZET " from %p to %p (buf=%p len=%"
3069 MBEDTLS_PRINTF_SIZET ")",
3070 ssl->in_msglen,
Gilles Peskine90a95932025-02-25 23:57:20 +01003071 (void *) ssl->in_msg, (void *) payload_end,
3072 (void *) ssl->in_buf, in_buf_len));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003073 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3074 }
3075 memmove(payload_end, ssl->in_msg, ssl->in_msglen);
3076
3077 ssl->in_hsfraglen += ssl->in_msglen;
3078 payload_end += ssl->in_msglen;
3079
3080 if (ssl->in_hsfraglen < ssl->in_hslen) {
3081 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3082 MBEDTLS_PRINTF_SIZET "/%"
3083 MBEDTLS_PRINTF_SIZET,
3084 ssl->in_hsfraglen, ssl->in_hslen));
3085 ssl->in_hdr = payload_end;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003086 ssl->in_msglen = 0;
3087 mbedtls_ssl_update_in_pointers(ssl);
3088 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003089 } else {
3090 ssl->in_msglen = ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003091 ssl->in_hsfraglen = 0;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003092 ssl->in_hdr = reassembled_record_start;
3093 mbedtls_ssl_update_in_pointers(ssl);
3094
3095 /* Update the record length in the fully reassembled record */
3096 if (ssl->in_msglen > 0xffff) {
3097 MBEDTLS_SSL_DEBUG_MSG(1,
Gilles Peskinee34ec862025-03-07 10:43:39 +01003098 ("Shouldn't happen: in_msglen=%"
Gilles Peskinee85ece62025-02-28 22:24:56 +01003099 MBEDTLS_PRINTF_SIZET " > 0xffff",
3100 ssl->in_msglen));
3101 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3102 }
3103 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
3104
Gilles Peskine15c072f2025-03-06 19:03:00 +01003105 size_t record_len = mbedtls_ssl_in_hdr_len(ssl) + ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003106 (void) record_len;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003107 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
Gilles Peskine15c072f2025-03-06 19:03:00 +01003108 ssl->in_hdr, record_len);
3109 if (ssl->in_hslen < ssl->in_msglen) {
3110 MBEDTLS_SSL_DEBUG_MSG(3,
3111 ("More handshake messages in the record: "
Gilles Peskineb8f1e4b2025-03-06 21:32:08 +01003112 "%" MBEDTLS_PRINTF_SIZET " + %" MBEDTLS_PRINTF_SIZET,
Gilles Peskine15c072f2025-03-06 19:03:00 +01003113 ssl->in_hslen,
3114 ssl->in_msglen - ssl->in_hslen));
3115 }
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003116 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003117 }
3118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003120}
3121
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003122int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003123{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003124 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003125 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003128 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3129 if (ret != 0) {
3130 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3131 return ret;
3132 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003133 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003134
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003135 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3138 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003139 unsigned offset;
3140 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003141
Hanno Becker0271f962018-08-16 13:23:47 +01003142 /* Increment handshake sequence number */
3143 hs->in_msg_seq++;
3144
3145 /*
3146 * Clear up handshake buffering and reassembly structure.
3147 */
3148
3149 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003151
3152 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003154 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003156 *hs_buf = *(hs_buf + 1);
3157 }
3158
3159 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003161 }
3162#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003163 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003164}
3165
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003166/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003167 * DTLS anti-replay: RFC 6347 4.1.2.6
3168 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003169 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3170 * Bit n is set iff record number in_window_top - n has been seen.
3171 *
3172 * Usually, in_window_top is the last record number seen and the lsb of
3173 * in_window is set. The only exception is the initial state (record number 0
3174 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003177void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003178{
3179 ssl->in_window_top = 0;
3180 ssl->in_window = 0;
3181}
3182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003184{
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 return ((uint64_t) buf[0] << 40) |
3186 ((uint64_t) buf[1] << 32) |
3187 ((uint64_t) buf[2] << 24) |
3188 ((uint64_t) buf[3] << 16) |
3189 ((uint64_t) buf[4] << 8) |
3190 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003191}
3192
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003193MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003194static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003195{
Janos Follath865b3eb2019-12-16 11:46:15 +00003196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003197 unsigned char *original_in_ctr;
3198
3199 // save original in_ctr
3200 original_in_ctr = ssl->in_ctr;
3201
3202 // use counter from record
3203 ssl->in_ctr = record_in_ctr;
3204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003206
3207 // restore the counter
3208 ssl->in_ctr = original_in_ctr;
3209
3210 return ret;
3211}
3212
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003213/*
3214 * Return 0 if sequence number is acceptable, -1 otherwise
3215 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003216int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003217{
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003219 uint64_t bit;
3220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3222 return 0;
3223 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003224
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 if (rec_seqnum > ssl->in_window_top) {
3226 return 0;
3227 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003228
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003229 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (bit >= 64) {
3232 return -1;
3233 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003234
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3236 return -1;
3237 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003240}
3241
3242/*
3243 * Update replay window on new validated record
3244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003245void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003246{
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003250 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003254 /* Update window_top and the contents of the window */
3255 uint64_t shift = rec_seqnum - ssl->in_window_top;
3256
Gilles Peskine449bd832023-01-11 14:50:10 +01003257 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003258 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003260 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003261 ssl->in_window |= 1;
3262 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263
3264 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003266 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003267 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003270 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003272 }
3273}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003274#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003275
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003276#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003277/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003278 * Check if a datagram looks like a ClientHello with a valid cookie,
3279 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003280 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003281 *
3282 * - if cookie is valid, return 0
3283 * - if ClientHello looks superficially valid but cookie is not,
3284 * fill obuf and set olen, then
3285 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3286 * - otherwise return a specific error code
3287 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003288MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003289MBEDTLS_STATIC_TESTABLE
3290int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 mbedtls_ssl_context *ssl,
3292 const unsigned char *cli_id, size_t cli_id_len,
3293 const unsigned char *in, size_t in_len,
3294 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003295{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003296 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003297 unsigned char *p;
3298
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003299 /*
3300 * Structure of ClientHello with record and handshake headers,
3301 * and expected values. We don't need to check a lot, more checks will be
3302 * done when actually parsing the ClientHello - skipping those checks
3303 * avoids code duplication and does not make cookie forging any easier.
3304 *
3305 * 0-0 ContentType type; copied, must be handshake
3306 * 1-2 ProtocolVersion version; copied
3307 * 3-4 uint16 epoch; copied, must be 0
3308 * 5-10 uint48 sequence_number; copied
3309 * 11-12 uint16 length; (ignored)
3310 *
3311 * 13-13 HandshakeType msg_type; (ignored)
3312 * 14-16 uint24 length; (ignored)
3313 * 17-18 uint16 message_seq; copied
3314 * 19-21 uint24 fragment_offset; copied, must be 0
3315 * 22-24 uint24 fragment_length; (ignored)
3316 *
3317 * 25-26 ProtocolVersion client_version; (ignored)
3318 * 27-58 Random random; (ignored)
3319 * 59-xx SessionID session_id; 1 byte len + sid_len content
3320 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3321 * ...
3322 *
3323 * Minimum length is 61 bytes.
3324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3326 (unsigned) in_len));
3327 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3328 if (in_len < 61) {
3329 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3330 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003331 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3334 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3337 fragment_offset != 0) {
3338 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3339 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3340 in[0], (unsigned) epoch,
3341 (unsigned) fragment_offset));
3342 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003343 }
3344
3345 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003346 if (59 + 1 + sid_len + 1 > in_len) {
3347 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3348 (unsigned) sid_len,
3349 (unsigned) in_len - 61));
3350 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003351 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3353 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003354
3355 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3357 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3358 (unsigned) cookie_len,
3359 (unsigned) (in_len - sid_len - 61)));
3360 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003361 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3364 in + sid_len + 61, cookie_len);
3365 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3366 in + sid_len + 61, cookie_len,
3367 cli_id, cli_id_len) == 0) {
3368 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3369 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003370 }
3371
3372 /*
3373 * If we get here, we've got an invalid cookie, let's prepare HVR.
3374 *
3375 * 0-0 ContentType type; copied
3376 * 1-2 ProtocolVersion version; copied
3377 * 3-4 uint16 epoch; copied
3378 * 5-10 uint48 sequence_number; copied
3379 * 11-12 uint16 length; olen - 13
3380 *
3381 * 13-13 HandshakeType msg_type; hello_verify_request
3382 * 14-16 uint24 length; olen - 25
3383 * 17-18 uint16 message_seq; copied
3384 * 19-21 uint24 fragment_offset; copied
3385 * 22-24 uint24 fragment_length; olen - 25
3386 *
3387 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3388 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3389 *
3390 * Minimum length is 28.
3391 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 if (buf_len < 28) {
3393 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3394 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003395
3396 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003397 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003398 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3399 obuf[25] = 0xfe;
3400 obuf[26] = 0xff;
3401
3402 /* Generate and write actual cookie */
3403 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3405 &p, obuf + buf_len,
3406 cli_id, cli_id_len) != 0) {
3407 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003408 }
3409
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003410 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003411
3412 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3416 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3417 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003418
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003420
Gilles Peskine449bd832023-01-11 14:50:10 +01003421 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003422}
3423
3424/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003425 * Handle possible client reconnect with the same UDP quadruplet
3426 * (RFC 6347 Section 4.2.8).
3427 *
3428 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3429 * that looks like a ClientHello.
3430 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003431 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003432 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003433 * - if the input looks like a ClientHello with a valid cookie,
3434 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003435 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003436 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003437 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003438 * This function is called (through ssl_check_client_reconnect()) when an
3439 * unexpected record is found in ssl_get_next_record(), which will discard the
3440 * record if we return 0, and bubble up the return value otherwise (this
3441 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3442 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003443 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003444MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003445static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003446{
Janos Follath865b3eb2019-12-16 11:46:15 +00003447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003448 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 if (ssl->conf->f_cookie_write == NULL ||
3451 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003452 /* If we can't use cookies to verify reachability of the peer,
3453 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003454 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3455 "can't check reconnect validity"));
3456 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003457 }
3458
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003459 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 ssl,
3461 ssl->cli_id, ssl->cli_id_len,
3462 ssl->in_buf, ssl->in_left,
3463 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003466
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003468 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3470 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3471 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003472 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003473 * If the error is permanent we'll catch it later,
3474 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3476 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003477 (void) send_ret;
3478
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003480 }
3481
Gilles Peskine449bd832023-01-11 14:50:10 +01003482 if (ret == 0) {
3483 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3484 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3485 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3486 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003487 }
3488
Gilles Peskine449bd832023-01-11 14:50:10 +01003489 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003490 }
3491
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003493}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003494#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003495
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003496MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003497static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003498{
Gilles Peskine449bd832023-01-11 14:50:10 +01003499 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003500 record_type != MBEDTLS_SSL_MSG_ALERT &&
3501 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003502 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3503 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003504 }
3505
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003507}
3508
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003509/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003510 * ContentType type;
3511 * ProtocolVersion version;
3512 * uint16 epoch; // DTLS only
3513 * uint48 sequence_number; // DTLS only
3514 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003515 *
3516 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003517 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003518 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3519 *
3520 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003521 * 1. proceed with the record if this function returns 0
3522 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3523 * 3. return CLIENT_RECONNECT if this function return that value
3524 * 4. drop the whole datagram if this function returns anything else.
3525 * Point 2 is needed when the peer is resending, and we have already received
3526 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003527 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003528MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003529static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3530 unsigned char *buf,
3531 size_t len,
3532 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003533{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003534 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003535
Hanno Beckere5e7e782019-07-11 12:29:35 +01003536 size_t const rec_hdr_type_offset = 0;
3537 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003538
Hanno Beckere5e7e782019-07-11 12:29:35 +01003539 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3540 rec_hdr_type_len;
3541 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Hanno Beckere5e7e782019-07-11 12:29:35 +01003543 size_t const rec_hdr_ctr_len = 8;
3544#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003545 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003546 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3547 rec_hdr_version_len;
3548
Hanno Beckera0e20d02019-05-15 14:03:01 +01003549#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003550 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3551 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003552 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003553#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3554#endif /* MBEDTLS_SSL_PROTO_DTLS */
3555
3556 size_t rec_hdr_len_offset; /* To be determined */
3557 size_t const rec_hdr_len_len = 2;
3558
3559 /*
3560 * Check minimum lengths for record header.
3561 */
3562
3563#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003564 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003565 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003566 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003567#endif /* MBEDTLS_SSL_PROTO_DTLS */
3568 {
3569 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3570 }
3571
Gilles Peskine449bd832023-01-11 14:50:10 +01003572 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3573 MBEDTLS_SSL_DEBUG_MSG(1,
3574 (
3575 "datagram of length %u too small to hold DTLS record header of length %u",
3576 (unsigned) len,
3577 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3578 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003579 }
3580
3581 /*
3582 * Parse and validate record content type
3583 */
3584
Gilles Peskine449bd832023-01-11 14:50:10 +01003585 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003586
3587 /* Check record content type */
3588#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3589 rec->cid_len = 0;
3590
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003593 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003594 /* Shift pointers to account for record header including CID
3595 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003596 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003597 * ProtocolVersion version;
3598 * uint16 epoch;
3599 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003600 * opaque cid[cid_length]; // Additional field compared to
3601 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003602 * uint16 length;
3603 * opaque enc_content[DTLSCiphertext.length];
3604 * } DTLSCiphertext;
3605 */
3606
3607 /* So far, we only support static CID lengths
3608 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003609 rec_hdr_cid_len = ssl->conf->cid_len;
3610 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003611
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3613 MBEDTLS_SSL_DEBUG_MSG(1,
3614 (
3615 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3616 (unsigned) len,
3617 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3618 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003619 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003620
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003621 /* configured CID len is guaranteed at most 255, see
3622 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3623 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003624 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3625 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003626#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003627 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003628 if (ssl_check_record_type(rec->type)) {
3629 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3630 (unsigned) rec->type));
3631 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003632 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003633 }
3634
Hanno Beckere5e7e782019-07-11 12:29:35 +01003635 /*
3636 * Parse and validate record version
3637 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003638 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3639 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003640 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3641 buf + rec_hdr_version_offset,
3642 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003643
Gilles Peskine449bd832023-01-11 14:50:10 +01003644 if (tls_version > ssl->conf->max_tls_version) {
3645 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3646 (unsigned) tls_version,
3647 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003648
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003650 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 /*
3652 * Parse/Copy record sequence number.
3653 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003654
Hanno Beckere5e7e782019-07-11 12:29:35 +01003655#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003657 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003658 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3659 rec_hdr_ctr_len);
3660 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003661#endif /* MBEDTLS_SSL_PROTO_DTLS */
3662 {
3663 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003665 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003666
Hanno Beckere5e7e782019-07-11 12:29:35 +01003667 /*
3668 * Parse record length.
3669 */
3670
Hanno Beckere5e7e782019-07-11 12:29:35 +01003671 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003672 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003674
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3676 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3677 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003678
3679 rec->buf = buf;
3680 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003681
Gilles Peskine449bd832023-01-11 14:50:10 +01003682 if (rec->data_len == 0) {
Gilles Peskine7c1dbef2025-03-07 20:48:01 +01003683 MBEDTLS_SSL_DEBUG_MSG(1, ("rejecting empty record"));
Gilles Peskine449bd832023-01-11 14:50:10 +01003684 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3685 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003686
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003687 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003688 * DTLS-related tests.
3689 * Check epoch before checking length constraint because
3690 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3691 * message gets duplicated before the corresponding Finished message,
3692 * the second ChangeCipherSpec should be discarded because it belongs
3693 * to an old epoch, but not because its length is shorter than
3694 * the minimum record length for packets using the new record transform.
3695 * Note that these two kinds of failures are handled differently,
3696 * as an unexpected record is silently skipped but an invalid
3697 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003698 */
3699#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003700 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003701 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702
Hanno Becker955a5c92019-07-10 17:12:07 +01003703 /* Check that the datagram is large enough to contain a record
3704 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003705 if (len < rec->data_offset + rec->data_len) {
3706 MBEDTLS_SSL_DEBUG_MSG(1,
3707 (
3708 "Datagram of length %u too small to contain record of advertised length %u.",
3709 (unsigned) len,
3710 (unsigned) (rec->data_offset + rec->data_len)));
3711 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003712 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003713
Hanno Becker37cfe732019-07-10 17:20:01 +01003714 /* Records from other, non-matching epochs are silently discarded.
3715 * (The case of same-port Client reconnects must be considered in
3716 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003717 if (rec_epoch != ssl->in_epoch) {
3718 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3719 "expected %u, received %lu",
3720 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003721
Hanno Becker552f7472019-07-19 10:59:12 +01003722 /* Records from the next epoch are considered for buffering
3723 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3725 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3726 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003727 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003728
Gilles Peskine449bd832023-01-11 14:50:10 +01003729 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003730 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003731#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003732 /* For records from the correct epoch, check whether their
3733 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3735 &rec->ctr[0]) != 0) {
3736 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3737 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003738 }
3739#endif
3740 }
3741#endif /* MBEDTLS_SSL_PROTO_DTLS */
3742
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003744}
Paul Bakker5121ce52009-01-03 21:22:43 +00003745
Paul Bakker5121ce52009-01-03 21:22:43 +00003746
Hanno Becker2fddd372019-07-10 14:37:41 +01003747#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003748MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003749static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003750{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003751 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003752
3753 /*
3754 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3755 * access the first byte of record content (handshake type), as we
3756 * have an active transform (possibly iv_len != 0), so use the
3757 * fact that the record header len is 13 instead.
3758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003760 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003761 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003762 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3763 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003764 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3765 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3766 "from the same port"));
3767 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003768 }
3769
Gilles Peskine449bd832023-01-11 14:50:10 +01003770 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003771}
Hanno Becker2fddd372019-07-10 14:37:41 +01003772#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003773
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003774/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003775 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003776 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003777MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003778static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3779 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003780{
3781 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003782
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3784 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003785
Ronald Cron7e38cba2021-11-24 12:43:39 +01003786 /*
3787 * In TLS 1.3, always treat ChangeCipherSpec records
3788 * as unencrypted. The only thing we do with them is
3789 * check the length and content and ignore them.
3790 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003791#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003792 if (ssl->transform_in != NULL &&
3793 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3794 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003795 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003796 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003797 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003798#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003799
Gilles Peskine449bd832023-01-11 14:50:10 +01003800 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003801 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003802
Gilles Peskine449bd832023-01-11 14:50:10 +01003803 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3804 rec)) != 0) {
3805 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003806
Ronald Cron2995d352024-01-18 16:59:39 +01003807#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3808 /*
3809 * Although the server rejected early data, it might receive early
3810 * data as long as it has not received the client Finished message.
3811 * It is encrypted with early keys and should be ignored as stated
3812 * in section 4.2.10 of RFC 8446:
3813 *
3814 * "Ignore the extension and return a regular 1-RTT response. The
3815 * server then skips past early data by attempting to deprotect
3816 * received records using the handshake traffic key, discarding
3817 * records which fail deprotection (up to the configured
3818 * max_early_data_size). Once a record is deprotected successfully,
3819 * it is treated as the start of the client's second flight and the
3820 * server proceeds as with an ordinary 1-RTT handshake."
3821 */
3822 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3823 (ssl->discard_early_data_record ==
3824 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3825 MBEDTLS_SSL_DEBUG_MSG(
3826 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003827
3828 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3829 if (ret != 0) {
3830 return ret;
3831 }
Ronald Cron2995d352024-01-18 16:59:39 +01003832 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3833 }
3834#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3835
Hanno Beckera0e20d02019-05-15 14:03:01 +01003836#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003837 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003838 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003839 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3840 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003841 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003842 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003844
Ronald Cron71c6e652024-02-05 16:48:10 +01003845 /*
3846 * The decryption of the record failed, no reason to ignore it,
3847 * return in error with the decryption error code.
3848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003849 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003850 }
3851
Ronald Cron2995d352024-01-18 16:59:39 +01003852#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3853 /*
3854 * If the server were discarding protected records that it fails to
3855 * deprotect because it has rejected early data, as we have just
3856 * deprotected successfully a record, the server has to resume normal
3857 * operation and fail the connection if the deprotection of a record
3858 * fails.
3859 */
3860 if (ssl->discard_early_data_record ==
3861 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3862 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3863 }
3864#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3865
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 if (old_msg_type != rec->type) {
3867 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3868 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003869 }
3870
Gilles Peskine449bd832023-01-11 14:50:10 +01003871 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3872 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003873
Hanno Beckera0e20d02019-05-15 14:03:01 +01003874#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003875 /* We have already checked the record content type
3876 * in ssl_parse_record_header(), failing or silently
3877 * dropping the record in the case of an unknown type.
3878 *
3879 * Since with the use of CIDs, the record content type
3880 * might change during decryption, re-check the record
3881 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003882 if (ssl_check_record_type(rec->type)) {
3883 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3884 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003885 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003886#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003887
Gilles Peskine449bd832023-01-11 14:50:10 +01003888 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003889#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3891 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003892 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003893 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3894 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003895 }
3896#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3897
3898 ssl->nb_zero++;
3899
3900 /*
3901 * Three or more empty messages may be a DoS attack
3902 * (excessive CPU consumption).
3903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003904 if (ssl->nb_zero > 3) {
3905 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3906 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003907 /* Treat the records as if they were not properly authenticated,
3908 * thereby failing the connection if we see more than allowed
3909 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003911 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003913 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003915
3916#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003918 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003920#endif
3921 {
3922 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3924 i > mbedtls_ssl_ep_len(ssl); i--) {
3925 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003926 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003928 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003929
3930 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 if (i == mbedtls_ssl_ep_len(ssl)) {
3932 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3933 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003934 }
3935 }
3936
Paul Bakker5121ce52009-01-03 21:22:43 +00003937 }
3938
Jerry Yuf57d14b2023-11-15 16:40:09 +08003939#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3940 /*
3941 * Although the server rejected early data because it needed to send an
3942 * HelloRetryRequest message, it might receive early data as long as it has
3943 * not received the client Finished message.
3944 * The early data is encrypted with early keys and should be ignored as
3945 * stated in section 4.2.10 of RFC 8446 (second case):
3946 *
3947 * "The server then ignores early data by skipping all records with an
3948 * external content type of "application_data" (indicating that they are
3949 * encrypted), up to the configured max_early_data_size. Ignore application
3950 * data message before 2nd ClientHello when early_data was received in 1st
3951 * ClientHello."
3952 */
3953 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3954 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003955
3956 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3957 if (ret != 0) {
3958 return ret;
3959 }
3960
Jerry Yuf57d14b2023-11-15 16:40:09 +08003961 MBEDTLS_SSL_DEBUG_MSG(
3962 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003963
Jerry Yuf57d14b2023-11-15 16:40:09 +08003964 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3965 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3966 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3967 }
3968 }
3969#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3970
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003971#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003972 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3973 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003974 }
3975#endif
3976
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003977 /* Check actual (decrypted) record content length against
3978 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003979 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
3980 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
3981 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003982 }
3983
Gilles Peskine449bd832023-01-11 14:50:10 +01003984 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003985}
3986
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003987/*
3988 * Read a record.
3989 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02003990 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
3991 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
3992 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02003993 */
Hanno Becker1097b342018-08-15 14:09:41 +01003994
3995/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003996MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003997static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003998MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003999static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004000MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004001static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4004 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004005{
Janos Follath865b3eb2019-12-16 11:46:15 +00004006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004011 do {
Simon Butcher99000142016-10-13 17:21:01 +01004012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 ret = ssl_consume_current_message(ssl);
4014 if (ret != 0) {
4015 return ret;
4016 }
Hanno Becker26994592018-08-15 14:14:59 +01004017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004019 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004020#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004021
Hanno Becker40f50842018-08-15 14:48:01 +01004022 /* We only check for buffered messages if the
4023 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4025 ssl_next_record_is_in_datagram(ssl) == 0) {
4026 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004027 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 }
Hanno Becker40f50842018-08-15 14:48:01 +01004029 }
4030
Hanno Becker40f50842018-08-15 14:48:01 +01004031#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 if (dtls_have_buffered == 0) {
4033 ret = ssl_get_next_record(ssl);
4034 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004035 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 }
Hanno Becker40f50842018-08-15 14:48:01 +01004037
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 if (ret != 0) {
4039 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4040 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004041 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004042 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004043 }
4044
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004046
Hanno Becker40f50842018-08-15 14:48:01 +01004047#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004049 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 ret = ssl_buffer_message(ssl);
4051 if (ret != 0) {
4052 return ret;
4053 }
Hanno Becker40f50842018-08-15 14:48:01 +01004054
4055 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4056 }
4057#endif /* MBEDTLS_SSL_PROTO_DTLS */
4058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4060 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (0 != ret) {
4063 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4064 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004065 }
4066
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4068 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004069 ret = mbedtls_ssl_update_handshake_status(ssl);
4070 if (0 != ret) {
4071 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4072 return ret;
4073 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004074 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 } else {
4076 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004077 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004078 }
4079
Gilles Peskine449bd832023-01-11 14:50:10 +01004080 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004083}
4084
Hanno Becker40f50842018-08-15 14:48:01 +01004085#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004087static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004088{
Gilles Peskine449bd832023-01-11 14:50:10 +01004089 if (ssl->in_left > ssl->next_record_offset) {
4090 return 1;
4091 }
Simon Butcher99000142016-10-13 17:21:01 +01004092
Gilles Peskine449bd832023-01-11 14:50:10 +01004093 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004094}
4095
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004096MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004097static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004098{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004099 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004100 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004101 int ret = 0;
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (hs == NULL) {
4104 return -1;
4105 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004108
Gilles Peskine449bd832023-01-11 14:50:10 +01004109 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4110 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004111 /* Check if we have seen a ChangeCipherSpec before.
4112 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if (!hs->buffering.seen_ccs) {
4114 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004115 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004116 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004117 }
4118
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004120 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4121 ssl->in_msglen = 1;
4122 ssl->in_msg[0] = 1;
4123
4124 /* As long as they are equal, the exact value doesn't matter. */
4125 ssl->in_left = 0;
4126 ssl->next_record_offset = 0;
4127
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004128 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004129 goto exit;
4130 }
Hanno Becker37f95322018-08-16 13:55:32 +01004131
Hanno Beckerb8f50142018-08-28 10:01:34 +01004132#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004133 /* Debug only */
4134 {
4135 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004137 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 if (hs_buf->is_valid == 1) {
4139 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4140 hs->in_msg_seq + offset,
4141 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004142 }
4143 }
4144 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004145#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004146
4147 /* Check if we have buffered and/or fully reassembled the
4148 * next handshake message. */
4149 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004151 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004152 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004153
4154 /* Double-check that we haven't accidentally buffered
4155 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004156 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4157 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4158 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004159 }
4160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4162 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4163 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004164
4165 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4166 ssl->in_hslen = msg_len + 12;
4167 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004169
4170 ret = 0;
4171 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 } else {
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01004173 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially buffered",
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004175 }
4176
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004177 ret = -1;
4178
4179exit:
4180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4182 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004183}
4184
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004185MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004186static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4187 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004188{
4189 int offset;
4190 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4192 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004193
Hanno Becker01315ea2018-08-21 17:22:17 +01004194 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004196
4197 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4199 hs->buffering.total_bytes_buffered)) {
4200 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4201 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004202 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004203
Hanno Becker4f432ad2018-08-28 10:02:32 +01004204 /* We don't have enough space to buffer the next expected handshake
4205 * message. Remove buffers used for future messages to gain space,
4206 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4208 offset >= 0; offset--) {
4209 MBEDTLS_SSL_DEBUG_MSG(2,
4210 (
4211 "Free buffering slot %d to make space for reassembly of next handshake message",
4212 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004215
4216 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4218 hs->buffering.total_bytes_buffered)) {
4219 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4220 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004221 }
4222 }
4223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004225}
4226
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004227MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004228static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004229{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004230 int ret = 0;
4231 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (hs == NULL) {
4234 return 0;
4235 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004238
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004240 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004242
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004243 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004244 break;
4245
4246 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004247 {
4248 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004249 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004250 mbedtls_ssl_hs_buffer *hs_buf;
4251 size_t msg_len = ssl->in_hslen - 12;
4252
4253 /* We should never receive an old handshake
4254 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4256 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4257 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004258 }
4259
4260 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004262 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 MBEDTLS_SSL_DEBUG_MSG(2,
4264 ("Ignore future HS message with sequence number %u, "
4265 "buffering window %u - %u",
4266 recv_msg_seq, ssl->handshake->in_msg_seq,
4267 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4268 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004269
4270 goto exit;
4271 }
4272
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4274 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004277
4278 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004280 size_t reassembly_buf_sz;
4281
Hanno Becker37f95322018-08-16 13:55:32 +01004282 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004284
4285 /* We copy the message back into the input buffer
4286 * after reassembly, so check that it's not too large.
4287 * This is an implementation-specific limitation
4288 * and not one from the standard, hence it is not
4289 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004291 /* Ignore message */
4292 goto exit;
4293 }
4294
Hanno Beckere0b150f2018-08-21 15:51:03 +01004295 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if (hs->buffering.total_bytes_buffered >
4297 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4298 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4299 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004300 }
4301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4303 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004304
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4306 hs->buffering.total_bytes_buffered)) {
4307 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004308 /* If we can't buffer a future message because
4309 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 MBEDTLS_SSL_DEBUG_MSG(2,
4311 ("Buffering of future message of size %"
4312 MBEDTLS_PRINTF_SIZET
4313 " would exceed the compile-time limit %"
4314 MBEDTLS_PRINTF_SIZET
4315 " (already %" MBEDTLS_PRINTF_SIZET
4316 " bytes buffered) -- ignore\n",
4317 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4318 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004319 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 } else {
4321 MBEDTLS_SSL_DEBUG_MSG(2,
4322 ("Buffering of future message of size %"
4323 MBEDTLS_PRINTF_SIZET
4324 " would exceed the compile-time limit %"
4325 MBEDTLS_PRINTF_SIZET
4326 " (already %" MBEDTLS_PRINTF_SIZET
4327 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4328 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4329 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004330 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4333 MBEDTLS_SSL_DEBUG_MSG(2,
4334 ("Reassembly of next message of size %"
4335 MBEDTLS_PRINTF_SIZET
4336 " (%" MBEDTLS_PRINTF_SIZET
4337 " with bitmap) would exceed"
4338 " the compile-time limit %"
4339 MBEDTLS_PRINTF_SIZET
4340 " (already %" MBEDTLS_PRINTF_SIZET
4341 " bytes buffered) -- fail\n",
4342 msg_len,
4343 reassembly_buf_sz,
4344 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4345 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004346 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4347 goto exit;
4348 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004349 }
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 MBEDTLS_SSL_DEBUG_MSG(2,
4352 ("initialize reassembly, total length = %"
4353 MBEDTLS_PRINTF_SIZET,
4354 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4357 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004358 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004359 goto exit;
4360 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004361 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004362
4363 /* Prepare final header: copy msg_type, length and message_seq,
4364 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 memcpy(hs_buf->data, ssl->in_msg, 6);
4366 memset(hs_buf->data + 6, 0, 3);
4367 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004368
4369 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004370
4371 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004373 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4375 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004376 /* Ignore */
4377 goto exit;
4378 }
4379 }
4380
Gilles Peskine449bd832023-01-11 14:50:10 +01004381 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004382 size_t frag_len, frag_off;
4383 unsigned char * const msg = hs_buf->data + 12;
4384
4385 /*
4386 * Check and copy current fragment
4387 */
4388
4389 /* Validation of header fields already done in
4390 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 frag_off = ssl_get_hs_frag_off(ssl);
4392 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4395 ", length = %" MBEDTLS_PRINTF_SIZET,
4396 frag_off, frag_len));
4397 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004400 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 ssl_bitmask_set(bitmask, frag_off, frag_len);
4402 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4403 msg_len) == 0);
4404 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004405 hs_buf->is_complete = 1;
4406 }
4407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4409 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004410 }
4411
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004412 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004413 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004414
4415 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004416 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004417 break;
4418 }
4419
4420exit:
4421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4423 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004424}
4425#endif /* MBEDTLS_SSL_PROTO_DTLS */
4426
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004427MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004428static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004429{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004430 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004431 * Consume last content-layer message and potentially
4432 * update in_msglen which keeps track of the contents'
4433 * consumption state.
4434 *
4435 * (1) Handshake messages:
4436 * Remove last handshake message, move content
4437 * and adapt in_msglen.
4438 *
4439 * (2) Alert messages:
4440 * Consume whole record content, in_msglen = 0.
4441 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004442 * (3) Change cipher spec:
4443 * Consume whole record content, in_msglen = 0.
4444 *
4445 * (4) Application data:
4446 * Don't do anything - the record layer provides
4447 * the application data as a stream transport
4448 * and consumes through mbedtls_ssl_read only.
4449 *
4450 */
4451
4452 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004454 /* Hard assertion to be sure that no application data
4455 * is in flight, as corrupting ssl->in_msglen during
4456 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 if (ssl->in_offt != NULL) {
4458 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4459 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004460 }
4461
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004462 if (ssl->in_hsfraglen != 0) {
4463 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004464 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4465 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4466 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004467 return 0;
4468 }
4469
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004470 /*
4471 * Get next Handshake message in the current record
4472 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004473
Hanno Becker4a810fb2017-05-24 16:27:30 +01004474 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004475 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004476 * current handshake content: If DTLS handshake
4477 * fragmentation is used, that's the fragment
4478 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004479 * size here is faulty and should be changed at
4480 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004481 * (2) While it doesn't seem to cause problems, one
4482 * has to be very careful not to assume that in_hslen
4483 * is always <= in_msglen in a sensible communication.
4484 * Again, it's wrong for DTLS handshake fragmentation.
4485 * The following check is therefore mandatory, and
4486 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004487 * Additionally, ssl->in_hslen might be arbitrarily out of
4488 * bounds after handling a DTLS message with an unexpected
4489 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004492 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4494 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004495 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4498 ssl->in_msg, ssl->in_msglen);
4499 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500 ssl->in_msglen = 0;
4501 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004502
Hanno Becker4a810fb2017-05-24 16:27:30 +01004503 ssl->in_hslen = 0;
4504 }
4505 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 else if (ssl->in_offt != NULL) {
4507 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004508 }
4509 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004511 ssl->in_msglen = 0;
4512 }
4513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004515}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004516
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004517MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004518static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004519{
Gilles Peskine449bd832023-01-11 14:50:10 +01004520 if (ssl->in_msglen > 0) {
4521 return 1;
4522 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004525}
4526
Hanno Becker5f066e72018-08-16 14:56:31 +01004527#if defined(MBEDTLS_SSL_PROTO_DTLS)
4528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004530{
4531 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004533 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004535
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004537 hs->buffering.total_bytes_buffered -=
4538 hs->buffering.future_record.len;
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004541 hs->buffering.future_record.data = NULL;
4542 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004543}
4544
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004545MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004546static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004547{
4548 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004550 size_t rec_len;
4551 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004552#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4553 size_t in_buf_len = ssl->in_buf_len;
4554#else
4555 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4556#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4558 return 0;
4559 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (hs == NULL) {
4562 return 0;
4563 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004564
Hanno Becker5f066e72018-08-16 14:56:31 +01004565 rec = hs->buffering.future_record.data;
4566 rec_len = hs->buffering.future_record.len;
4567 rec_epoch = hs->buffering.future_record.epoch;
4568
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (rec == NULL) {
4570 return 0;
4571 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004572
Hanno Becker4cb782d2018-08-20 11:19:05 +01004573 /* Only consider loading future records if the
4574 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4576 return 0;
4577 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004580
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (rec_epoch != ssl->in_epoch) {
4582 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004583 goto exit;
4584 }
4585
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004587
4588 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4590 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4591 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004592 }
4593
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004595 ssl->in_left = rec_len;
4596 ssl->next_record_offset = 0;
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004599
4600exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4602 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004603}
4604
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004605MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004606static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4607 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004608{
4609 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004610
4611 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 if (hs == NULL) {
4613 return 0;
4614 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004615
4616 /* Only buffer handshake records (we are only interested
4617 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4619 return 0;
4620 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004621
4622 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 if (hs->buffering.future_record.data != NULL) {
4624 return 0;
4625 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004626
Hanno Becker01315ea2018-08-21 17:22:17 +01004627 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4629 hs->buffering.total_bytes_buffered)) {
4630 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4631 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4632 " (already %" MBEDTLS_PRINTF_SIZET
4633 " bytes buffered) -- ignore\n",
4634 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4635 hs->buffering.total_bytes_buffered));
4636 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004637 }
4638
Hanno Becker5f066e72018-08-16 14:56:31 +01004639 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4641 ssl->in_epoch + 1U));
4642 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004643
4644 /* ssl_parse_record_header() only considers records
4645 * of the next epoch as candidates for buffering. */
4646 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004647 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004648
4649 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 mbedtls_calloc(1, hs->buffering.future_record.len);
4651 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004652 /* If we run out of RAM trying to buffer a
4653 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004655 }
4656
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004658
Hanno Becker519f15d2019-07-11 12:43:20 +01004659 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004661}
4662
4663#endif /* MBEDTLS_SSL_PROTO_DTLS */
4664
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004665MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004666static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004667{
Janos Follath865b3eb2019-12-16 11:46:15 +00004668 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004669 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004670
Hanno Becker5f066e72018-08-16 14:56:31 +01004671#if defined(MBEDTLS_SSL_PROTO_DTLS)
4672 /* We might have buffered a future record; if so,
4673 * and if the epoch matches now, load it.
4674 * On success, this call will set ssl->in_left to
4675 * the length of the buffered record, so that
4676 * the calls to ssl_fetch_input() below will
4677 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 ret = ssl_load_buffered_record(ssl);
4679 if (ret != 0) {
4680 return ret;
4681 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004682#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004683
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004684 /* Ensure that we have enough space available for the default form
4685 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4686 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4688 if (ret != 0) {
4689 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4690 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004691 }
4692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4694 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4697 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4698 ret = ssl_buffer_future_record(ssl, &rec);
4699 if (ret != 0) {
4700 return ret;
4701 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004702
4703 /* Fall through to handling of unexpected records */
4704 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4705 }
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004708#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004709 /* Reset in pointers to default state for TLS/DTLS records,
4710 * assuming no CID and no offset between record content and
4711 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004713
Hanno Becker7ae20e02019-07-12 08:33:49 +01004714 /* Setup internal message pointers from record structure. */
4715 ssl->in_msgtype = rec.type;
4716#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4717 ssl->in_len = ssl->in_cid + rec.cid_len;
4718#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4719 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4720 ssl->in_msglen = rec.data_len;
4721
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 ret = ssl_check_client_reconnect(ssl);
4723 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4724 if (ret != 0) {
4725 return ret;
4726 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004727#endif
4728
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004729 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004730 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4733 "(header)"));
4734 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004735 /* Skip invalid record and the rest of the datagram */
4736 ssl->next_record_offset = 0;
4737 ssl->in_left = 0;
4738
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4740 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004741 }
4742
4743 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4745 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004746#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004747 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004749 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004750 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004752#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004754 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004755 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->next_record_offset < ssl->in_left) {
4757 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004758 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004760#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004761 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004762 /*
4763 * Fetch record contents from underlying transport.
4764 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4766 if (ret != 0) {
4767 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4768 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004769 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004770
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004771 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004772 }
4773
4774 /*
4775 * Decrypt record contents.
4776 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004781 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004782 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004783 /* Except when waiting for Finished as a bad mac here
4784 * probably means something went wrong in the handshake
4785 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4787 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004788#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4790 mbedtls_ssl_send_alert_message(ssl,
4791 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4792 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004793 }
4794#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004796 }
4797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (ssl->conf->badmac_limit != 0 &&
4799 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4800 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4801 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004802 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004803
Hanno Becker4a810fb2017-05-24 16:27:30 +01004804 /* As above, invalid records cause
4805 * dismissal of the whole datagram. */
4806
4807 ssl->next_record_offset = 0;
4808 ssl->in_left = 0;
4809
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4811 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004812 }
4813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 return ret;
4815 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004816#endif
4817 {
4818 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004819#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4821 mbedtls_ssl_send_alert_message(ssl,
4822 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4823 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004824 }
4825#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004827 }
4828 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004829
Hanno Becker44d89b22019-07-12 09:40:44 +01004830
4831 /* Reset in pointers to default state for TLS/DTLS records,
4832 * assuming no CID and no offset between record content and
4833 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004835#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4836 ssl->in_len = ssl->in_cid + rec.cid_len;
4837#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004838 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004839
Hanno Becker8685c822019-07-12 09:37:30 +01004840 /* The record content type may change during decryption,
4841 * so re-read it. */
4842 ssl->in_msgtype = rec.type;
4843 /* Also update the input buffer, because unfortunately
4844 * the server-side ssl_parse_client_hello() reparses the
4845 * record header when receiving a ClientHello initiating
4846 * a renegotiation. */
4847 ssl->in_hdr[0] = rec.type;
4848 ssl->in_msg = rec.buf + rec.data_offset;
4849 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004853}
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004856{
Janos Follath865b3eb2019-12-16 11:46:15 +00004857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004858
Manuel Pégourié-Gonnarde26a0602025-03-05 12:52:18 +01004859 /* If we're in the middle of a fragmented TLS handshake message,
4860 * we don't accept any other message type. For TLS 1.3, the spec forbids
4861 * interleaving other message types between handshake fragments. For TLS
4862 * 1.2, the spec does not forbid it but we do. */
4863 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM &&
4864 ssl->in_hsfraglen != 0 &&
4865 ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
4866 MBEDTLS_SSL_DEBUG_MSG(1, ("non-handshake message in the middle"
4867 " of a fragmented handshake message"));
4868 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
4869 }
4870
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004871 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004872 * Handle particular types of records
4873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4875 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4876 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004877 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004878 }
4879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4881 if (ssl->in_msglen != 1) {
4882 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4883 ssl->in_msglen));
4884 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004885 }
4886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (ssl->in_msg[0] != 1) {
4888 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4889 ssl->in_msg[0]));
4890 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004891 }
4892
4893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004895 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4897 if (ssl->handshake == NULL) {
4898 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4899 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004900 }
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4903 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004904 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004905#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004906
Ronald Cron6f135e12021-12-08 16:57:54 +01004907#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004909 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4911 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004912 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004913#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004914 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4917 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004918 /* Note: Standard allows for more than one 2 byte alert
4919 to be packed in a single message, but Mbed TLS doesn't
4920 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4922 ssl->in_msglen));
4923 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004924 }
4925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4927 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004928
4929 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004930 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4933 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4934 ssl->in_msg[1]));
4935 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004936 }
4937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4939 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4940 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4941 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004942 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004943
4944#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4946 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4947 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004948 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004950 }
4951#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004952 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004953 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004954 }
4955
Hanno Beckerc76c6192017-06-06 10:03:17 +01004956#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004958 /* Drop unexpected ApplicationData records,
4959 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4961 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004962#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4964 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004965#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 ) {
4967 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4968 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004969 }
4970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 if (ssl->handshake != NULL &&
4972 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4973 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004974 }
4975 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004976#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004979}
4980
Gilles Peskine449bd832023-01-11 14:50:10 +01004981int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004982{
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 return mbedtls_ssl_send_alert_message(ssl,
4984 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4985 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004986}
4987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4989 unsigned char level,
4990 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00004991{
Janos Follath865b3eb2019-12-16 11:46:15 +00004992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00004993
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if (ssl == NULL || ssl->conf == NULL) {
4995 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4996 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 if (ssl->out_left != 0) {
4999 return mbedtls_ssl_flush_output(ssl);
5000 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5003 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005004
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005005 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005006 ssl->out_msglen = 2;
5007 ssl->out_msg[0] = level;
5008 ssl->out_msg[1] = message;
5009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5011 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5012 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005013 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005015
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005017}
5018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005020{
Janos Follath865b3eb2019-12-16 11:46:15 +00005021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005025 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005026 ssl->out_msglen = 1;
5027 ssl->out_msg[0] = 1;
5028
Gilles Peskinef670ba52025-03-07 15:09:32 +01005029 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5032 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5033 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005034 }
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005039}
5040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005042{
Janos Follath865b3eb2019-12-16 11:46:15 +00005043 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5048 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5049 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005050 }
5051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5053 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5054 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5055 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5056 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005057 }
5058
Hanno Beckere678eaa2018-08-21 14:57:46 +01005059 /* CCS records are only accepted if they have length 1 and content '1',
5060 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005061
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005062 /*
5063 * Switch to our negotiated transform and session parameters for inbound
5064 * data.
5065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005067#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005068 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005069#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005070 ssl->session_in = ssl->session_negotiate;
5071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005072#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005074#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005076#endif
5077
5078 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (++ssl->in_epoch == 0) {
5080 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005081 /* This is highly unlikely to happen for legitimate reasons, so
5082 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005084 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005086#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005090
Gilles Peskinef670ba52025-03-07 15:09:32 +01005091 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005092
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005096}
5097
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005098/* Once ssl->out_hdr as the address of the beginning of the
5099 * next outgoing record is set, deduce the other pointers.
5100 *
5101 * Note: For TLS, we save the implicit record sequence number
5102 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5103 * and the caller has to make sure there's space for this.
5104 */
5105
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005106static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005108{
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005110}
5111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5113 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005114{
5115#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005117 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005118#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005119 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005120 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005122 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005124#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005125 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005126#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005127 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005129#endif
5130 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005131 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005132#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005133 ssl->out_cid = ssl->out_len;
5134#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005135 ssl->out_iv = ssl->out_hdr + 5;
5136 }
5137
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005138 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005139 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (transform != NULL) {
5141 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5142 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005143}
5144
5145/* Once ssl->in_hdr as the address of the beginning of the
5146 * next incoming record is set, deduce the other pointers.
5147 *
5148 * Note: For TLS, we save the implicit record sequence number
5149 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5150 * and the caller has to make sure there's space for this.
5151 */
5152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005154{
Hanno Becker79594fd2019-05-08 09:38:41 +01005155 /* This function sets the pointers to match the case
5156 * of unprotected TLS/DTLS records, with both ssl->in_iv
5157 * and ssl->in_msg pointing to the beginning of the record
5158 * content.
5159 *
5160 * When decrypting a protected record, ssl->in_msg
5161 * will be shifted to point to the beginning of the
5162 * record plaintext.
5163 */
5164
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005165#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005167 /* This sets the header pointers to match records
5168 * without CID. When we receive a record containing
5169 * a CID, the fields are shifted accordingly in
5170 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005171 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005172#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005173 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005174 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005175#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005176 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005177#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005178 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005180#endif
5181 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005182 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005183 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005184#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005185 ssl->in_cid = ssl->in_len;
5186#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005187 ssl->in_iv = ssl->in_hdr + 5;
5188 }
5189
Hanno Becker79594fd2019-05-08 09:38:41 +01005190 /* This will be adjusted at record decryption time. */
5191 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005192}
5193
Paul Bakker5121ce52009-01-03 21:22:43 +00005194/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005195 * Setup an SSL context
5196 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005197
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005198void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5199{
5200#if defined(MBEDTLS_SSL_PROTO_DTLS)
5201 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5202 ssl->in_hdr = ssl->in_buf;
5203 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005204#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005205 {
5206 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5207 }
5208
5209 /* Derive other internal pointers. */
5210 mbedtls_ssl_update_in_pointers(ssl);
5211}
5212
5213void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005214{
5215 /* Set the incoming and outgoing record pointers. */
5216#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005218 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005220#endif /* MBEDTLS_SSL_PROTO_DTLS */
5221 {
Hanno Becker12078f42021-03-02 15:28:41 +00005222 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005223 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005224 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005225 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005227}
5228
Paul Bakker5121ce52009-01-03 21:22:43 +00005229/*
5230 * SSL get accessors
5231 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005232size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005233{
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005235}
5236
Gilles Peskine449bd832023-01-11 14:50:10 +01005237int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005238{
5239 /*
5240 * Case A: We're currently holding back
5241 * a message for further processing.
5242 */
5243
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 if (ssl->keep_current_message == 1) {
5245 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5246 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005247 }
5248
5249 /*
5250 * Case B: Further records are pending in the current datagram.
5251 */
5252
5253#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005254 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5255 ssl->in_left > ssl->next_record_offset) {
5256 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5257 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005258 }
5259#endif /* MBEDTLS_SSL_PROTO_DTLS */
5260
5261 /*
5262 * Case C: A handshake message is being processed.
5263 */
5264
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5266 MBEDTLS_SSL_DEBUG_MSG(3,
5267 ("ssl_check_pending: more handshake messages within current record"));
5268 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005269 }
5270
5271 /*
5272 * Case D: An application data message is being processed
5273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if (ssl->in_offt != NULL) {
5275 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5276 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005277 }
5278
5279 /*
5280 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005281 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005282 * we implement support for multiple alerts in single records.
5283 */
5284
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5286 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005287}
5288
Paul Bakker43ca69c2011-01-15 17:35:19 +00005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005291{
Hanno Becker3136ede2018-08-17 15:28:19 +01005292 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005293 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005294 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005295 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5296 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005297
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if (transform == NULL) {
5301 return (int) out_hdr_len;
5302 }
Hanno Becker78640902018-08-13 16:35:15 +01005303
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (transform->psa_alg == PSA_ALG_GCM ||
5306 transform->psa_alg == PSA_ALG_CCM ||
5307 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5308 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5309 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005310 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5312 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5313 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005314
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005316
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005317 /* Expansion due to the addition of the MAC. */
5318 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005319
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005320 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005321 * Theoretically up to 256 bytes, but we never use
5322 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005323 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005324
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005325 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005326 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005327#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005328 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005329#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 } else {
5331 MBEDTLS_SSL_DEBUG_MSG(1,
5332 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5333 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005334 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005335
Hanno Beckera0e20d02019-05-15 14:03:01 +01005336#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005338 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005340#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005343}
5344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005345#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005346/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005347 * Check record counters and renegotiate if they're above the limit.
5348 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005349MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005350static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005351{
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005353 int in_ctr_cmp;
5354 int out_ctr_cmp;
5355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005357 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5359 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005360 }
5361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5363 &ssl->conf->renego_period[ep_len],
5364 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5365 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005366 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005368
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5370 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005371 }
5372
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5374 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005375}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005377
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005378#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5379
Ronald Cron7df18bc2024-03-25 13:42:07 +01005380#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005381MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005382static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005383{
5384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5386 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005387 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005388 }
5389
Ronald Croncf47a152024-04-02 13:19:57 +02005390 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005391}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005392#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005393
Jerry Yua0446a02022-07-13 11:22:55 +08005394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005395static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005396{
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005399
Ronald Cron7df18bc2024-03-25 13:42:07 +01005400#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005402 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005403#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5404 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5405 ssl->keep_current_message = 1;
5406
5407 mbedtls_ssl_handshake_set_state(ssl,
5408 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5409 return MBEDTLS_ERR_SSL_WANT_READ;
5410#else
5411 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5412 return 0;
5413#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005414 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005415 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005416#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005417
5418 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005420}
5421#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5422
5423#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005424/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005425 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005426 * may only be sent for the purpose of initiating renegotiations.
5427 *
5428 * This function is introduced as a separate helper since the handling
5429 * of post-handshake handshake messages changes significantly in TLS 1.3,
5430 * and having a helper function allows to distinguish between TLS <= 1.2 and
5431 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5432 */
Jerry Yua0446a02022-07-13 11:22:55 +08005433MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005434static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005435{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005436 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005437
5438 /*
5439 * - For client-side, expect SERVER_HELLO_REQUEST.
5440 * - For server-side, expect CLIENT_HELLO.
5441 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5442 */
5443
5444#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5446 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5447 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5448 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005449
5450 /* With DTLS, drop the packet (probably from last handshake) */
5451#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5453 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005454 }
5455#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005457 }
5458#endif /* MBEDTLS_SSL_CLI_C */
5459
5460#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5462 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5463 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005464
5465 /* With DTLS, drop the packet (probably from last handshake) */
5466#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5468 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005469 }
5470#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005472 }
5473#endif /* MBEDTLS_SSL_SRV_C */
5474
5475#if defined(MBEDTLS_SSL_RENEGOTIATION)
5476 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5478 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5479 ssl->conf->allow_legacy_renegotiation ==
5480 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005481 /*
5482 * Accept renegotiation request
5483 */
5484
5485 /* DTLS clients need to know renego is server-initiated */
5486#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5488 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005489 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5490 }
5491#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 ret = mbedtls_ssl_start_renegotiation(ssl);
5493 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5494 ret != 0) {
5495 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5496 ret);
5497 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005498 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005500#endif /* MBEDTLS_SSL_RENEGOTIATION */
5501 {
5502 /*
5503 * Refuse renegotiation
5504 */
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5509 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5510 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5511 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005512 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005513 }
5514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005516}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005517#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5518
5519MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005520static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005521{
5522 /* Check protocol version and dispatch accordingly. */
5523#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5525 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005526 }
5527#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5528
5529#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5531 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005532 }
5533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5534
5535 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005537}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005538
Paul Bakker48916f92012-09-16 19:57:18 +00005539/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005540 * brief Read at most 'len' application data bytes from the input
5541 * buffer.
5542 *
5543 * param ssl SSL context:
5544 * - First byte of application data not read yet in the input
5545 * buffer located at address `in_offt`.
5546 * - The number of bytes of data not read yet is `in_msglen`.
5547 * param buf buffer that will hold the data
5548 * param len maximum number of bytes to read
5549 *
5550 * note The function updates the fields `in_offt` and `in_msglen`
5551 * according to the number of bytes read.
5552 *
5553 * return The number of bytes read.
5554 */
5555static int ssl_read_application_data(
5556 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5557{
5558 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5559
5560 if (len != 0) {
5561 memcpy(buf, ssl->in_offt, n);
5562 ssl->in_msglen -= n;
5563 }
5564
5565 /* Zeroising the plaintext buffer to erase unused application data
5566 from the memory. */
5567 mbedtls_platform_zeroize(ssl->in_offt, n);
5568
5569 if (ssl->in_msglen == 0) {
5570 /* all bytes consumed */
5571 ssl->in_offt = NULL;
5572 ssl->keep_current_message = 0;
5573 } else {
5574 /* more data available */
5575 ssl->in_offt += n;
5576 }
5577
5578 return (int) n;
5579}
5580
5581/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005582 * Receive application data decrypted from the SSL layer
5583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005584int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005585{
Janos Follath865b3eb2019-12-16 11:46:15 +00005586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005587
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 if (ssl == NULL || ssl->conf == NULL) {
5589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5590 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005591
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5596 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5597 return ret;
5598 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005599
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 if (ssl->handshake != NULL &&
5601 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5602 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5603 return ret;
5604 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005605 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005606 }
5607#endif
5608
Hanno Becker4a810fb2017-05-24 16:27:30 +01005609 /*
5610 * Check if renegotiation is necessary and/or handshake is
5611 * in process. If yes, perform/continue, and fall through
5612 * if an unexpected packet is received while the client
5613 * is waiting for the ServerHello.
5614 *
5615 * (There is no equivalent to the last condition on
5616 * the server-side as it is not treated as within
5617 * a handshake while waiting for the ClientHello
5618 * after a renegotiation request.)
5619 */
5620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005621#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 ret = ssl_check_ctr_renegotiate(ssl);
5623 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5624 ret != 0) {
5625 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5626 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005627 }
5628#endif
5629
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5631 ret = mbedtls_ssl_handshake(ssl);
5632 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5633 ret != 0) {
5634 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5635 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005636 }
5637 }
5638
Hanno Beckere41158b2017-10-23 13:30:32 +01005639 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005641 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 if (ssl->f_get_timer != NULL &&
5643 ssl->f_get_timer(ssl->p_timer) == -1) {
5644 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005645 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005646
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5648 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5649 return 0;
5650 }
Paul Bakker831a7552011-05-18 13:32:51 +00005651
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5653 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005654 }
5655
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (ssl->in_msglen == 0 &&
5657 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005658 /*
5659 * OpenSSL sends empty messages to randomize the IV
5660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5662 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5663 return 0;
5664 }
Paul Bakker831a7552011-05-18 13:32:51 +00005665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5667 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005668 }
5669 }
5670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5672 ret = ssl_handle_hs_message_post_handshake(ssl);
5673 if (ret != 0) {
5674 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5675 ret);
5676 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005677 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005678
Hanno Beckerf26cc722021-04-21 07:30:13 +01005679 /* At this point, we don't know whether the renegotiation triggered
5680 * by the post-handshake message has been completed or not. The cases
5681 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005682 * 1) The renegotiation is complete. In this case, no new record
5683 * has been read yet.
5684 * 2) The renegotiation is incomplete because the client received
5685 * an application data record while awaiting the ServerHello.
5686 * 3) The renegotiation is incomplete because the client received
5687 * a non-handshake, non-application data message while awaiting
5688 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005689 *
5690 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005691 * - For 1), the next iteration will read a new record and check
5692 * if it's application data.
5693 * - For 2), the loop condition isn't satisfied as application data
5694 * is present, hence continue is the same as break
5695 * - For 3), the loop condition is satisfied and read_record
5696 * will re-deliver the message that was held back by the client
5697 * when expecting the ServerHello.
5698 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005699
Hanno Becker90333da2017-10-10 11:27:13 +01005700 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005701 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005702#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5704 if (ssl->conf->renego_max_records >= 0) {
5705 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5706 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5707 "but not honored by client"));
5708 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005709 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005710 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005711 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005712#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005714 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5716 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5717 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005718 }
5719
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5721 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5722 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005723 }
5724
5725 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005726
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005727 /* We're going to return something now, cancel timer,
5728 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5730 mbedtls_ssl_set_timer(ssl, 0);
5731 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005732
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005733#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005734 /* If we requested renego but received AppData, resend HelloRequest.
5735 * Do it now, after setting in_offt, to avoid taking this branch
5736 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005737#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5739 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5740 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5741 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5742 ret);
5743 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005744 }
5745 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005747#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005748 }
5749
Jerry Yu739a1d42022-12-08 21:10:25 +08005750 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005751
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005753
Jerry Yu739a1d42022-12-08 21:10:25 +08005754 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005755}
5756
Jerry Yud9ca3542023-12-06 17:23:52 +08005757#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5758int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5759 unsigned char *buf, size_t len)
5760{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005761 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5763 }
5764
Ronald Cron164537c2024-02-01 18:05:47 +01005765 /*
5766 * The server may receive early data only while waiting for the End of
5767 * Early Data handshake message.
5768 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005769 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5770 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005771 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5772 }
5773
Ronald Croned7d4bf2024-01-31 07:55:19 +01005774 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005775}
5776#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5777
Paul Bakker5121ce52009-01-03 21:22:43 +00005778/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005779 * Send application data to be encrypted by the SSL layer, taking care of max
5780 * fragment length and buffer size.
5781 *
5782 * According to RFC 5246 Section 6.2.1:
5783 *
5784 * Zero-length fragments of Application data MAY be sent as they are
5785 * potentially useful as a traffic analysis countermeasure.
5786 *
5787 * Therefore, it is possible that the input message length is 0 and the
5788 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005789 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005790MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005791static int ssl_write_real(mbedtls_ssl_context *ssl,
5792 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005793{
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005795 const size_t max_len = (size_t) ret;
5796
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (ret < 0) {
5798 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5799 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005800 }
5801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5805 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5806 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5807 " > %" MBEDTLS_PRINTF_SIZET,
5808 len, max_len));
5809 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5810 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005811#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005813 }
Paul Bakker887bd502011-06-08 13:10:54 +00005814
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005816 /*
5817 * The user has previously tried to send the data and
5818 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5819 * written. In this case, we expect the high-level write function
5820 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5823 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5824 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005825 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005827 /*
5828 * The user is trying to send a message the first time, so we need to
5829 * copy the data into the internal buffers and setup the data structure
5830 * to keep track of partial writes
5831 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005832 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005833 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005834 if (len > 0) {
5835 memcpy(ssl->out_msg, buf, len);
5836 }
Paul Bakker887bd502011-06-08 13:10:54 +00005837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5839 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5840 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005841 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005842 }
5843
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005845}
5846
5847/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005848 * Write application data (public-facing wrapper)
5849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005850int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005851{
Janos Follath865b3eb2019-12-16 11:46:15 +00005852 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005853
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 if (ssl == NULL || ssl->conf == NULL) {
5857 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5858 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005859
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005860#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5862 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5863 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005864 }
5865#endif
5866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5868 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5869 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5870 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005871 }
5872 }
5873
Gilles Peskine449bd832023-01-11 14:50:10 +01005874 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005875
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879}
5880
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005881#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5882int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5883 const unsigned char *buf, size_t len)
5884{
5885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5886 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005887 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005888
5889 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5890
5891 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5893 }
5894
Ronald Cron49221902024-02-21 13:39:14 +01005895 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5896 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5897 }
5898
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005899 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5900 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5901 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5902 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5903 }
5904
5905 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5906 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5907 }
5908
5909 /*
Ronald Crond2884662024-03-03 15:03:22 +01005910 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005911 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005912 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005913 * enough to be able to send early data if possible. That way, we can
5914 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005915 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005916 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5917 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005918 * as the early data outbound transform has not been set as we may have to
5919 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005920 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005921 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005922 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005923 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005924 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005925 ret = mbedtls_ssl_handshake_step(ssl);
5926 if (ret != 0) {
5927 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5928 return ret;
5929 }
5930
5931 ret = mbedtls_ssl_flush_output(ssl);
5932 if (ret != 0) {
5933 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5934 return ret;
5935 }
5936 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005937 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005938 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005939 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005940 * If we are past the point where we can send early data or we have
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01005941 * already reached the maximum early data size, return immediately.
Ronald Cron62f971a2024-02-23 08:24:12 +01005942 * Otherwise, progress the handshake as much as possible to not delay
5943 * it too much. If we reach a point where we can still send early data,
5944 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005945 */
Ronald Crond2884662024-03-03 15:03:22 +01005946 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5947 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005948 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5949 }
5950
Ronald Cron62f971a2024-02-23 08:24:12 +01005951 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005952 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005953
5954 if (remaining == 0) {
5955 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5956 }
5957
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005958 ret = mbedtls_ssl_handshake(ssl);
5959 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5960 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5961 return ret;
5962 }
5963 }
5964
Ronald Crond2884662024-03-03 15:03:22 +01005965 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5966 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005967 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005968 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5969 }
5970
Ronald Cron62f971a2024-02-23 08:24:12 +01005971 if (len > remaining) {
5972 len = remaining;
5973 }
5974
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005975 ret = ssl_write_real(ssl, buf, len);
5976 if (ret >= 0) {
5977 ssl->total_early_data_size += ret;
5978 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005979
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005980 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005981
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005982 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005983}
5984#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
5985
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005986/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005987 * Notify the peer that the connection is being closed
5988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005989int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005990{
Janos Follath865b3eb2019-12-16 11:46:15 +00005991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (ssl == NULL || ssl->conf == NULL) {
5994 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5995 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005998
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6000 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6001 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6002 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6003 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6004 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006005 }
6006 }
6007
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006011}
6012
Gilles Peskine449bd832023-01-11 14:50:10 +01006013void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006014{
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006016 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 psa_destroy_key(transform->psa_key_enc);
6020 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006021
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006022#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 psa_destroy_key(transform->psa_mac_enc);
6024 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00006025#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006028}
6029
Gilles Peskine449bd832023-01-11 14:50:10 +01006030void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6031 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006032{
Jerry Yuc7875b52021-09-05 21:05:50 +08006033 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006035}
6036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6038 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006039{
6040 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006042}
6043
Hanno Becker0271f962018-08-16 13:23:47 +01006044#if defined(MBEDTLS_SSL_PROTO_DTLS)
6045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006047{
6048 unsigned offset;
6049 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006052 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 }
Hanno Becker0271f962018-08-16 13:23:47 +01006054
Gilles Peskine449bd832023-01-11 14:50:10 +01006055 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006056
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6058 ssl_buffering_free_slot(ssl, offset);
6059 }
Hanno Beckere605b192018-08-21 15:59:07 +01006060}
6061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6063 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006064{
6065 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6066 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006069 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006073 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006074 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006076 }
6077}
6078
6079#endif /* MBEDTLS_SSL_PROTO_DTLS */
6080
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006081/*
6082 * Convert version numbers to/from wire format
6083 * and, for DTLS, to/from TLS equivalent.
6084 *
6085 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006086 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006087 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006088 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006090void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6091 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006092{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006093 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006094#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006096 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006098 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006099#else
6100 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006101#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006102 {
6103 tls_version_formatted = (uint16_t) tls_version;
6104 }
6105 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006106}
6107
Gilles Peskine449bd832023-01-11 14:50:10 +01006108uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6109 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006110{
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006112#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006114 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6116 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006117#else
6118 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006119#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006120 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006121}
6122
Jerry Yue7047812021-09-13 19:26:39 +08006123/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006124 * Send pending fatal alert.
6125 * 0, No alert message.
6126 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6127 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006129int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006130{
6131 int ret;
6132
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006133 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 if (ssl->send_alert == 0) {
6135 return 0;
6136 }
Jerry Yu394ece62021-09-14 22:17:21 +08006137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 ret = mbedtls_ssl_send_alert_message(ssl,
6139 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6140 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006141
Jerry Yu3bf1f972021-09-22 21:37:18 +08006142 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6143 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006146 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006147 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 if (ret != 0) {
6150 return ret;
6151 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006154}
6155
Jerry Yu394ece62021-09-14 22:17:21 +08006156/*
6157 * Set pending fatal alert flag.
6158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006159void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6160 unsigned char alert_type,
6161 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006162{
6163 ssl->send_alert = 1;
6164 ssl->alert_type = alert_type;
6165 ssl->alert_reason = alert_reason;
6166}
6167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006168#endif /* MBEDTLS_SSL_TLS_C */