blob: 5eeb154047055535521202aa732e7547e0bcc4cd [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 // CID
716 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100717 cur += rec->cid_len;
718
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200719 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100720 *cur = rec->cid_len;
721 cur++;
722
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200723 // length of inner plaintext
724 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
725 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 } else
Ben Taylor4a438042025-07-11 09:47:39 +0100727#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200730 // epoch + sequence number
731 memcpy(cur, rec->ctr, sizeof(rec->ctr));
732 cur += sizeof(rec->ctr);
733
734 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200736 cur += rec->cid_len;
737
738 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100740 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100742#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100743 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100745 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100746 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100747
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000748 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000749}
750
Valerio Settie5707042023-10-11 11:54:42 +0200751#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200752MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100753static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100755{
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100757}
758
Hanno Becker17263802020-05-28 07:05:48 +0100759/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
760 *
761 * Concretely, this occurs in two variants:
762 *
763 * a) Fixed and dynamic IV lengths add up to total IV length, giving
764 * IV = fixed_iv || dynamic_iv
765 *
Hanno Becker15952812020-06-04 13:31:46 +0100766 * This variant is used in TLS 1.2 when used with GCM or CCM.
767 *
Hanno Becker17263802020-05-28 07:05:48 +0100768 * b) Fixed IV lengths matches total IV length, giving
769 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100770 *
771 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
772 *
773 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100774 *
775 * This function has the precondition that
776 *
777 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
778 *
779 * which has to be ensured by the caller. If this precondition
780 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100781 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100782static void ssl_build_record_nonce(unsigned char *dst_iv,
783 size_t dst_iv_len,
784 unsigned char const *fixed_iv,
785 size_t fixed_iv_len,
786 unsigned char const *dynamic_iv,
787 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100788{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100789 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 memset(dst_iv, 0, dst_iv_len);
791 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100792
Hanno Becker17263802020-05-28 07:05:48 +0100793 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100795}
Valerio Settie5707042023-10-11 11:54:42 +0200796#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100797
Gilles Peskine449bd832023-01-11 14:50:10 +0100798int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
799 mbedtls_ssl_transform *transform,
Ben Taylor602b2962025-03-07 15:52:50 +0000800 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +0000801{
Neil Armstrong136f8402022-03-30 10:58:01 +0200802 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100803 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200805 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 * the description of ssl_extract_add_data_from_record().
807 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
809 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
810#else
811 unsigned char add_data[13];
812#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100813 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000814 size_t post_avail;
815
816 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000817#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200818 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000819 ((void) ssl);
820#endif
821
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000823
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 if (transform == NULL) {
825 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
826 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000827 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100829 || rec->buf == NULL
830 || rec->buf_len < rec->data_offset
831 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100832#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100833 || rec->cid_len != 0
834#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 ) {
836 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
837 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100838 }
839
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200841
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000842 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
844 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
845 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
848 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
849 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
850 rec->data_len,
851 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000853 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100854
Hanno Becker92313402020-05-20 13:58:58 +0100855 /* The following two code paths implement the (D)TLSInnerPlaintext
856 * structure present in TLS 1.3 and DTLS 1.2 + CID.
857 *
858 * See ssl_build_inner_plaintext() for more information.
859 *
860 * Note that this changes `rec->data_len`, and hence
861 * `post_avail` needs to be recalculated afterwards.
862 *
863 * Note also that the two code paths cannot occur simultaneously
864 * since they apply to different versions of the protocol. There
865 * is hence no risk of double-addition of the inner plaintext.
866 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100867#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100869 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 ssl_compute_padding_length(rec->data_len,
871 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
872 if (ssl_build_inner_plaintext(data,
873 &rec->data_len,
874 post_avail,
875 rec->type,
876 padding) != 0) {
877 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100878 }
879
880 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
881 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100882#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100883
Hanno Beckera0e20d02019-05-15 14:03:01 +0100884#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100885 /*
886 * Add CID information
887 */
888 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100889 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
890 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100891
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100893 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 ssl_compute_padding_length(rec->data_len,
895 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100896 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100897 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100898 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100899 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100900 * Note that this changes `rec->data_len`, and hence
901 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100902 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 if (ssl_build_inner_plaintext(data,
904 &rec->data_len,
905 post_avail,
906 rec->type,
907 padding) != 0) {
908 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100909 }
910
911 rec->type = MBEDTLS_SSL_MSG_CID;
912 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100913#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100914
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100916
Paul Bakker5121ce52009-01-03 21:22:43 +0000917 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100918 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000919 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000920#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
922 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
923 if (post_avail < transform->maclen) {
924 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
925 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000926 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200927#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200928 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100929 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100930 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
931 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
932 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000933
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
935 transform->tls_version,
936 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
939 transform->psa_mac_alg);
940 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100941 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 status = psa_mac_update(&operation, add_data, add_data_len);
945 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100946 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 status = psa_mac_update(&operation, data, rec->data_len);
950 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100951 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
955 &sign_mac_length);
956 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100957 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000959
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200961#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
964 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200965
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000966 rec->data_len += transform->maclen;
967 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100968 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970hmac_failed_etm_disabled:
971 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500972 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 status = psa_mac_abort(&operation);
974 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500975 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 if (ret != 0) {
978 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
979 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100980 }
Paul Bakker577e0062013-08-28 11:57:20 +0200981 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000982#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000983
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200984 /*
985 * Encrypt
986 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000987#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
989 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
990 "including %d bytes of padding",
991 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +0000992
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100993 /* The only supported stream cipher is "NULL",
994 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +0000996#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +0000997
Valerio Settie5707042023-10-11 11:54:42 +0200998#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001000 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001001 unsigned char *dynamic_iv;
1002 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001003 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001005 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001007
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001008 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (post_avail < transform->taglen) {
1010 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1011 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001012 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001013
Paul Bakker68884e32013-01-07 18:20:04 +01001014 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001015 * Build nonce for AEAD encryption.
1016 *
1017 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1018 * part of the IV is prepended to the ciphertext and
1019 * can be chosen freely - in particular, it need not
1020 * agree with the record sequence number.
1021 * However, since ChaChaPoly as well as all AEAD modes
1022 * in TLS 1.3 use the record sequence number as the
1023 * dynamic part of the nonce, we uniformly use the
1024 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001025 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001026 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001028
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 ssl_build_record_nonce(iv, sizeof(iv),
1030 transform->iv_enc,
1031 transform->fixed_ivlen,
1032 dynamic_iv,
1033 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001034
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001035 /*
1036 * Build additional data for AEAD encryption.
1037 * This depends on the TLS version.
1038 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1040 transform->tls_version,
1041 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1044 iv, transform->ivlen);
1045 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1046 dynamic_iv,
1047 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1048 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1049 add_data, add_data_len);
1050 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1051 "including 0 bytes of padding",
1052 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001053
Paul Bakker68884e32013-01-07 18:20:04 +01001054 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001055 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 status = psa_aead_encrypt(transform->psa_key_enc,
1058 transform->psa_alg,
1059 iv, transform->ivlen,
1060 add_data, add_data_len,
1061 data, rec->data_len,
1062 data, rec->buf_len - (data - rec->buf),
1063 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001066 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1068 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001069 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001070
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1072 data + rec->data_len - transform->taglen,
1073 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001074 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001075 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001076
1077 /*
1078 * Prefix record content with dynamic IV in case it is explicit.
1079 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (dynamic_iv_is_explicit != 0) {
1081 if (rec->data_offset < dynamic_iv_len) {
1082 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1083 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001084 }
1085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001087 rec->data_offset -= dynamic_iv_len;
1088 rec->data_len += dynamic_iv_len;
1089 }
1090
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001091 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 } else
Valerio Settie5707042023-10-11 11:54:42 +02001093#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001094#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1096 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001097 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001098 size_t padlen, i;
1099 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001100 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001101 size_t part_len;
1102 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001103
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001104 /* Currently we're always using minimal padding
1105 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1107 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001108 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001109 }
1110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 /* Check there's enough space in the buffer for the padding. */
1112 if (post_avail < padlen + 1) {
1113 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1114 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1115 }
1116
1117 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001118 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001120
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001121 rec->data_len += padlen + 1;
1122 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001123
TRodziewicz0f82ec62021-05-12 17:49:18 +02001124#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001125 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001126 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001127 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001128 */
TRodziewicz345165c2021-07-06 13:42:11 +02001129
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (rec->data_offset < transform->ivlen) {
1131 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1132 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001133 }
1134
1135 /*
1136 * Generate IV
1137 */
Ben Taylor602b2962025-03-07 15:52:50 +00001138 ret = psa_generate_random(transform->iv_enc, transform->ivlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ret != 0) {
1140 return ret;
1141 }
TRodziewicz345165c2021-07-06 13:42:11 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001144#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1147 "including %"
1148 MBEDTLS_PRINTF_SIZET
1149 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1150 rec->data_len, transform->ivlen,
1151 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 status = psa_cipher_encrypt_setup(&cipher_op,
1154 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001157 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1159 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001160 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001161
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001165 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1167 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001168
1169 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 status = psa_cipher_update(&cipher_op,
1172 data, rec->data_len,
1173 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001176 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1178 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001179
1180 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001181
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 status = psa_cipher_finish(&cipher_op,
1183 data + olen, rec->data_len - olen,
1184 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001185
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001187 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1189 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001190
1191 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001192
1193 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001194
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (rec->data_len != olen) {
1196 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1197 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001198 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001199
TRodziewicz0f82ec62021-05-12 17:49:18 +02001200 data -= transform->ivlen;
1201 rec->data_offset -= transform->ivlen;
1202 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001206 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001207 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1208 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001209
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001210 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001211 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (post_avail < transform->maclen) {
1214 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1215 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001216 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001217
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 ssl_extract_add_data_from_record(add_data, &add_data_len,
1219 rec, transform->tls_version,
1220 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1223 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1224 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1226 transform->psa_mac_alg);
1227 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001228 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 status = psa_mac_update(&operation, add_data, add_data_len);
1232 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001233 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 status = psa_mac_update(&operation, data, rec->data_len);
1237 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001238 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001240
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1242 &sign_mac_length);
1243 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001244 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001246
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001248
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001249 rec->data_len += transform->maclen;
1250 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001251 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001252
Gilles Peskine449bd832023-01-11 14:50:10 +01001253hmac_failed_etm_enabled:
1254 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001255 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 status = psa_mac_abort(&operation);
1257 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001258 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 if (ret != 0) {
1261 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1262 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001263 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001264 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001267#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001268 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1270 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001271 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001272
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001273 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 if (auth_done != 1) {
1275 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1276 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001277 }
1278
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001282}
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1285 mbedtls_ssl_transform *transform,
1286 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001287{
Valerio Settie5707042023-10-11 11:54:42 +02001288#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001289 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001290#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001291 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001292 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001293
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001294 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001295#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001296 size_t padlen = 0;
1297 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001298#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001300 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 * the description of ssl_extract_add_data_from_record().
1302 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001303#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1304 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1305#else
1306 unsigned char add_data[13];
1307#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001308 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001309
Hanno Beckera18d1322018-01-03 14:27:32 +00001310#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001311 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001312 ((void) ssl);
1313#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1316 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001317 rec->buf == NULL ||
1318 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 rec->buf_len - rec->data_offset < rec->data_len) {
1320 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1321 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001322 }
1323
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001324 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Hanno Beckera0e20d02019-05-15 14:03:01 +01001327#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001328 /*
1329 * Match record's CID with incoming CID.
1330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (rec->cid_len != transform->in_cid_len ||
1332 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1333 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001334 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001335#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001336
Hanno Beckerd086bf02021-03-22 13:01:27 +00001337#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001339 if (rec->data_len < transform->maclen) {
1340 MBEDTLS_SSL_DEBUG_MSG(1,
1341 ("Record too short for MAC:"
1342 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1343 rec->data_len, transform->maclen));
1344 return MBEDTLS_ERR_SSL_INVALID_MAC;
1345 }
1346
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001347 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001348 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001349 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001350#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001351#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001353 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001354 unsigned char *dynamic_iv;
1355 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001357
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001358 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001359 * Extract dynamic part of nonce for AEAD decryption.
1360 *
1361 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1362 * part of the IV is prepended to the ciphertext and
1363 * can be chosen freely - in particular, it need not
1364 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 dynamic_iv_len = sizeof(rec->ctr);
1367 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1368 if (rec->data_len < dynamic_iv_len) {
1369 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1370 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1371 rec->data_len,
1372 dynamic_iv_len));
1373 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001374 }
1375 dynamic_iv = data;
1376
1377 data += dynamic_iv_len;
1378 rec->data_offset += dynamic_iv_len;
1379 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001381 dynamic_iv = rec->ctr;
1382 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001383
1384 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 if (rec->data_len < transform->taglen) {
1386 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1387 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1388 rec->data_len,
1389 transform->taglen));
1390 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001391 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001392 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001393
Hanno Beckerdf8be222020-05-21 15:30:57 +01001394 /*
1395 * Prepare nonce from dynamic and static parts.
1396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 ssl_build_record_nonce(iv, sizeof(iv),
1398 transform->iv_dec,
1399 transform->fixed_ivlen,
1400 dynamic_iv,
1401 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001402
Hanno Beckerdf8be222020-05-21 15:30:57 +01001403 /*
1404 * Build additional data for AEAD encryption.
1405 * This depends on the TLS version.
1406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1408 transform->tls_version,
1409 transform->taglen);
1410 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1411 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001412
Hanno Beckerd96a6522019-07-10 13:55:25 +01001413 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001414 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001415 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001416 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001417 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1420 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1421 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001422
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001423 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001424 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001425 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 status = psa_aead_decrypt(transform->psa_key_dec,
1427 transform->psa_alg,
1428 iv, transform->ivlen,
1429 add_data, add_data_len,
1430 data, rec->data_len + transform->taglen,
1431 data, rec->buf_len - (data - rec->buf),
1432 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001433
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001435 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1437 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001438 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001439
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001440 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001441
Hanno Beckerd96a6522019-07-10 13:55:25 +01001442 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 if (olen != rec->data_len) {
1444 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1445 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001446 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 } else
Valerio Settie5707042023-10-11 11:54:42 +02001448#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001449#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1451 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001452 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001453 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001454 size_t part_len;
1455 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001456
Paul Bakker5121ce52009-01-03 21:22:43 +00001457 /*
Paul Bakker45829992013-01-03 14:52:21 +01001458 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001459 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001460#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001461 /* The ciphertext is prefixed with the CBC IV. */
1462 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001463#endif
Paul Bakker45829992013-01-03 14:52:21 +01001464
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001465 /* Size considerations:
1466 *
1467 * - The CBC cipher text must not be empty and hence
1468 * at least of size transform->ivlen.
1469 *
1470 * Together with the potential IV-prefix, this explains
1471 * the first of the two checks below.
1472 *
1473 * - The record must contain a MAC, either in plain or
1474 * encrypted, depending on whether Encrypt-then-MAC
1475 * is used or not.
1476 * - If it is, the message contains the IV-prefix,
1477 * the CBC ciphertext, and the MAC.
1478 * - If it is not, the padded plaintext, and hence
1479 * the CBC ciphertext, has at least length maclen + 1
1480 * because there is at least the padding length byte.
1481 *
1482 * As the CBC ciphertext is not empty, both cases give the
1483 * lower bound minlen + maclen + 1 on the record size, which
1484 * we test for in the second check below.
1485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 if (rec->data_len < minlen + transform->ivlen ||
1487 rec->data_len < minlen + transform->maclen + 1) {
1488 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1489 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1490 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1491 "+ 1 ) ( + expl IV )",
1492 rec->data_len,
1493 transform->ivlen,
1494 transform->maclen));
1495 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001496 }
1497
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001498 /*
1499 * Authenticate before decrypt if enabled
1500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001503 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001504
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001506
Hanno Beckerd96a6522019-07-10 13:55:25 +01001507 /* Update data_len in tandem with add_data.
1508 *
1509 * The subtraction is safe because of the previous check
1510 * data_len >= minlen + maclen + 1.
1511 *
1512 * Afterwards, we know that data + data_len is followed by at
1513 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001514 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001515 *
1516 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001517 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1519 transform->tls_version,
1520 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001521
Hanno Beckerd96a6522019-07-10 13:55:25 +01001522 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1524 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1526 transform->psa_mac_alg);
1527 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001528 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001530
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 status = psa_mac_update(&operation, add_data, add_data_len);
1532 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001533 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001535
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 status = psa_mac_update(&operation, data, rec->data_len);
1537 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001538 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001540
1541 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1543 transform->maclen);
1544 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001545 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001547 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001550 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 status = psa_mac_abort(&operation);
1552 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001553 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 if (ret != 0) {
1556 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1557 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1558 }
1559 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001560 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001561 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001563
1564 /*
1565 * Check length sanity
1566 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001567
1568 /* We know from above that data_len > minlen >= 0,
1569 * so the following check in particular implies that
1570 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 if (rec->data_len % transform->ivlen != 0) {
1572 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1573 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1574 rec->data_len, transform->ivlen));
1575 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001576 }
1577
TRodziewicz0f82ec62021-05-12 17:49:18 +02001578#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001579 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001580 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001581 */
TRodziewicz345165c2021-07-06 13:42:11 +02001582 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001584
TRodziewicz345165c2021-07-06 13:42:11 +02001585 data += transform->ivlen;
1586 rec->data_offset += transform->ivlen;
1587 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001588#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001589
Hanno Beckerd96a6522019-07-10 13:55:25 +01001590 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 status = psa_cipher_decrypt_setup(&cipher_op,
1593 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001596 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1598 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001599 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001600
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001602
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001604 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1606 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001607 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 status = psa_cipher_update(&cipher_op,
1610 data, rec->data_len,
1611 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001614 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1616 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001617 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 status = psa_cipher_finish(&cipher_op,
1620 data + olen, rec->data_len - olen,
1621 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001624 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1626 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001627 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001628
1629 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001630
Hanno Beckerd96a6522019-07-10 13:55:25 +01001631 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 if (rec->data_len != olen) {
1633 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1634 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001635 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001636
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001637 /* Safe since data_len >= minlen + maclen + 1, so after having
1638 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001639 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1640 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001641 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001644 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 rec->data_len,
1646 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001647 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001648 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 if (rec->data_len < transform->maclen + padlen + 1) {
1652 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1653 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1654 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1655 rec->data_len,
1656 transform->maclen,
1657 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001658 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001659#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001660 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 rec->data_len,
1662 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001663 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001664 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001665 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001666
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001667 padlen++;
1668
1669 /* Regardless of the validity of the padding,
1670 * we have data_len >= padlen here. */
1671
TRodziewicz0f82ec62021-05-12 17:49:18 +02001672#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001673 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 * consecutive memory reads at the end of the record
1675 * plaintext buffer. In order to hide the length and
1676 * validity of the padding, always perform exactly
1677 * `min(256,plaintext_len)` reads (but take into account
1678 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001679 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001681
1682 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001684 size_t const padding_idx = rec->data_len - padlen;
1685 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1686 size_t const start_idx = rec->data_len - num_checks;
1687 size_t idx;
1688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001690 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 * (check[idx] == padlen - 1);
1692 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001693 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001694 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001695 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001696 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001697 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001698 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001699 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001702 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1704 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001705#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001706 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001707
TRodziewicz0f82ec62021-05-12 17:49:18 +02001708#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001709
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001710 /* If the padding was found to be invalid, padlen == 0
1711 * and the subtraction is safe. If the padding was found valid,
1712 * padlen hasn't been changed and the previous assertion
1713 * data_len >= padlen still holds. */
1714 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001716#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001717 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1719 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001720 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001722#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1724 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001725#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001726
1727 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001728 * Authenticate if not done yet.
1729 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001730 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001731#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001733 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1734 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001735
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001736 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001737 * data_len < maclen + padlen + 1, then padlen
1738 * got reset to 1, and the initial check
1739 * data_len >= minlen + maclen + 1
1740 * guarantees that at this point we still
1741 * have at least data_len >= maclen.
1742 *
1743 * If the initial value of padlen was such that
1744 * data_len >= maclen + padlen + 1, then we have
1745 * subtracted either padlen + 1 (if the padding was correct)
1746 * or 0 (if the padding was incorrect) since then,
1747 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001748 *
1749 * For stream ciphers, we checked above that
1750 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001751 */
1752 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1754 transform->tls_version,
1755 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001756
TRodziewicz0f82ec62021-05-12 17:49:18 +02001757#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001758 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 * The next two sizes are the minimum and maximum values of
1760 * data_len over all padlen values.
1761 *
1762 * They're independent of padlen, since we previously did
1763 * data_len -= padlen.
1764 *
1765 * Note that max_len + maclen is never more than the buffer
1766 * length, as we previously did in_msglen -= maclen too.
1767 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001768 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001770
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1772 transform->psa_mac_alg,
1773 add_data, add_data_len,
1774 data, rec->data_len, min_len, max_len,
1775 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 if (ret != 0) {
1777 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001778 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001779 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ct_memcpy_offset(mac_peer, data,
1782 rec->data_len,
1783 min_len, max_len,
1784 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001785#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001786
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001787#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1789 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001790#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1793 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001796#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001797 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001798 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001799 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801hmac_failed_etm_disabled:
1802 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1803 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1804 if (ret != 0) {
1805 return ret;
1806 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001807 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001808
1809 /*
1810 * Finally check the correct flag
1811 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001812 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 return MBEDTLS_ERR_SSL_INVALID_MAC;
1814 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001815#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001816
1817 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 if (auth_done != 1) {
1819 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1820 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001821 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001822
Ronald Cron6f135e12021-12-08 16:57:54 +01001823#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001825 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1827 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (ret != 0) {
1830 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1831 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001832 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001833#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001834
Hanno Beckera0e20d02019-05-15 14:03:01 +01001835#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (rec->cid_len != 0) {
1837 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1838 &rec->type);
1839 if (ret != 0) {
1840 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1841 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001842 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001848}
1849
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001850#undef MAC_NONE
1851#undef MAC_PLAINTEXT
1852#undef MAC_CIPHERTEXT
1853
Paul Bakker5121ce52009-01-03 21:22:43 +00001854/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001855 * Fill the input message buffer by appending data to it.
1856 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001857 *
1858 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1859 * available (from this read and/or a previous one). Otherwise, an error code
1860 * is returned (possibly EOF or WANT_READ).
1861 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001862 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1863 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1864 * since we always read a whole datagram at once.
1865 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001866 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001867 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001869int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001870{
Janos Follath865b3eb2019-12-16 11:46:15 +00001871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001872 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001873#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1874 size_t in_buf_len = ssl->in_buf_len;
1875#else
1876 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1877#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1882 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1883 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001884 }
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1887 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1888 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001889 }
1890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001893 uint32_t timeout;
1894
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001895 /*
1896 * The point is, we need to always read a full datagram at once, so we
1897 * sometimes read more then requested, and handle the additional data.
1898 * It could be the rest of the current record (while fetching the
1899 * header) and/or some other records in the same datagram.
1900 */
1901
1902 /*
1903 * Move to the next record in the already read datagram if applicable
1904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 if (ssl->next_record_offset != 0) {
1906 if (ssl->in_left < ssl->next_record_offset) {
1907 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1908 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001909 }
1910
1911 ssl->in_left -= ssl->next_record_offset;
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (ssl->in_left != 0) {
1914 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1915 MBEDTLS_PRINTF_SIZET,
1916 ssl->next_record_offset));
1917 memmove(ssl->in_hdr,
1918 ssl->in_hdr + ssl->next_record_offset,
1919 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001920 }
1921
1922 ssl->next_record_offset = 0;
1923 }
1924
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1926 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1927 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001928
1929 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001930 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 if (nb_want <= ssl->in_left) {
1933 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1934 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001935 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001936
1937 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001938 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001939 * are not at the beginning of a new record, the caller did something
1940 * wrong.
1941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (ssl->in_left != 0) {
1943 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1944 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001945 }
1946
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001947 /*
1948 * Don't even try to read if time's out already.
1949 * This avoids by-passing the timer when repeatedly receiving messages
1950 * that will end up being dropped.
1951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (mbedtls_ssl_check_timer(ssl) != 0) {
1953 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001954 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001956 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001959 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001961 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001965
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 if (ssl->f_recv_timeout != NULL) {
1967 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1968 timeout);
1969 } else {
1970 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1971 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001974
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (ret == 0) {
1976 return MBEDTLS_ERR_SSL_CONN_EOF;
1977 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001978 }
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1981 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
1982 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
1985 if (ssl_double_retransmit_timeout(ssl) != 0) {
1986 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
1987 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001988 }
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
1991 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
1992 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001993 }
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02001996 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
1999 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2000 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2001 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2002 ret);
2003 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002004 }
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002007 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002009 }
2010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (ret < 0) {
2012 return ret;
2013 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002014
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002015 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002017#endif
2018 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2020 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2021 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002024 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002027 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 } else {
2029 if (ssl->f_recv_timeout != NULL) {
2030 ret = ssl->f_recv_timeout(ssl->p_bio,
2031 ssl->in_hdr + ssl->in_left, len,
2032 ssl->conf->read_timeout);
2033 } else {
2034 ret = ssl->f_recv(ssl->p_bio,
2035 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002036 }
2037 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2040 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2041 ssl->in_left, nb_want));
2042 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002043
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 if (ret == 0) {
2045 return MBEDTLS_ERR_SSL_CONN_EOF;
2046 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ret < 0) {
2049 return ret;
2050 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002051
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002052 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 MBEDTLS_SSL_DEBUG_MSG(1,
2054 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2055 " were requested",
2056 ret, len));
2057 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002058 }
2059
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002060 ssl->in_left += ret;
2061 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002062 }
2063
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002067}
2068
2069/*
2070 * Flush any data not yet written
2071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002072int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002073{
Janos Follath865b3eb2019-12-16 11:46:15 +00002074 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002075 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002076
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002078
Gilles Peskine449bd832023-01-11 14:50:10 +01002079 if (ssl->f_send == NULL) {
2080 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002082 }
2083
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002084 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (ssl->out_left == 0) {
2086 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2087 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002088 }
2089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 while (ssl->out_left > 0) {
2091 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2092 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2093 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002094
Hanno Becker2b1e3542018-08-06 11:19:13 +01002095 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (ret <= 0) {
2101 return ret;
2102 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002104 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 MBEDTLS_SSL_DEBUG_MSG(1,
2106 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2107 " bytes were sent",
2108 ret, ssl->out_left));
2109 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002110 }
2111
Paul Bakker5121ce52009-01-03 21:22:43 +00002112 ssl->out_left -= ret;
2113 }
2114
Hanno Becker2b1e3542018-08-06 11:19:13 +01002115#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002117 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002119#endif
2120 {
2121 ssl->out_hdr = ssl->out_buf + 8;
2122 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002128}
2129
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002130/*
2131 * Functions to handle the DTLS retransmission state machine
2132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002134/*
2135 * Append current handshake message to current outgoing flight
2136 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002138static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002139{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2142 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2143 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144
2145 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2147 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2148 sizeof(mbedtls_ssl_flight_item)));
2149 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002150 }
2151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2153 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2154 ssl->out_msglen));
2155 mbedtls_free(msg);
2156 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002157 }
2158
2159 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002161 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002162 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002163 msg->next = NULL;
2164
2165 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002167 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002171 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002173 cur->next = msg;
2174 }
2175
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2177 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002178}
2179
2180/*
2181 * Free the current flight of handshake messages
2182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002183void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002184{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 mbedtls_ssl_flight_item *cur = flight;
2186 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002189 next = cur->next;
2190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 mbedtls_free(cur->p);
2192 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193
2194 cur = next;
2195 }
2196}
2197
2198/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002199 * Swap transform_out and out_ctr with the alternative ones
2200 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002201MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002202static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002203{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002205 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2208 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2209 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002210 }
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002213
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002214 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002215 tmp_transform = ssl->transform_out;
2216 ssl->transform_out = ssl->handshake->alt_transform_out;
2217 ssl->handshake->alt_transform_out = tmp_transform;
2218
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002219 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2221 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2222 sizeof(ssl->cur_out_ctr));
2223 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2224 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002225
2226 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002230}
2231
2232/*
2233 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002236{
2237 int ret = 0;
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002246}
2247
2248/*
2249 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002250 *
2251 * Need to remember the current message in case flush_output returns
2252 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002253 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002255int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002256{
Janos Follath865b3eb2019-12-16 11:46:15 +00002257 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2261 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002262
2263 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002264 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 ret = ssl_swap_epochs(ssl);
2266 if (ret != 0) {
2267 return ret;
2268 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002271 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002274 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002275 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002276
Hanno Beckere1dcb032018-08-17 16:47:58 +01002277 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2279 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002280
Ronald Cron00d012f22022-03-08 15:57:12 +01002281 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002283
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002284 /* Swap epochs before sending Finished: we can't do it after
2285 * sending ChangeCipherSpec, in case write returns WANT_READ.
2286 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002287 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2288 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2289 ret = ssl_swap_epochs(ssl);
2290 if (ret != 0) {
2291 return ret;
2292 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002293 }
2294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 ret = ssl_get_remaining_payload_in_datagram(ssl);
2296 if (ret < 0) {
2297 return ret;
2298 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002299 max_frag_len = (size_t) ret;
2300
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002301 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2303 if (max_frag_len == 0) {
2304 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2305 return ret;
2306 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002307
2308 continue;
2309 }
2310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002312 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002313 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002314
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002315 /* Update position inside current message */
2316 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002318 const unsigned char * const p = ssl->handshake->cur_msg_p;
2319 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002320 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002321 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002322 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2325 if (is_finished) {
2326 ret = ssl_swap_epochs(ssl);
2327 if (ret != 0) {
2328 return ret;
2329 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002330 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2333 return ret;
2334 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002335
2336 continue;
2337 }
2338 max_hs_frag_len = max_frag_len - 12;
2339
2340 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2344 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2345 (unsigned) cur_hs_frag_len,
2346 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002347 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002348
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002349 /* Messages are stored with handshake headers as if not fragmented,
2350 * copy beginning of headers then fill fragmentation fields.
2351 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2355 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2356 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2359 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2360 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002361
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002363
Hanno Becker3f7b9732018-08-28 09:53:25 +01002364 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002366 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002367 ssl->out_msgtype = cur->type;
2368
2369 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002370 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002371 }
2372
2373 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2375 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002376 ssl->handshake->cur_msg = cur->next;
2377 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002379 ssl->handshake->cur_msg = NULL;
2380 ssl->handshake->cur_msg_p = NULL;
2381 }
2382 }
2383
2384 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2386 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2387 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002388 }
2389 }
2390
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2392 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002393 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 /* Update state and set timer */
2396 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2397 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2398 } else {
2399 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2400 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2401 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2404
2405 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002406}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002407
2408/*
2409 * To be called when the last message of an incoming flight is received.
2410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002411void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002412{
2413 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002415 ssl->handshake->flight = NULL;
2416 ssl->handshake->cur_msg = NULL;
2417
2418 /* The next incoming flight will start with this msg_seq */
2419 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2420
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002421 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002422 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002423
Hanno Becker0271f962018-08-16 13:23:47 +01002424 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002426
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002427 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2431 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002436}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002437
2438/*
2439 * To be called when the last message of an outgoing flight is send.
2440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002442{
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 ssl_reset_retransmit_timeout(ssl);
2444 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2447 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002452}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002453#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002454
Paul Bakker5121ce52009-01-03 21:22:43 +00002455/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002456 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002457 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002458int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002460{
2461 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002462 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002463 * ...
2464 * HandshakeType msg_type;
2465 * uint24 length;
2466 * ...
2467 */
2468 *buf = ssl->out_msg + 4;
2469 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2470
2471 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2472 ssl->out_msg[0] = hs_type;
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002475}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002476
2477/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002478 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002479 *
2480 * - fill in handshake headers
2481 * - update handshake checksum
2482 * - DTLS: save message for resending
2483 * - then pass to the record layer
2484 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002485 * DTLS: except for HelloRequest, messages are only queued, and will only be
2486 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002487 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002488 * Inputs:
2489 * - ssl->out_msglen: 4 + actual handshake message len
2490 * (4 is the size of handshake headers for TLS)
2491 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2492 * - ssl->out_msg + 4: the handshake message body
2493 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002494 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002495 * - ssl->out_msglen: the length of the record contents
2496 * (including handshake headers but excluding record headers)
2497 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002498 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002499int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2500 int update_checksum,
2501 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002502{
Janos Follath865b3eb2019-12-16 11:46:15 +00002503 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002504 const size_t hs_len = ssl->out_msglen - 4;
2505 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002508
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002509 /*
2510 * Sanity checks
2511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2513 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2514 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2515 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002516 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002517
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002518 /* Whenever we send anything different from a
2519 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2521 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2522 ssl->handshake == NULL) {
2523 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2524 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002525 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002526
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002529 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2531 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2532 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002533 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002534#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002535
Hanno Beckerb50a2532018-08-06 11:52:54 +01002536 /* Double-check that we did not exceed the bounds
2537 * of the outgoing record buffer.
2538 * This should never fail as the various message
2539 * writing functions must obey the bounds of the
2540 * outgoing record buffer, but better be safe.
2541 *
2542 * Note: We deliberately do not check for the MTU or MFL here.
2543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2545 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2546 "size %" MBEDTLS_PRINTF_SIZET
2547 ", maximum %" MBEDTLS_PRINTF_SIZET,
2548 ssl->out_msglen,
2549 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2550 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002551 }
2552
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002553 /*
2554 * Fill handshake headers
2555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2557 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2558 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2559 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002560
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002561 /*
2562 * DTLS has additional fields in the Handshake layer,
2563 * between the length field and the actual payload:
2564 * uint16 message_seq;
2565 * uint24 fragment_offset;
2566 * uint24 fragment_length;
2567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002570 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2572 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2573 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2574 MBEDTLS_PRINTF_SIZET,
2575 hs_len,
2576 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2577 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002578 }
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002581 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002582
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002583 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2585 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2586 ++(ssl->handshake->out_msg_seq);
2587 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002588 ssl->out_msg[4] = 0;
2589 ssl->out_msg[5] = 0;
2590 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002591
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002592 /* Handshake hashes are computed without fragmentation,
2593 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 memset(ssl->out_msg + 6, 0x00, 3);
2595 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002596 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002598
Hanno Becker0207e532018-08-28 10:28:28 +01002599 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002601 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2602 ssl->out_msglen);
2603 if (ret != 0) {
2604 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2605 return ret;
2606 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 }
2609
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002610 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2613 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2614 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2615 if ((ret = ssl_flight_append(ssl)) != 0) {
2616 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2617 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002620#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002621 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2623 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2624 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002625 }
2626 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002627
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002631}
2632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2634 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002635{
2636 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2637 size_t msg_with_header_len;
2638 ((void) buf_len);
2639
2640 /* Add reserved 4 bytes for handshake header */
2641 msg_with_header_len = msg_len + 4;
2642 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002644
2645cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002647}
2648
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002649/*
2650 * Record layer functions
2651 */
2652
2653/*
2654 * Write current record.
2655 *
2656 * Uses:
2657 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2658 * - ssl->out_msglen: length of the record content (excl headers)
2659 * - ssl->out_msg: record content
2660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002662{
2663 int ret, done = 0;
2664 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002665 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002666
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002670 unsigned i;
2671 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002672#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2673 size_t out_buf_len = ssl->out_buf_len;
2674#else
2675 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2676#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002677 /* Skip writing the record content type to after the encryption,
2678 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002679 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002680#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002681 /* TLS 1.3 still uses the TLS 1.2 version identifier
2682 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002684 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002686#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2688 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2691 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002694 mbedtls_record rec;
2695
2696 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002697 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002698 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002699 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2702 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002703 rec.type = ssl->out_msgtype;
2704
Hanno Beckera0e20d02019-05-15 14:03:01 +01002705#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002706 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002707 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002708#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002709
Ben Taylor602b2962025-03-07 15:52:50 +00002710 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2712 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002713 }
2714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (rec.data_offset != 0) {
2716 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2717 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002718 }
2719
Hanno Becker6430faf2019-05-08 11:57:13 +01002720 /* Update the record content type and CID. */
2721 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002722#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2723 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002724#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002725 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002727 }
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002730
2731#if defined(MBEDTLS_SSL_PROTO_DTLS)
2732 /* In case of DTLS, double-check that we don't exceed
2733 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2735 ret = ssl_get_remaining_space_in_datagram(ssl);
2736 if (ret < 0) {
2737 return ret;
2738 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002741 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002743 }
2744 }
2745#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002746
Hanno Becker6430faf2019-05-08 11:57:13 +01002747 /* Now write the potentially updated record content type. */
2748 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2751 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2752 ssl->out_hdr[0], ssl->out_hdr[1],
2753 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002754
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2756 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002757
2758 ssl->out_left += protected_record_size;
2759 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2763 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002764 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 }
2766 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002767
Gabor Mezei96ae9262022-06-28 11:45:18 +02002768 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (i == mbedtls_ssl_ep_len(ssl)) {
2770 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2771 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002772 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002773 }
2774
Hanno Becker67bc7c32018-08-06 11:33:50 +01002775#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2777 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002778 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 ret = ssl_get_remaining_payload_in_datagram(ssl);
2780 if (ret < 0) {
2781 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2782 ret);
2783 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002784 }
2785
2786 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002788 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 } else {
2790 MBEDTLS_SSL_DEBUG_MSG(2,
2791 ("Still %u bytes available in current datagram",
2792 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002793 }
2794 }
2795#endif /* MBEDTLS_SSL_PROTO_DTLS */
2796
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if ((flush == SSL_FORCE_FLUSH) &&
2798 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2799 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2800 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002801 }
2802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002806}
2807
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002809
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002811static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002812{
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (ssl->in_msglen < ssl->in_hslen ||
2814 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2815 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2816 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002817 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002819}
Hanno Becker44650b72018-08-16 12:51:11 +01002820
Gilles Peskine449bd832023-01-11 14:50:10 +01002821static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002822{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002823 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002824}
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002827{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002828 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002829}
2830
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002831MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002832static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002833{
2834 uint32_t msg_len, frag_off, frag_len;
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 msg_len = ssl_get_hs_total_len(ssl);
2837 frag_off = ssl_get_hs_frag_off(ssl);
2838 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if (frag_off > msg_len) {
2841 return -1;
2842 }
Hanno Becker44650b72018-08-16 12:51:11 +01002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (frag_len > msg_len - frag_off) {
2845 return -1;
2846 }
Hanno Becker44650b72018-08-16 12:51:11 +01002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (frag_len + 12 > ssl->in_msglen) {
2849 return -1;
2850 }
Hanno Becker44650b72018-08-16 12:51:11 +01002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002853}
2854
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002855/*
2856 * Mark bits in bitmask (used for DTLS HS reassembly)
2857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002859{
2860 unsigned int start_bits, end_bits;
2861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 start_bits = 8 - (offset % 8);
2863 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002864 size_t first_byte_idx = offset / 8;
2865
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002866 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (len <= start_bits) {
2868 for (; len != 0; len--) {
2869 mask[first_byte_idx] |= 1 << (start_bits - len);
2870 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002871
2872 /* Avoid potential issues with offset or len becoming invalid */
2873 return;
2874 }
2875
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002876 offset += start_bits; /* Now offset % 8 == 0 */
2877 len -= start_bits;
2878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 for (; start_bits != 0; start_bits--) {
2880 mask[first_byte_idx] |= 1 << (start_bits - 1);
2881 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002882 }
2883
2884 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 if (end_bits != 0) {
2886 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002887
2888 len -= end_bits; /* Now len % 8 == 0 */
2889
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 for (; end_bits != 0; end_bits--) {
2891 mask[last_byte_idx] |= 1 << (8 - end_bits);
2892 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002893 }
2894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002896}
2897
2898/*
2899 * Check that bitmask is full
2900 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002901MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002902static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002903{
2904 size_t i;
2905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 for (i = 0; i < len / 8; i++) {
2907 if (mask[i] != 0xFF) {
2908 return -1;
2909 }
2910 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 for (i = 0; i < len % 8; i++) {
2913 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2914 return -1;
2915 }
2916 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002919}
2920
Hanno Becker56e205e2018-08-16 09:06:12 +01002921/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002922static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2923 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002924{
Hanno Becker56e205e2018-08-16 09:06:12 +01002925 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002926
Hanno Becker56e205e2018-08-16 09:06:12 +01002927 alloc_len = 12; /* Handshake header */
2928 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 if (add_bitmap) {
2931 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 }
2934 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002935}
Hanno Becker56e205e2018-08-16 09:06:12 +01002936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002937#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002940{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002941 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002942}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002945{
Gilles Peskine7a176962025-02-28 21:59:12 +01002946 if (ssl->in_hsfraglen == 0) {
2947 /* The handshake message must at least include the header.
2948 * We may not have the full message yet in case of fragmentation.
2949 * To simplify the code, we insist on having the header (and in
2950 * particular the handshake message length) in the first
2951 * fragment. */
2952 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2953 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2954 ssl->in_msglen));
2955 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2956 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002957
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002958 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002959 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2962 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2963 MBEDTLS_PRINTF_SIZET,
2964 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002965
Gilles Peskine235eae92025-02-28 22:02:52 +01002966 if (ssl->transform_in != NULL) {
2967 MBEDTLS_SSL_DEBUG_MSG(4, ("decrypted handshake message:"
2968 " iv-buf=%d hdr-buf=%d hdr-buf=%d",
2969 (int) (ssl->in_iv - ssl->in_buf),
2970 (int) (ssl->in_hdr - ssl->in_buf),
2971 (int) (ssl->in_msg - ssl->in_buf)));
2972 }
2973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002976 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002977 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (ssl_check_hs_header(ssl) != 0) {
2980 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2981 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002982 }
2983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 if (ssl->handshake != NULL &&
2985 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2986 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2987 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
2988 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
2989 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
2990 MBEDTLS_SSL_DEBUG_MSG(2,
2991 (
2992 "received future handshake message of sequence number %u (next %u)",
2993 recv_msg_seq,
2994 ssl->handshake->in_msg_seq));
2995 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01002996 }
2997
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02002998 /* Retransmit only on last message from previous flight, to avoid
2999 * too many retransmissions.
3000 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3002 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3003 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3004 "message_seq = %u, start_of_flight = %u",
3005 recv_msg_seq,
3006 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003007
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3009 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3010 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003011 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 } else {
3013 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3014 "message_seq = %u, expected = %u",
3015 recv_msg_seq,
3016 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003017 }
3018
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003020 }
3021 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003022
Hanno Becker6d97ef52018-08-16 13:09:04 +01003023 /* Message reassembly is handled alongside buffering of future
3024 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003025 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003026 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3028 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3029 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003030 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskinee85ece62025-02-28 22:24:56 +01003033 {
3034 unsigned char *const reassembled_record_start =
3035 ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3036 unsigned char *const payload_start =
3037 reassembled_record_start + mbedtls_ssl_in_hdr_len(ssl);
3038 unsigned char *payload_end = payload_start + ssl->in_hsfraglen;
Gilles Peskine15c072f2025-03-06 19:03:00 +01003039 /* How many more bytes we want to have a complete handshake message. */
3040 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
3041 /* How many bytes of the current record are part of the first
3042 * handshake message. There may be more handshake messages (possibly
3043 * incomplete) in the same record; if so, we leave them after the
3044 * current record, and ssl_consume_current_message() will take
3045 * care of consuming the next handshake message. */
3046 const size_t hs_this_fragment_len =
3047 ssl->in_msglen > hs_remain ? hs_remain : ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003048 (void) hs_this_fragment_len;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003049
Gilles Peskineafb254c2025-03-06 19:23:22 +01003050 MBEDTLS_SSL_DEBUG_MSG(3,
3051 ("%s handshake fragment: %" MBEDTLS_PRINTF_SIZET
3052 ", %" MBEDTLS_PRINTF_SIZET
3053 "..%" MBEDTLS_PRINTF_SIZET
3054 " of %" MBEDTLS_PRINTF_SIZET,
3055 (ssl->in_hsfraglen != 0 ?
3056 "subsequent" :
3057 hs_this_fragment_len == ssl->in_hslen ?
3058 "sole" :
3059 "initial"),
3060 ssl->in_msglen,
3061 ssl->in_hsfraglen,
3062 ssl->in_hsfraglen + hs_this_fragment_len,
3063 ssl->in_hslen));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003064
3065 /* Move the received handshake fragment to have the whole message
3066 * (at least the part received so far) in a single segment at a
3067 * known offset in the input buffer.
3068 * - When receiving a non-initial handshake fragment, append it to
3069 * the initial segment.
3070 * - Even the initial handshake fragment is moved, if it was
3071 * encrypted with an explicit IV: decryption leaves the payload
3072 * after the explicit IV, but here we move it to start where the
3073 * IV was.
3074 */
3075#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3076 size_t const in_buf_len = ssl->in_buf_len;
3077#else
3078 size_t const in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3079#endif
Gilles Peskine0851ec92025-03-06 15:15:20 +01003080 if (payload_end + ssl->in_msglen > ssl->in_buf + in_buf_len) {
Gilles Peskinee85ece62025-02-28 22:24:56 +01003081 MBEDTLS_SSL_DEBUG_MSG(1,
3082 ("Shouldn't happen: no room to move handshake fragment %"
3083 MBEDTLS_PRINTF_SIZET " from %p to %p (buf=%p len=%"
3084 MBEDTLS_PRINTF_SIZET ")",
3085 ssl->in_msglen,
Gilles Peskine90a95932025-02-25 23:57:20 +01003086 (void *) ssl->in_msg, (void *) payload_end,
3087 (void *) ssl->in_buf, in_buf_len));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003088 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3089 }
3090 memmove(payload_end, ssl->in_msg, ssl->in_msglen);
3091
3092 ssl->in_hsfraglen += ssl->in_msglen;
3093 payload_end += ssl->in_msglen;
3094
3095 if (ssl->in_hsfraglen < ssl->in_hslen) {
3096 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3097 MBEDTLS_PRINTF_SIZET "/%"
3098 MBEDTLS_PRINTF_SIZET,
3099 ssl->in_hsfraglen, ssl->in_hslen));
3100 ssl->in_hdr = payload_end;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003101 ssl->in_msglen = 0;
3102 mbedtls_ssl_update_in_pointers(ssl);
3103 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003104 } else {
3105 ssl->in_msglen = ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003106 ssl->in_hsfraglen = 0;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003107 ssl->in_hdr = reassembled_record_start;
3108 mbedtls_ssl_update_in_pointers(ssl);
3109
3110 /* Update the record length in the fully reassembled record */
3111 if (ssl->in_msglen > 0xffff) {
3112 MBEDTLS_SSL_DEBUG_MSG(1,
Gilles Peskinee34ec862025-03-07 10:43:39 +01003113 ("Shouldn't happen: in_msglen=%"
Gilles Peskinee85ece62025-02-28 22:24:56 +01003114 MBEDTLS_PRINTF_SIZET " > 0xffff",
3115 ssl->in_msglen));
3116 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3117 }
3118 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
3119
Gilles Peskine15c072f2025-03-06 19:03:00 +01003120 size_t record_len = mbedtls_ssl_in_hdr_len(ssl) + ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003121 (void) record_len;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003122 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
Gilles Peskine15c072f2025-03-06 19:03:00 +01003123 ssl->in_hdr, record_len);
3124 if (ssl->in_hslen < ssl->in_msglen) {
3125 MBEDTLS_SSL_DEBUG_MSG(3,
3126 ("More handshake messages in the record: "
Gilles Peskineb8f1e4b2025-03-06 21:32:08 +01003127 "%" MBEDTLS_PRINTF_SIZET " + %" MBEDTLS_PRINTF_SIZET,
Gilles Peskine15c072f2025-03-06 19:03:00 +01003128 ssl->in_hslen,
3129 ssl->in_msglen - ssl->in_hslen));
3130 }
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003131 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003132 }
3133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003135}
3136
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003137int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003138{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003139 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003140 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003143 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3144 if (ret != 0) {
3145 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3146 return ret;
3147 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003148 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003149
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003150 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3153 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003154 unsigned offset;
3155 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003156
Hanno Becker0271f962018-08-16 13:23:47 +01003157 /* Increment handshake sequence number */
3158 hs->in_msg_seq++;
3159
3160 /*
3161 * Clear up handshake buffering and reassembly structure.
3162 */
3163
3164 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003166
3167 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003169 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003171 *hs_buf = *(hs_buf + 1);
3172 }
3173
3174 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003176 }
3177#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003178 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003179}
3180
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003181/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003182 * DTLS anti-replay: RFC 6347 4.1.2.6
3183 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003184 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3185 * Bit n is set iff record number in_window_top - n has been seen.
3186 *
3187 * Usually, in_window_top is the last record number seen and the lsb of
3188 * in_window is set. The only exception is the initial state (record number 0
3189 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003192void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003193{
3194 ssl->in_window_top = 0;
3195 ssl->in_window = 0;
3196}
3197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003199{
Gilles Peskine449bd832023-01-11 14:50:10 +01003200 return ((uint64_t) buf[0] << 40) |
3201 ((uint64_t) buf[1] << 32) |
3202 ((uint64_t) buf[2] << 24) |
3203 ((uint64_t) buf[3] << 16) |
3204 ((uint64_t) buf[4] << 8) |
3205 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003206}
3207
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003208MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003209static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003210{
Janos Follath865b3eb2019-12-16 11:46:15 +00003211 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003212 unsigned char *original_in_ctr;
3213
3214 // save original in_ctr
3215 original_in_ctr = ssl->in_ctr;
3216
3217 // use counter from record
3218 ssl->in_ctr = record_in_ctr;
3219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003221
3222 // restore the counter
3223 ssl->in_ctr = original_in_ctr;
3224
3225 return ret;
3226}
3227
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003228/*
3229 * Return 0 if sequence number is acceptable, -1 otherwise
3230 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003231int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003232{
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003234 uint64_t bit;
3235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3237 return 0;
3238 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (rec_seqnum > ssl->in_window_top) {
3241 return 0;
3242 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003243
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003244 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (bit >= 64) {
3247 return -1;
3248 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3251 return -1;
3252 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003255}
3256
3257/*
3258 * Update replay window on new validated record
3259 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003260void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003261{
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003265 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003267
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003269 /* Update window_top and the contents of the window */
3270 uint64_t shift = rec_seqnum - ssl->in_window_top;
3271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003273 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003275 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003276 ssl->in_window |= 1;
3277 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003278
3279 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003281 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003282 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003285 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003287 }
3288}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003290
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003291#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003292/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003293 * Check if a datagram looks like a ClientHello with a valid cookie,
3294 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003295 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003296 *
3297 * - if cookie is valid, return 0
3298 * - if ClientHello looks superficially valid but cookie is not,
3299 * fill obuf and set olen, then
3300 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3301 * - otherwise return a specific error code
3302 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003303MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003304MBEDTLS_STATIC_TESTABLE
3305int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 mbedtls_ssl_context *ssl,
3307 const unsigned char *cli_id, size_t cli_id_len,
3308 const unsigned char *in, size_t in_len,
3309 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003310{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003311 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003312 unsigned char *p;
3313
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003314 /*
3315 * Structure of ClientHello with record and handshake headers,
3316 * and expected values. We don't need to check a lot, more checks will be
3317 * done when actually parsing the ClientHello - skipping those checks
3318 * avoids code duplication and does not make cookie forging any easier.
3319 *
3320 * 0-0 ContentType type; copied, must be handshake
3321 * 1-2 ProtocolVersion version; copied
3322 * 3-4 uint16 epoch; copied, must be 0
3323 * 5-10 uint48 sequence_number; copied
3324 * 11-12 uint16 length; (ignored)
3325 *
3326 * 13-13 HandshakeType msg_type; (ignored)
3327 * 14-16 uint24 length; (ignored)
3328 * 17-18 uint16 message_seq; copied
3329 * 19-21 uint24 fragment_offset; copied, must be 0
3330 * 22-24 uint24 fragment_length; (ignored)
3331 *
3332 * 25-26 ProtocolVersion client_version; (ignored)
3333 * 27-58 Random random; (ignored)
3334 * 59-xx SessionID session_id; 1 byte len + sid_len content
3335 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3336 * ...
3337 *
3338 * Minimum length is 61 bytes.
3339 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3341 (unsigned) in_len));
3342 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3343 if (in_len < 61) {
3344 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3345 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003346 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003347
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3349 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003350
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3352 fragment_offset != 0) {
3353 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3354 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3355 in[0], (unsigned) epoch,
3356 (unsigned) fragment_offset));
3357 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003358 }
3359
3360 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (59 + 1 + sid_len + 1 > in_len) {
3362 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3363 (unsigned) sid_len,
3364 (unsigned) in_len - 61));
3365 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003366 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3368 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003369
3370 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3372 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3373 (unsigned) cookie_len,
3374 (unsigned) (in_len - sid_len - 61)));
3375 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003376 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003377
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3379 in + sid_len + 61, cookie_len);
3380 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3381 in + sid_len + 61, cookie_len,
3382 cli_id, cli_id_len) == 0) {
3383 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3384 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003385 }
3386
3387 /*
3388 * If we get here, we've got an invalid cookie, let's prepare HVR.
3389 *
3390 * 0-0 ContentType type; copied
3391 * 1-2 ProtocolVersion version; copied
3392 * 3-4 uint16 epoch; copied
3393 * 5-10 uint48 sequence_number; copied
3394 * 11-12 uint16 length; olen - 13
3395 *
3396 * 13-13 HandshakeType msg_type; hello_verify_request
3397 * 14-16 uint24 length; olen - 25
3398 * 17-18 uint16 message_seq; copied
3399 * 19-21 uint24 fragment_offset; copied
3400 * 22-24 uint24 fragment_length; olen - 25
3401 *
3402 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3403 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3404 *
3405 * Minimum length is 28.
3406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003407 if (buf_len < 28) {
3408 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3409 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003410
3411 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003413 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3414 obuf[25] = 0xfe;
3415 obuf[26] = 0xff;
3416
3417 /* Generate and write actual cookie */
3418 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3420 &p, obuf + buf_len,
3421 cli_id, cli_id_len) != 0) {
3422 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003423 }
3424
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003425 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003426
3427 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003429
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3431 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3432 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003433
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003435
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003437}
3438
3439/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003440 * Handle possible client reconnect with the same UDP quadruplet
3441 * (RFC 6347 Section 4.2.8).
3442 *
3443 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3444 * that looks like a ClientHello.
3445 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003446 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003447 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003448 * - if the input looks like a ClientHello with a valid cookie,
3449 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003450 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003451 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003452 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003453 * This function is called (through ssl_check_client_reconnect()) when an
3454 * unexpected record is found in ssl_get_next_record(), which will discard the
3455 * record if we return 0, and bubble up the return value otherwise (this
3456 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3457 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003460static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003461{
Janos Follath865b3eb2019-12-16 11:46:15 +00003462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003463 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 if (ssl->conf->f_cookie_write == NULL ||
3466 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003467 /* If we can't use cookies to verify reachability of the peer,
3468 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3470 "can't check reconnect validity"));
3471 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003472 }
3473
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003474 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 ssl,
3476 ssl->cli_id, ssl->cli_id_len,
3477 ssl->in_buf, ssl->in_left,
3478 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003479
Gilles Peskine449bd832023-01-11 14:50:10 +01003480 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003481
Gilles Peskine449bd832023-01-11 14:50:10 +01003482 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003483 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3485 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3486 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003487 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003488 * If the error is permanent we'll catch it later,
3489 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3491 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003492 (void) send_ret;
3493
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003495 }
3496
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 if (ret == 0) {
3498 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3499 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3500 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3501 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003502 }
3503
Gilles Peskine449bd832023-01-11 14:50:10 +01003504 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003505 }
3506
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003508}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003509#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003510
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003511MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003512static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003513{
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003515 record_type != MBEDTLS_SSL_MSG_ALERT &&
3516 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3518 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003519 }
3520
Gilles Peskine449bd832023-01-11 14:50:10 +01003521 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003522}
3523
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003524/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003525 * ContentType type;
3526 * ProtocolVersion version;
3527 * uint16 epoch; // DTLS only
3528 * uint48 sequence_number; // DTLS only
3529 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003530 *
3531 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003532 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003533 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3534 *
3535 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003536 * 1. proceed with the record if this function returns 0
3537 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3538 * 3. return CLIENT_RECONNECT if this function return that value
3539 * 4. drop the whole datagram if this function returns anything else.
3540 * Point 2 is needed when the peer is resending, and we have already received
3541 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003542 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003544static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3545 unsigned char *buf,
3546 size_t len,
3547 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003548{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003549 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003550
Hanno Beckere5e7e782019-07-11 12:29:35 +01003551 size_t const rec_hdr_type_offset = 0;
3552 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003553
Hanno Beckere5e7e782019-07-11 12:29:35 +01003554 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3555 rec_hdr_type_len;
3556 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003557
Hanno Beckere5e7e782019-07-11 12:29:35 +01003558 size_t const rec_hdr_ctr_len = 8;
3559#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003560 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003561 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3562 rec_hdr_version_len;
3563
Hanno Beckera0e20d02019-05-15 14:03:01 +01003564#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003565 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3566 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003567 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3569#endif /* MBEDTLS_SSL_PROTO_DTLS */
3570
3571 size_t rec_hdr_len_offset; /* To be determined */
3572 size_t const rec_hdr_len_len = 2;
3573
3574 /*
3575 * Check minimum lengths for record header.
3576 */
3577
3578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003580 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003581 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003582#endif /* MBEDTLS_SSL_PROTO_DTLS */
3583 {
3584 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3585 }
3586
Gilles Peskine449bd832023-01-11 14:50:10 +01003587 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3588 MBEDTLS_SSL_DEBUG_MSG(1,
3589 (
3590 "datagram of length %u too small to hold DTLS record header of length %u",
3591 (unsigned) len,
3592 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3593 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003594 }
3595
3596 /*
3597 * Parse and validate record content type
3598 */
3599
Gilles Peskine449bd832023-01-11 14:50:10 +01003600 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003601
3602 /* Check record content type */
3603#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3604 rec->cid_len = 0;
3605
Gilles Peskine449bd832023-01-11 14:50:10 +01003606 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003607 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003609 /* Shift pointers to account for record header including CID
3610 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003611 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003612 * ProtocolVersion version;
3613 * uint16 epoch;
3614 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003615 * opaque cid[cid_length]; // Additional field compared to
3616 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003617 * uint16 length;
3618 * opaque enc_content[DTLSCiphertext.length];
3619 * } DTLSCiphertext;
3620 */
3621
3622 /* So far, we only support static CID lengths
3623 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003624 rec_hdr_cid_len = ssl->conf->cid_len;
3625 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003626
Gilles Peskine449bd832023-01-11 14:50:10 +01003627 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3628 MBEDTLS_SSL_DEBUG_MSG(1,
3629 (
3630 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3631 (unsigned) len,
3632 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3633 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003634 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003635
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003636 /* configured CID len is guaranteed at most 255, see
3637 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3638 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003639 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3640 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003641#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003642 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 if (ssl_check_record_type(rec->type)) {
3644 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3645 (unsigned) rec->type));
3646 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003647 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003648 }
3649
Hanno Beckere5e7e782019-07-11 12:29:35 +01003650 /*
3651 * Parse and validate record version
3652 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3654 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003655 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3656 buf + rec_hdr_version_offset,
3657 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003658
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 if (tls_version > ssl->conf->max_tls_version) {
3660 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3661 (unsigned) tls_version,
3662 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003663
Gilles Peskine449bd832023-01-11 14:50:10 +01003664 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003665 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003666 /*
3667 * Parse/Copy record sequence number.
3668 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003669
Hanno Beckere5e7e782019-07-11 12:29:35 +01003670#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003671 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003672 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3674 rec_hdr_ctr_len);
3675 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676#endif /* MBEDTLS_SSL_PROTO_DTLS */
3677 {
3678 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003680 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003681
Hanno Beckere5e7e782019-07-11 12:29:35 +01003682 /*
3683 * Parse record length.
3684 */
3685
Hanno Beckere5e7e782019-07-11 12:29:35 +01003686 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003687 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003688 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003689
Gilles Peskine449bd832023-01-11 14:50:10 +01003690 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3691 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3692 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003693
3694 rec->buf = buf;
3695 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003696
Gilles Peskine449bd832023-01-11 14:50:10 +01003697 if (rec->data_len == 0) {
Gilles Peskine7c1dbef2025-03-07 20:48:01 +01003698 MBEDTLS_SSL_DEBUG_MSG(1, ("rejecting empty record"));
Gilles Peskine449bd832023-01-11 14:50:10 +01003699 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3700 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003701
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003703 * DTLS-related tests.
3704 * Check epoch before checking length constraint because
3705 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3706 * message gets duplicated before the corresponding Finished message,
3707 * the second ChangeCipherSpec should be discarded because it belongs
3708 * to an old epoch, but not because its length is shorter than
3709 * the minimum record length for packets using the new record transform.
3710 * Note that these two kinds of failures are handled differently,
3711 * as an unexpected record is silently skipped but an invalid
3712 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003713 */
3714#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003715 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003716 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003717
Hanno Becker955a5c92019-07-10 17:12:07 +01003718 /* Check that the datagram is large enough to contain a record
3719 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003720 if (len < rec->data_offset + rec->data_len) {
3721 MBEDTLS_SSL_DEBUG_MSG(1,
3722 (
3723 "Datagram of length %u too small to contain record of advertised length %u.",
3724 (unsigned) len,
3725 (unsigned) (rec->data_offset + rec->data_len)));
3726 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003727 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003728
Hanno Becker37cfe732019-07-10 17:20:01 +01003729 /* Records from other, non-matching epochs are silently discarded.
3730 * (The case of same-port Client reconnects must be considered in
3731 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003732 if (rec_epoch != ssl->in_epoch) {
3733 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3734 "expected %u, received %lu",
3735 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003736
Hanno Becker552f7472019-07-19 10:59:12 +01003737 /* Records from the next epoch are considered for buffering
3738 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003739 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3740 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3741 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003742 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003743
Gilles Peskine449bd832023-01-11 14:50:10 +01003744 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003745 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003746#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003747 /* For records from the correct epoch, check whether their
3748 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003749 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3750 &rec->ctr[0]) != 0) {
3751 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3752 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003753 }
3754#endif
3755 }
3756#endif /* MBEDTLS_SSL_PROTO_DTLS */
3757
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003759}
Paul Bakker5121ce52009-01-03 21:22:43 +00003760
Paul Bakker5121ce52009-01-03 21:22:43 +00003761
Hanno Becker2fddd372019-07-10 14:37:41 +01003762#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003763MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003764static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003765{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003766 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003767
3768 /*
3769 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3770 * access the first byte of record content (handshake type), as we
3771 * have an active transform (possibly iv_len != 0), so use the
3772 * fact that the record header len is 13 instead.
3773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003774 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003775 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003776 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003777 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3778 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003779 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3780 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3781 "from the same port"));
3782 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003783 }
3784
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003786}
Hanno Becker2fddd372019-07-10 14:37:41 +01003787#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003788
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003789/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003790 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003791 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003792MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003793static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3794 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003795{
3796 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003797
Gilles Peskine449bd832023-01-11 14:50:10 +01003798 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3799 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003800
Ronald Cron7e38cba2021-11-24 12:43:39 +01003801 /*
3802 * In TLS 1.3, always treat ChangeCipherSpec records
3803 * as unencrypted. The only thing we do with them is
3804 * check the length and content and ignore them.
3805 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003806#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003807 if (ssl->transform_in != NULL &&
3808 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3809 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003810 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003812 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003813#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003814
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003816 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003817
Gilles Peskine449bd832023-01-11 14:50:10 +01003818 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3819 rec)) != 0) {
3820 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003821
Ronald Cron2995d352024-01-18 16:59:39 +01003822#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3823 /*
3824 * Although the server rejected early data, it might receive early
3825 * data as long as it has not received the client Finished message.
3826 * It is encrypted with early keys and should be ignored as stated
3827 * in section 4.2.10 of RFC 8446:
3828 *
3829 * "Ignore the extension and return a regular 1-RTT response. The
3830 * server then skips past early data by attempting to deprotect
3831 * received records using the handshake traffic key, discarding
3832 * records which fail deprotection (up to the configured
3833 * max_early_data_size). Once a record is deprotected successfully,
3834 * it is treated as the start of the client's second flight and the
3835 * server proceeds as with an ordinary 1-RTT handshake."
3836 */
3837 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3838 (ssl->discard_early_data_record ==
3839 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3840 MBEDTLS_SSL_DEBUG_MSG(
3841 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003842
3843 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3844 if (ret != 0) {
3845 return ret;
3846 }
Ronald Cron2995d352024-01-18 16:59:39 +01003847 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3848 }
3849#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3850
Hanno Beckera0e20d02019-05-15 14:03:01 +01003851#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003853 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003854 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3855 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003856 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003857 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003858#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003859
Ronald Cron71c6e652024-02-05 16:48:10 +01003860 /*
3861 * The decryption of the record failed, no reason to ignore it,
3862 * return in error with the decryption error code.
3863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003864 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003865 }
3866
Ronald Cron2995d352024-01-18 16:59:39 +01003867#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3868 /*
3869 * If the server were discarding protected records that it fails to
3870 * deprotect because it has rejected early data, as we have just
3871 * deprotected successfully a record, the server has to resume normal
3872 * operation and fail the connection if the deprotection of a record
3873 * fails.
3874 */
3875 if (ssl->discard_early_data_record ==
3876 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3877 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3878 }
3879#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3880
Gilles Peskine449bd832023-01-11 14:50:10 +01003881 if (old_msg_type != rec->type) {
3882 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3883 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003884 }
3885
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3887 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003888
Hanno Beckera0e20d02019-05-15 14:03:01 +01003889#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003890 /* We have already checked the record content type
3891 * in ssl_parse_record_header(), failing or silently
3892 * dropping the record in the case of an unknown type.
3893 *
3894 * Since with the use of CIDs, the record content type
3895 * might change during decryption, re-check the record
3896 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003897 if (ssl_check_record_type(rec->type)) {
3898 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3899 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003900 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003901#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003902
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003904#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003905 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3906 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003907 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003908 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3909 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003910 }
3911#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3912
3913 ssl->nb_zero++;
3914
3915 /*
3916 * Three or more empty messages may be a DoS attack
3917 * (excessive CPU consumption).
3918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003919 if (ssl->nb_zero > 3) {
3920 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3921 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003922 /* Treat the records as if they were not properly authenticated,
3923 * thereby failing the connection if we see more than allowed
3924 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003926 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003928 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003930
3931#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003933 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003935#endif
3936 {
3937 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3939 i > mbedtls_ssl_ep_len(ssl); i--) {
3940 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003941 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003943 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003944
3945 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 if (i == mbedtls_ssl_ep_len(ssl)) {
3947 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3948 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003949 }
3950 }
3951
Paul Bakker5121ce52009-01-03 21:22:43 +00003952 }
3953
Jerry Yuf57d14b2023-11-15 16:40:09 +08003954#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3955 /*
3956 * Although the server rejected early data because it needed to send an
3957 * HelloRetryRequest message, it might receive early data as long as it has
3958 * not received the client Finished message.
3959 * The early data is encrypted with early keys and should be ignored as
3960 * stated in section 4.2.10 of RFC 8446 (second case):
3961 *
3962 * "The server then ignores early data by skipping all records with an
3963 * external content type of "application_data" (indicating that they are
3964 * encrypted), up to the configured max_early_data_size. Ignore application
3965 * data message before 2nd ClientHello when early_data was received in 1st
3966 * ClientHello."
3967 */
3968 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3969 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003970
3971 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3972 if (ret != 0) {
3973 return ret;
3974 }
3975
Jerry Yuf57d14b2023-11-15 16:40:09 +08003976 MBEDTLS_SSL_DEBUG_MSG(
3977 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003978
Jerry Yuf57d14b2023-11-15 16:40:09 +08003979 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3980 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3981 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3982 }
3983 }
3984#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003986#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003987 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3988 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003989 }
3990#endif
3991
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003992 /* Check actual (decrypted) record content length against
3993 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
3995 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
3996 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003997 }
3998
Gilles Peskine449bd832023-01-11 14:50:10 +01003999 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004000}
4001
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004002/*
4003 * Read a record.
4004 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004005 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4006 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4007 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004008 */
Hanno Becker1097b342018-08-15 14:09:41 +01004009
4010/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004011MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004012static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004013MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004014static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004016static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4019 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004020{
Janos Follath865b3eb2019-12-16 11:46:15 +00004021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004024
Gilles Peskine449bd832023-01-11 14:50:10 +01004025 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004026 do {
Simon Butcher99000142016-10-13 17:21:01 +01004027
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 ret = ssl_consume_current_message(ssl);
4029 if (ret != 0) {
4030 return ret;
4031 }
Hanno Becker26994592018-08-15 14:14:59 +01004032
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004034 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004035#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004036
Hanno Becker40f50842018-08-15 14:48:01 +01004037 /* We only check for buffered messages if the
4038 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4040 ssl_next_record_is_in_datagram(ssl) == 0) {
4041 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004042 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 }
Hanno Becker40f50842018-08-15 14:48:01 +01004044 }
4045
Hanno Becker40f50842018-08-15 14:48:01 +01004046#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 if (dtls_have_buffered == 0) {
4048 ret = ssl_get_next_record(ssl);
4049 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004050 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 }
Hanno Becker40f50842018-08-15 14:48:01 +01004052
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 if (ret != 0) {
4054 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4055 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004056 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004057 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004058 }
4059
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004061
Hanno Becker40f50842018-08-15 14:48:01 +01004062#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004064 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065 ret = ssl_buffer_message(ssl);
4066 if (ret != 0) {
4067 return ret;
4068 }
Hanno Becker40f50842018-08-15 14:48:01 +01004069
4070 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4071 }
4072#endif /* MBEDTLS_SSL_PROTO_DTLS */
4073
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4075 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 if (0 != ret) {
4078 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4079 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004080 }
4081
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4083 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004084 ret = mbedtls_ssl_update_handshake_status(ssl);
4085 if (0 != ret) {
4086 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4087 return ret;
4088 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004089 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004090 } else {
4091 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004092 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004093 }
4094
Gilles Peskine449bd832023-01-11 14:50:10 +01004095 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004096
Gilles Peskine449bd832023-01-11 14:50:10 +01004097 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004098}
4099
Hanno Becker40f50842018-08-15 14:48:01 +01004100#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004101MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004102static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004103{
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 if (ssl->in_left > ssl->next_record_offset) {
4105 return 1;
4106 }
Simon Butcher99000142016-10-13 17:21:01 +01004107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004109}
4110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004112static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004113{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004114 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004116 int ret = 0;
4117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118 if (hs == NULL) {
4119 return -1;
4120 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004123
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4125 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004126 /* Check if we have seen a ChangeCipherSpec before.
4127 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (!hs->buffering.seen_ccs) {
4129 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004130 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004131 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004132 }
4133
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004135 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4136 ssl->in_msglen = 1;
4137 ssl->in_msg[0] = 1;
4138
4139 /* As long as they are equal, the exact value doesn't matter. */
4140 ssl->in_left = 0;
4141 ssl->next_record_offset = 0;
4142
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004143 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004144 goto exit;
4145 }
Hanno Becker37f95322018-08-16 13:55:32 +01004146
Hanno Beckerb8f50142018-08-28 10:01:34 +01004147#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004148 /* Debug only */
4149 {
4150 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004152 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 if (hs_buf->is_valid == 1) {
4154 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4155 hs->in_msg_seq + offset,
4156 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004157 }
4158 }
4159 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004160#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004161
4162 /* Check if we have buffered and/or fully reassembled the
4163 * next handshake message. */
4164 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004166 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004167 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004168
4169 /* Double-check that we haven't accidentally buffered
4170 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4172 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4173 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004174 }
4175
Gilles Peskine449bd832023-01-11 14:50:10 +01004176 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4177 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4178 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004179
4180 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4181 ssl->in_hslen = msg_len + 12;
4182 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004183 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004184
4185 ret = 0;
4186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 } else {
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01004188 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially buffered",
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004190 }
4191
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004192 ret = -1;
4193
4194exit:
4195
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4197 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004198}
4199
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004201static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4202 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004203{
4204 int offset;
4205 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004206 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4207 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004208
Hanno Becker01315ea2018-08-21 17:22:17 +01004209 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004211
4212 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4214 hs->buffering.total_bytes_buffered)) {
4215 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4216 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004217 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004218
Hanno Becker4f432ad2018-08-28 10:02:32 +01004219 /* We don't have enough space to buffer the next expected handshake
4220 * message. Remove buffers used for future messages to gain space,
4221 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4223 offset >= 0; offset--) {
4224 MBEDTLS_SSL_DEBUG_MSG(2,
4225 (
4226 "Free buffering slot %d to make space for reassembly of next handshake message",
4227 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004230
4231 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4233 hs->buffering.total_bytes_buffered)) {
4234 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4235 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004236 }
4237 }
4238
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004240}
4241
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004243static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004244{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004245 int ret = 0;
4246 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (hs == NULL) {
4249 return 0;
4250 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004253
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004255 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004257
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004258 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004259 break;
4260
4261 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004262 {
4263 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004264 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004265 mbedtls_ssl_hs_buffer *hs_buf;
4266 size_t msg_len = ssl->in_hslen - 12;
4267
4268 /* We should never receive an old handshake
4269 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4271 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4272 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004273 }
4274
4275 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004277 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 MBEDTLS_SSL_DEBUG_MSG(2,
4279 ("Ignore future HS message with sequence number %u, "
4280 "buffering window %u - %u",
4281 recv_msg_seq, ssl->handshake->in_msg_seq,
4282 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4283 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004284
4285 goto exit;
4286 }
4287
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4289 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004290
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004292
4293 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004295 size_t reassembly_buf_sz;
4296
Hanno Becker37f95322018-08-16 13:55:32 +01004297 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004299
4300 /* We copy the message back into the input buffer
4301 * after reassembly, so check that it's not too large.
4302 * This is an implementation-specific limitation
4303 * and not one from the standard, hence it is not
4304 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004306 /* Ignore message */
4307 goto exit;
4308 }
4309
Hanno Beckere0b150f2018-08-21 15:51:03 +01004310 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 if (hs->buffering.total_bytes_buffered >
4312 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4313 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4314 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004315 }
4316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4318 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4321 hs->buffering.total_bytes_buffered)) {
4322 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004323 /* If we can't buffer a future message because
4324 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 MBEDTLS_SSL_DEBUG_MSG(2,
4326 ("Buffering of future message of size %"
4327 MBEDTLS_PRINTF_SIZET
4328 " would exceed the compile-time limit %"
4329 MBEDTLS_PRINTF_SIZET
4330 " (already %" MBEDTLS_PRINTF_SIZET
4331 " bytes buffered) -- ignore\n",
4332 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4333 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004334 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 } else {
4336 MBEDTLS_SSL_DEBUG_MSG(2,
4337 ("Buffering of future message of size %"
4338 MBEDTLS_PRINTF_SIZET
4339 " would exceed the compile-time limit %"
4340 MBEDTLS_PRINTF_SIZET
4341 " (already %" MBEDTLS_PRINTF_SIZET
4342 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4343 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4344 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004345 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4348 MBEDTLS_SSL_DEBUG_MSG(2,
4349 ("Reassembly of next message of size %"
4350 MBEDTLS_PRINTF_SIZET
4351 " (%" MBEDTLS_PRINTF_SIZET
4352 " with bitmap) would exceed"
4353 " the compile-time limit %"
4354 MBEDTLS_PRINTF_SIZET
4355 " (already %" MBEDTLS_PRINTF_SIZET
4356 " bytes buffered) -- fail\n",
4357 msg_len,
4358 reassembly_buf_sz,
4359 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4360 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004361 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4362 goto exit;
4363 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004364 }
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 MBEDTLS_SSL_DEBUG_MSG(2,
4367 ("initialize reassembly, total length = %"
4368 MBEDTLS_PRINTF_SIZET,
4369 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4372 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004373 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004374 goto exit;
4375 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004376 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004377
4378 /* Prepare final header: copy msg_type, length and message_seq,
4379 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 memcpy(hs_buf->data, ssl->in_msg, 6);
4381 memset(hs_buf->data + 6, 0, 3);
4382 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004383
4384 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004385
4386 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004388 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4390 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004391 /* Ignore */
4392 goto exit;
4393 }
4394 }
4395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004397 size_t frag_len, frag_off;
4398 unsigned char * const msg = hs_buf->data + 12;
4399
4400 /*
4401 * Check and copy current fragment
4402 */
4403
4404 /* Validation of header fields already done in
4405 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 frag_off = ssl_get_hs_frag_off(ssl);
4407 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004408
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4410 ", length = %" MBEDTLS_PRINTF_SIZET,
4411 frag_off, frag_len));
4412 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004415 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 ssl_bitmask_set(bitmask, frag_off, frag_len);
4417 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4418 msg_len) == 0);
4419 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004420 hs_buf->is_complete = 1;
4421 }
4422
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4424 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004425 }
4426
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004427 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004428 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004429
4430 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004431 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004432 break;
4433 }
4434
4435exit:
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4438 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004439}
4440#endif /* MBEDTLS_SSL_PROTO_DTLS */
4441
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004442MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004443static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004444{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004445 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004446 * Consume last content-layer message and potentially
4447 * update in_msglen which keeps track of the contents'
4448 * consumption state.
4449 *
4450 * (1) Handshake messages:
4451 * Remove last handshake message, move content
4452 * and adapt in_msglen.
4453 *
4454 * (2) Alert messages:
4455 * Consume whole record content, in_msglen = 0.
4456 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004457 * (3) Change cipher spec:
4458 * Consume whole record content, in_msglen = 0.
4459 *
4460 * (4) Application data:
4461 * Don't do anything - the record layer provides
4462 * the application data as a stream transport
4463 * and consumes through mbedtls_ssl_read only.
4464 *
4465 */
4466
4467 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004469 /* Hard assertion to be sure that no application data
4470 * is in flight, as corrupting ssl->in_msglen during
4471 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (ssl->in_offt != NULL) {
4473 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4474 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004475 }
4476
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004477 if (ssl->in_hsfraglen != 0) {
4478 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004479 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4480 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4481 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004482 return 0;
4483 }
4484
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004485 /*
4486 * Get next Handshake message in the current record
4487 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004488
Hanno Becker4a810fb2017-05-24 16:27:30 +01004489 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004490 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004491 * current handshake content: If DTLS handshake
4492 * fragmentation is used, that's the fragment
4493 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004494 * size here is faulty and should be changed at
4495 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004496 * (2) While it doesn't seem to cause problems, one
4497 * has to be very careful not to assume that in_hslen
4498 * is always <= in_msglen in a sensible communication.
4499 * Again, it's wrong for DTLS handshake fragmentation.
4500 * The following check is therefore mandatory, and
4501 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004502 * Additionally, ssl->in_hslen might be arbitrarily out of
4503 * bounds after handling a DTLS message with an unexpected
4504 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004507 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4509 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004510 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4513 ssl->in_msg, ssl->in_msglen);
4514 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004515 ssl->in_msglen = 0;
4516 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004517
Hanno Becker4a810fb2017-05-24 16:27:30 +01004518 ssl->in_hslen = 0;
4519 }
4520 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 else if (ssl->in_offt != NULL) {
4522 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004523 }
4524 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004526 ssl->in_msglen = 0;
4527 }
4528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004530}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004531
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004532MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004533static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004534{
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 if (ssl->in_msglen > 0) {
4536 return 1;
4537 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004540}
4541
Hanno Becker5f066e72018-08-16 14:56:31 +01004542#if defined(MBEDTLS_SSL_PROTO_DTLS)
4543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004545{
4546 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004548 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004550
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004552 hs->buffering.total_bytes_buffered -=
4553 hs->buffering.future_record.len;
4554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004556 hs->buffering.future_record.data = NULL;
4557 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004558}
4559
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004560MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004561static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004562{
4563 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004565 size_t rec_len;
4566 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004567#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4568 size_t in_buf_len = ssl->in_buf_len;
4569#else
4570 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4571#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4573 return 0;
4574 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004575
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (hs == NULL) {
4577 return 0;
4578 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004579
Hanno Becker5f066e72018-08-16 14:56:31 +01004580 rec = hs->buffering.future_record.data;
4581 rec_len = hs->buffering.future_record.len;
4582 rec_epoch = hs->buffering.future_record.epoch;
4583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (rec == NULL) {
4585 return 0;
4586 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004587
Hanno Becker4cb782d2018-08-20 11:19:05 +01004588 /* Only consider loading future records if the
4589 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4591 return 0;
4592 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004593
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004595
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 if (rec_epoch != ssl->in_epoch) {
4597 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004598 goto exit;
4599 }
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004602
4603 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4605 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4606 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004607 }
4608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004610 ssl->in_left = rec_len;
4611 ssl->next_record_offset = 0;
4612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004614
4615exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4617 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004618}
4619
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004620MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004621static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4622 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004623{
4624 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004625
4626 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 if (hs == NULL) {
4628 return 0;
4629 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004630
4631 /* Only buffer handshake records (we are only interested
4632 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4634 return 0;
4635 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004636
4637 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (hs->buffering.future_record.data != NULL) {
4639 return 0;
4640 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004641
Hanno Becker01315ea2018-08-21 17:22:17 +01004642 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4644 hs->buffering.total_bytes_buffered)) {
4645 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4646 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4647 " (already %" MBEDTLS_PRINTF_SIZET
4648 " bytes buffered) -- ignore\n",
4649 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4650 hs->buffering.total_bytes_buffered));
4651 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004652 }
4653
Hanno Becker5f066e72018-08-16 14:56:31 +01004654 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4656 ssl->in_epoch + 1U));
4657 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004658
4659 /* ssl_parse_record_header() only considers records
4660 * of the next epoch as candidates for buffering. */
4661 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004662 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004663
4664 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 mbedtls_calloc(1, hs->buffering.future_record.len);
4666 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004667 /* If we run out of RAM trying to buffer a
4668 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004670 }
4671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004673
Hanno Becker519f15d2019-07-11 12:43:20 +01004674 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004676}
4677
4678#endif /* MBEDTLS_SSL_PROTO_DTLS */
4679
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004680MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004681static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004682{
Janos Follath865b3eb2019-12-16 11:46:15 +00004683 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004684 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004685
Hanno Becker5f066e72018-08-16 14:56:31 +01004686#if defined(MBEDTLS_SSL_PROTO_DTLS)
4687 /* We might have buffered a future record; if so,
4688 * and if the epoch matches now, load it.
4689 * On success, this call will set ssl->in_left to
4690 * the length of the buffered record, so that
4691 * the calls to ssl_fetch_input() below will
4692 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 ret = ssl_load_buffered_record(ssl);
4694 if (ret != 0) {
4695 return ret;
4696 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004697#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004698
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004699 /* Ensure that we have enough space available for the default form
4700 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4701 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4703 if (ret != 0) {
4704 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4705 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004706 }
4707
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4709 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4712 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4713 ret = ssl_buffer_future_record(ssl, &rec);
4714 if (ret != 0) {
4715 return ret;
4716 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004717
4718 /* Fall through to handling of unexpected records */
4719 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4720 }
4721
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004723#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004724 /* Reset in pointers to default state for TLS/DTLS records,
4725 * assuming no CID and no offset between record content and
4726 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004728
Hanno Becker7ae20e02019-07-12 08:33:49 +01004729 /* Setup internal message pointers from record structure. */
4730 ssl->in_msgtype = rec.type;
4731#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4732 ssl->in_len = ssl->in_cid + rec.cid_len;
4733#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4734 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4735 ssl->in_msglen = rec.data_len;
4736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 ret = ssl_check_client_reconnect(ssl);
4738 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4739 if (ret != 0) {
4740 return ret;
4741 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004742#endif
4743
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004744 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004745 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4748 "(header)"));
4749 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004750 /* Skip invalid record and the rest of the datagram */
4751 ssl->next_record_offset = 0;
4752 ssl->in_left = 0;
4753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4755 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004756 }
4757
4758 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4760 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004761#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004762 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004764 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004765 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004767#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004769 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004770 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (ssl->next_record_offset < ssl->in_left) {
4772 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004773 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004775#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004776 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004777 /*
4778 * Fetch record contents from underlying transport.
4779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4781 if (ret != 0) {
4782 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4783 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004784 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004785
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004786 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004787 }
4788
4789 /*
4790 * Decrypt record contents.
4791 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004794#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004796 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004798 /* Except when waiting for Finished as a bad mac here
4799 * probably means something went wrong in the handshake
4800 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4802 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004803#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4805 mbedtls_ssl_send_alert_message(ssl,
4806 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4807 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004808 }
4809#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004811 }
4812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (ssl->conf->badmac_limit != 0 &&
4814 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4815 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4816 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004817 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004818
Hanno Becker4a810fb2017-05-24 16:27:30 +01004819 /* As above, invalid records cause
4820 * dismissal of the whole datagram. */
4821
4822 ssl->next_record_offset = 0;
4823 ssl->in_left = 0;
4824
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4826 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004827 }
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 return ret;
4830 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004831#endif
4832 {
4833 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004834#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4836 mbedtls_ssl_send_alert_message(ssl,
4837 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4838 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004839 }
4840#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004842 }
4843 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004844
Hanno Becker44d89b22019-07-12 09:40:44 +01004845
4846 /* Reset in pointers to default state for TLS/DTLS records,
4847 * assuming no CID and no offset between record content and
4848 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004850#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4851 ssl->in_len = ssl->in_cid + rec.cid_len;
4852#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004853 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004854
Hanno Becker8685c822019-07-12 09:37:30 +01004855 /* The record content type may change during decryption,
4856 * so re-read it. */
4857 ssl->in_msgtype = rec.type;
4858 /* Also update the input buffer, because unfortunately
4859 * the server-side ssl_parse_client_hello() reparses the
4860 * record header when receiving a ClientHello initiating
4861 * a renegotiation. */
4862 ssl->in_hdr[0] = rec.type;
4863 ssl->in_msg = rec.buf + rec.data_offset;
4864 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004866
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004868}
4869
Gilles Peskine449bd832023-01-11 14:50:10 +01004870int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004871{
Janos Follath865b3eb2019-12-16 11:46:15 +00004872 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004873
Manuel Pégourié-Gonnarde26a0602025-03-05 12:52:18 +01004874 /* If we're in the middle of a fragmented TLS handshake message,
4875 * we don't accept any other message type. For TLS 1.3, the spec forbids
4876 * interleaving other message types between handshake fragments. For TLS
4877 * 1.2, the spec does not forbid it but we do. */
4878 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM &&
4879 ssl->in_hsfraglen != 0 &&
4880 ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
4881 MBEDTLS_SSL_DEBUG_MSG(1, ("non-handshake message in the middle"
4882 " of a fragmented handshake message"));
4883 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
4884 }
4885
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004886 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004887 * Handle particular types of records
4888 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4890 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4891 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004892 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004893 }
4894
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4896 if (ssl->in_msglen != 1) {
4897 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4898 ssl->in_msglen));
4899 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004900 }
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (ssl->in_msg[0] != 1) {
4903 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4904 ssl->in_msg[0]));
4905 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004906 }
4907
4908#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004910 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4912 if (ssl->handshake == NULL) {
4913 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4914 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004915 }
4916
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4918 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004919 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004920#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004921
Ronald Cron6f135e12021-12-08 16:57:54 +01004922#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004924 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4926 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004927 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004928#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004929 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4932 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004933 /* Note: Standard allows for more than one 2 byte alert
4934 to be packed in a single message, but Mbed TLS doesn't
4935 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4937 ssl->in_msglen));
4938 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004939 }
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4942 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004943
4944 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004945 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004946 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4948 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4949 ssl->in_msg[1]));
4950 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004951 }
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4954 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4955 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4956 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004957 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004958
4959#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4961 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4962 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004963 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004965 }
4966#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004967 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004968 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004969 }
4970
Hanno Beckerc76c6192017-06-06 10:03:17 +01004971#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004973 /* Drop unexpected ApplicationData records,
4974 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4976 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004977#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4979 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004980#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 ) {
4982 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4983 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004984 }
4985
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 if (ssl->handshake != NULL &&
4987 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4988 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004989 }
4990 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004991#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004992
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004994}
4995
Gilles Peskine449bd832023-01-11 14:50:10 +01004996int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004997{
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 return mbedtls_ssl_send_alert_message(ssl,
4999 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5000 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005001}
5002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5004 unsigned char level,
5005 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005006{
Janos Follath865b3eb2019-12-16 11:46:15 +00005007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005008
Gilles Peskine449bd832023-01-11 14:50:10 +01005009 if (ssl == NULL || ssl->conf == NULL) {
5010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5011 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (ssl->out_left != 0) {
5014 return mbedtls_ssl_flush_output(ssl);
5015 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5018 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005020 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005021 ssl->out_msglen = 2;
5022 ssl->out_msg[0] = level;
5023 ssl->out_msg[1] = message;
5024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5026 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5027 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005028 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005030
Gilles Peskine449bd832023-01-11 14:50:10 +01005031 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005032}
5033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005035{
Janos Follath865b3eb2019-12-16 11:46:15 +00005036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005040 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005041 ssl->out_msglen = 1;
5042 ssl->out_msg[0] = 1;
5043
Gilles Peskinef670ba52025-03-07 15:09:32 +01005044 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5047 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5048 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005049 }
5050
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005054}
5055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005057{
Janos Follath865b3eb2019-12-16 11:46:15 +00005058 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5063 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5064 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005065 }
5066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5069 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5070 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5071 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005072 }
5073
Hanno Beckere678eaa2018-08-21 14:57:46 +01005074 /* CCS records are only accepted if they have length 1 and content '1',
5075 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005076
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005077 /*
5078 * Switch to our negotiated transform and session parameters for inbound
5079 * data.
5080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005082#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005083 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005084#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005085 ssl->session_in = ssl->session_negotiate;
5086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005089#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005091#endif
5092
5093 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 if (++ssl->in_epoch == 0) {
5095 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005096 /* This is highly unlikely to happen for legitimate reasons, so
5097 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005099 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005101#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005105
Gilles Peskinef670ba52025-03-07 15:09:32 +01005106 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005111}
5112
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005113/* Once ssl->out_hdr as the address of the beginning of the
5114 * next outgoing record is set, deduce the other pointers.
5115 *
5116 * Note: For TLS, we save the implicit record sequence number
5117 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5118 * and the caller has to make sure there's space for this.
5119 */
5120
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005121static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005123{
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005125}
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5128 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005129{
5130#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005132 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005133#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005134 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005135 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005137 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005139#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005140 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005141#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005142 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005144#endif
5145 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005146 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005147#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005148 ssl->out_cid = ssl->out_len;
5149#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005150 ssl->out_iv = ssl->out_hdr + 5;
5151 }
5152
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005153 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005154 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (transform != NULL) {
5156 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5157 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005158}
5159
5160/* Once ssl->in_hdr as the address of the beginning of the
5161 * next incoming record is set, deduce the other pointers.
5162 *
5163 * Note: For TLS, we save the implicit record sequence number
5164 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5165 * and the caller has to make sure there's space for this.
5166 */
5167
Gilles Peskine449bd832023-01-11 14:50:10 +01005168void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005169{
Hanno Becker79594fd2019-05-08 09:38:41 +01005170 /* This function sets the pointers to match the case
5171 * of unprotected TLS/DTLS records, with both ssl->in_iv
5172 * and ssl->in_msg pointing to the beginning of the record
5173 * content.
5174 *
5175 * When decrypting a protected record, ssl->in_msg
5176 * will be shifted to point to the beginning of the
5177 * record plaintext.
5178 */
5179
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005180#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005182 /* This sets the header pointers to match records
5183 * without CID. When we receive a record containing
5184 * a CID, the fields are shifted accordingly in
5185 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005186 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005187#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005188 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005189 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005190#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005191 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005193 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005194 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005195#endif
5196 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005197 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005198 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005199#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005200 ssl->in_cid = ssl->in_len;
5201#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005202 ssl->in_iv = ssl->in_hdr + 5;
5203 }
5204
Hanno Becker79594fd2019-05-08 09:38:41 +01005205 /* This will be adjusted at record decryption time. */
5206 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005207}
5208
Paul Bakker5121ce52009-01-03 21:22:43 +00005209/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005210 * Setup an SSL context
5211 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005212
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005213void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5214{
5215#if defined(MBEDTLS_SSL_PROTO_DTLS)
5216 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5217 ssl->in_hdr = ssl->in_buf;
5218 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005219#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005220 {
5221 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5222 }
5223
5224 /* Derive other internal pointers. */
5225 mbedtls_ssl_update_in_pointers(ssl);
5226}
5227
5228void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005229{
5230 /* Set the incoming and outgoing record pointers. */
5231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005233 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005235#endif /* MBEDTLS_SSL_PROTO_DTLS */
5236 {
Hanno Becker12078f42021-03-02 15:28:41 +00005237 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005238 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005239 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005240 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005242}
5243
Paul Bakker5121ce52009-01-03 21:22:43 +00005244/*
5245 * SSL get accessors
5246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005247size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005248{
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005250}
5251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005253{
5254 /*
5255 * Case A: We're currently holding back
5256 * a message for further processing.
5257 */
5258
Gilles Peskine449bd832023-01-11 14:50:10 +01005259 if (ssl->keep_current_message == 1) {
5260 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5261 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005262 }
5263
5264 /*
5265 * Case B: Further records are pending in the current datagram.
5266 */
5267
5268#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5270 ssl->in_left > ssl->next_record_offset) {
5271 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5272 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005273 }
5274#endif /* MBEDTLS_SSL_PROTO_DTLS */
5275
5276 /*
5277 * Case C: A handshake message is being processed.
5278 */
5279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5281 MBEDTLS_SSL_DEBUG_MSG(3,
5282 ("ssl_check_pending: more handshake messages within current record"));
5283 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005284 }
5285
5286 /*
5287 * Case D: An application data message is being processed
5288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if (ssl->in_offt != NULL) {
5290 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5291 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005292 }
5293
5294 /*
5295 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005296 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005297 * we implement support for multiple alerts in single records.
5298 */
5299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5301 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005302}
5303
Paul Bakker43ca69c2011-01-15 17:35:19 +00005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005306{
Hanno Becker3136ede2018-08-17 15:28:19 +01005307 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005308 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005309 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005310 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5311 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005314
Gilles Peskine449bd832023-01-11 14:50:10 +01005315 if (transform == NULL) {
5316 return (int) out_hdr_len;
5317 }
Hanno Becker78640902018-08-13 16:35:15 +01005318
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 if (transform->psa_alg == PSA_ALG_GCM ||
5321 transform->psa_alg == PSA_ALG_CCM ||
5322 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5323 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5324 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005325 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5327 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5328 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005329
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005331
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005332 /* Expansion due to the addition of the MAC. */
5333 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005334
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005335 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005336 * Theoretically up to 256 bytes, but we never use
5337 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005338 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005339
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005340 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005341 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005342#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005343 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005344#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 } else {
5346 MBEDTLS_SSL_DEBUG_MSG(1,
5347 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5348 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005349 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005350
Hanno Beckera0e20d02019-05-15 14:03:01 +01005351#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005353 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005355#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005356
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005358}
5359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005360#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005361/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005362 * Check record counters and renegotiate if they're above the limit.
5363 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005364MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005365static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005366{
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005368 int in_ctr_cmp;
5369 int out_ctr_cmp;
5370
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005372 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5374 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005375 }
5376
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5378 &ssl->conf->renego_period[ep_len],
5379 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5380 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005381 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005383
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5385 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005386 }
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5389 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005390}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005391#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005392
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005393#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5394
Ronald Cron7df18bc2024-03-25 13:42:07 +01005395#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005396MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005397static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005398{
5399
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5401 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005402 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005403 }
5404
Ronald Croncf47a152024-04-02 13:19:57 +02005405 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005406}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005407#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005408
Jerry Yua0446a02022-07-13 11:22:55 +08005409MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005410static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005411{
5412
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005414
Ronald Cron7df18bc2024-03-25 13:42:07 +01005415#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005417 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005418#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5419 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5420 ssl->keep_current_message = 1;
5421
5422 mbedtls_ssl_handshake_set_state(ssl,
5423 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5424 return MBEDTLS_ERR_SSL_WANT_READ;
5425#else
5426 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5427 return 0;
5428#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005430 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005431#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005432
5433 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005434 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005435}
5436#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5437
5438#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005439/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005440 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005441 * may only be sent for the purpose of initiating renegotiations.
5442 *
5443 * This function is introduced as a separate helper since the handling
5444 * of post-handshake handshake messages changes significantly in TLS 1.3,
5445 * and having a helper function allows to distinguish between TLS <= 1.2 and
5446 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5447 */
Jerry Yua0446a02022-07-13 11:22:55 +08005448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005449static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005450{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005452
5453 /*
5454 * - For client-side, expect SERVER_HELLO_REQUEST.
5455 * - For server-side, expect CLIENT_HELLO.
5456 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5457 */
5458
5459#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5461 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5462 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5463 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
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_CLI_C */
5474
5475#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5477 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5478 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005479
5480 /* With DTLS, drop the packet (probably from last handshake) */
5481#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5483 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005484 }
5485#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005487 }
5488#endif /* MBEDTLS_SSL_SRV_C */
5489
5490#if defined(MBEDTLS_SSL_RENEGOTIATION)
5491 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5493 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5494 ssl->conf->allow_legacy_renegotiation ==
5495 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005496 /*
5497 * Accept renegotiation request
5498 */
5499
5500 /* DTLS clients need to know renego is server-initiated */
5501#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5503 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005504 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5505 }
5506#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 ret = mbedtls_ssl_start_renegotiation(ssl);
5508 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5509 ret != 0) {
5510 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5511 ret);
5512 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005513 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005515#endif /* MBEDTLS_SSL_RENEGOTIATION */
5516 {
5517 /*
5518 * Refuse renegotiation
5519 */
5520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5524 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5525 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5526 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005527 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005528 }
5529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005531}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005532#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5533
5534MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005535static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005536{
5537 /* Check protocol version and dispatch accordingly. */
5538#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5540 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005541 }
5542#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5543
5544#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5546 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005547 }
5548#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5549
5550 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005552}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005553
Paul Bakker48916f92012-09-16 19:57:18 +00005554/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005555 * brief Read at most 'len' application data bytes from the input
5556 * buffer.
5557 *
5558 * param ssl SSL context:
5559 * - First byte of application data not read yet in the input
5560 * buffer located at address `in_offt`.
5561 * - The number of bytes of data not read yet is `in_msglen`.
5562 * param buf buffer that will hold the data
5563 * param len maximum number of bytes to read
5564 *
5565 * note The function updates the fields `in_offt` and `in_msglen`
5566 * according to the number of bytes read.
5567 *
5568 * return The number of bytes read.
5569 */
5570static int ssl_read_application_data(
5571 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5572{
5573 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5574
5575 if (len != 0) {
5576 memcpy(buf, ssl->in_offt, n);
5577 ssl->in_msglen -= n;
5578 }
5579
5580 /* Zeroising the plaintext buffer to erase unused application data
5581 from the memory. */
5582 mbedtls_platform_zeroize(ssl->in_offt, n);
5583
5584 if (ssl->in_msglen == 0) {
5585 /* all bytes consumed */
5586 ssl->in_offt = NULL;
5587 ssl->keep_current_message = 0;
5588 } else {
5589 /* more data available */
5590 ssl->in_offt += n;
5591 }
5592
5593 return (int) n;
5594}
5595
5596/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005597 * Receive application data decrypted from the SSL layer
5598 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005599int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005600{
Janos Follath865b3eb2019-12-16 11:46:15 +00005601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005602
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 if (ssl == NULL || ssl->conf == NULL) {
5604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5605 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005608
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005609#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5611 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5612 return ret;
5613 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005614
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 if (ssl->handshake != NULL &&
5616 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5617 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5618 return ret;
5619 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005620 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005621 }
5622#endif
5623
Hanno Becker4a810fb2017-05-24 16:27:30 +01005624 /*
5625 * Check if renegotiation is necessary and/or handshake is
5626 * in process. If yes, perform/continue, and fall through
5627 * if an unexpected packet is received while the client
5628 * is waiting for the ServerHello.
5629 *
5630 * (There is no equivalent to the last condition on
5631 * the server-side as it is not treated as within
5632 * a handshake while waiting for the ClientHello
5633 * after a renegotiation request.)
5634 */
5635
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005636#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 ret = ssl_check_ctr_renegotiate(ssl);
5638 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5639 ret != 0) {
5640 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5641 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005642 }
5643#endif
5644
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5646 ret = mbedtls_ssl_handshake(ssl);
5647 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5648 ret != 0) {
5649 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5650 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005651 }
5652 }
5653
Hanno Beckere41158b2017-10-23 13:30:32 +01005654 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005656 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005657 if (ssl->f_get_timer != NULL &&
5658 ssl->f_get_timer(ssl->p_timer) == -1) {
5659 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005660 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5663 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5664 return 0;
5665 }
Paul Bakker831a7552011-05-18 13:32:51 +00005666
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5668 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005669 }
5670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if (ssl->in_msglen == 0 &&
5672 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005673 /*
5674 * OpenSSL sends empty messages to randomize the IV
5675 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5677 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5678 return 0;
5679 }
Paul Bakker831a7552011-05-18 13:32:51 +00005680
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5682 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005683 }
5684 }
5685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5687 ret = ssl_handle_hs_message_post_handshake(ssl);
5688 if (ret != 0) {
5689 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5690 ret);
5691 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005692 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005693
Hanno Beckerf26cc722021-04-21 07:30:13 +01005694 /* At this point, we don't know whether the renegotiation triggered
5695 * by the post-handshake message has been completed or not. The cases
5696 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005697 * 1) The renegotiation is complete. In this case, no new record
5698 * has been read yet.
5699 * 2) The renegotiation is incomplete because the client received
5700 * an application data record while awaiting the ServerHello.
5701 * 3) The renegotiation is incomplete because the client received
5702 * a non-handshake, non-application data message while awaiting
5703 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005704 *
5705 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005706 * - For 1), the next iteration will read a new record and check
5707 * if it's application data.
5708 * - For 2), the loop condition isn't satisfied as application data
5709 * is present, hence continue is the same as break
5710 * - For 3), the loop condition is satisfied and read_record
5711 * will re-deliver the message that was held back by the client
5712 * when expecting the ServerHello.
5713 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005714
Hanno Becker90333da2017-10-10 11:27:13 +01005715 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005716 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005717#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5719 if (ssl->conf->renego_max_records >= 0) {
5720 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5721 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5722 "but not honored by client"));
5723 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005724 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005725 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005726 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005727#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005729 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5731 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5732 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005733 }
5734
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5736 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5737 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005738 }
5739
5740 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005741
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005742 /* We're going to return something now, cancel timer,
5743 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5745 mbedtls_ssl_set_timer(ssl, 0);
5746 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005747
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005748#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005749 /* If we requested renego but received AppData, resend HelloRequest.
5750 * Do it now, after setting in_offt, to avoid taking this branch
5751 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005752#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5754 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5755 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5756 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5757 ret);
5758 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005759 }
5760 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005762#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005763 }
5764
Jerry Yu739a1d42022-12-08 21:10:25 +08005765 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005766
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005768
Jerry Yu739a1d42022-12-08 21:10:25 +08005769 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005770}
5771
Jerry Yud9ca3542023-12-06 17:23:52 +08005772#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5773int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5774 unsigned char *buf, size_t len)
5775{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005776 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5778 }
5779
Ronald Cron164537c2024-02-01 18:05:47 +01005780 /*
5781 * The server may receive early data only while waiting for the End of
5782 * Early Data handshake message.
5783 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005784 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5785 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005786 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5787 }
5788
Ronald Croned7d4bf2024-01-31 07:55:19 +01005789 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005790}
5791#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5792
Paul Bakker5121ce52009-01-03 21:22:43 +00005793/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005794 * Send application data to be encrypted by the SSL layer, taking care of max
5795 * fragment length and buffer size.
5796 *
5797 * According to RFC 5246 Section 6.2.1:
5798 *
5799 * Zero-length fragments of Application data MAY be sent as they are
5800 * potentially useful as a traffic analysis countermeasure.
5801 *
5802 * Therefore, it is possible that the input message length is 0 and the
5803 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005804 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005805MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005806static int ssl_write_real(mbedtls_ssl_context *ssl,
5807 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005808{
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005810 const size_t max_len = (size_t) ret;
5811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 if (ret < 0) {
5813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5814 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005815 }
5816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5820 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5821 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5822 " > %" MBEDTLS_PRINTF_SIZET,
5823 len, max_len));
5824 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5825 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005826#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005828 }
Paul Bakker887bd502011-06-08 13:10:54 +00005829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005831 /*
5832 * The user has previously tried to send the data and
5833 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5834 * written. In this case, we expect the high-level write function
5835 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5838 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5839 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005840 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005842 /*
5843 * The user is trying to send a message the first time, so we need to
5844 * copy the data into the internal buffers and setup the data structure
5845 * to keep track of partial writes
5846 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005847 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005848 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005849 if (len > 0) {
5850 memcpy(ssl->out_msg, buf, len);
5851 }
Paul Bakker887bd502011-06-08 13:10:54 +00005852
Gilles Peskine449bd832023-01-11 14:50:10 +01005853 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5854 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5855 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005856 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005857 }
5858
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005860}
5861
5862/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005863 * Write application data (public-facing wrapper)
5864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005865int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005866{
Janos Follath865b3eb2019-12-16 11:46:15 +00005867 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005870
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 if (ssl == NULL || ssl->conf == NULL) {
5872 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5873 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005874
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005875#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5877 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5878 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879 }
5880#endif
5881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5883 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5884 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5885 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005886 }
5887 }
5888
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005892
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005894}
5895
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005896#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5897int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5898 const unsigned char *buf, size_t len)
5899{
5900 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5901 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005902 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005903
5904 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5905
5906 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5907 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5908 }
5909
Ronald Cron49221902024-02-21 13:39:14 +01005910 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5911 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5912 }
5913
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005914 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5915 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5916 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5917 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5918 }
5919
5920 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5921 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5922 }
5923
5924 /*
Ronald Crond2884662024-03-03 15:03:22 +01005925 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005926 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005927 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005928 * enough to be able to send early data if possible. That way, we can
5929 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005930 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005931 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5932 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005933 * as the early data outbound transform has not been set as we may have to
5934 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005935 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005936 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005937 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005938 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005939 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005940 ret = mbedtls_ssl_handshake_step(ssl);
5941 if (ret != 0) {
5942 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5943 return ret;
5944 }
5945
5946 ret = mbedtls_ssl_flush_output(ssl);
5947 if (ret != 0) {
5948 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5949 return ret;
5950 }
5951 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005952 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005953 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005954 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005955 * If we are past the point where we can send early data or we have
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01005956 * already reached the maximum early data size, return immediately.
Ronald Cron62f971a2024-02-23 08:24:12 +01005957 * Otherwise, progress the handshake as much as possible to not delay
5958 * it too much. If we reach a point where we can still send early data,
5959 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005960 */
Ronald Crond2884662024-03-03 15:03:22 +01005961 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5962 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005963 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5964 }
5965
Ronald Cron62f971a2024-02-23 08:24:12 +01005966 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005967 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005968
5969 if (remaining == 0) {
5970 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5971 }
5972
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005973 ret = mbedtls_ssl_handshake(ssl);
5974 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5975 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5976 return ret;
5977 }
5978 }
5979
Ronald Crond2884662024-03-03 15:03:22 +01005980 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5981 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005982 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005983 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5984 }
5985
Ronald Cron62f971a2024-02-23 08:24:12 +01005986 if (len > remaining) {
5987 len = remaining;
5988 }
5989
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005990 ret = ssl_write_real(ssl, buf, len);
5991 if (ret >= 0) {
5992 ssl->total_early_data_size += ret;
5993 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005994
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005995 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005996
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005997 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005998}
5999#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6000
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006001/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006002 * Notify the peer that the connection is being closed
6003 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006004int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006005{
Janos Follath865b3eb2019-12-16 11:46:15 +00006006 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006007
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 if (ssl == NULL || ssl->conf == NULL) {
6009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6010 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006013
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6015 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6016 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6017 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6018 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6019 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006020 }
6021 }
6022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006024
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006026}
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006029{
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006031 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 psa_destroy_key(transform->psa_key_enc);
6035 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006036
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006037#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 psa_destroy_key(transform->psa_mac_enc);
6039 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00006040#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006043}
6044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6046 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006047{
Jerry Yuc7875b52021-09-05 21:05:50 +08006048 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006050}
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6053 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006054{
6055 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006057}
6058
Hanno Becker0271f962018-08-16 13:23:47 +01006059#if defined(MBEDTLS_SSL_PROTO_DTLS)
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006062{
6063 unsigned offset;
6064 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006067 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 }
Hanno Becker0271f962018-08-16 13:23:47 +01006069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006071
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6073 ssl_buffering_free_slot(ssl, offset);
6074 }
Hanno Beckere605b192018-08-21 15:59:07 +01006075}
6076
Gilles Peskine449bd832023-01-11 14:50:10 +01006077static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6078 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006079{
6080 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6081 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006084 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006088 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006089 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006091 }
6092}
6093
6094#endif /* MBEDTLS_SSL_PROTO_DTLS */
6095
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006096/*
6097 * Convert version numbers to/from wire format
6098 * and, for DTLS, to/from TLS equivalent.
6099 *
6100 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006101 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006102 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006103 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006104 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006105void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6106 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006107{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006108 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006109#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006111 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006113 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006114#else
6115 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006116#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006117 {
6118 tls_version_formatted = (uint16_t) tls_version;
6119 }
6120 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006121}
6122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6124 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006125{
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006129 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6131 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006132#else
6133 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006134#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006135 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006136}
6137
Jerry Yue7047812021-09-13 19:26:39 +08006138/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006139 * Send pending fatal alert.
6140 * 0, No alert message.
6141 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6142 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006144int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006145{
6146 int ret;
6147
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006148 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 if (ssl->send_alert == 0) {
6150 return 0;
6151 }
Jerry Yu394ece62021-09-14 22:17:21 +08006152
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 ret = mbedtls_ssl_send_alert_message(ssl,
6154 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6155 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006156
Jerry Yu3bf1f972021-09-22 21:37:18 +08006157 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6158 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006159 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006161 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006162 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006163
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 if (ret != 0) {
6165 return ret;
6166 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006169}
6170
Jerry Yu394ece62021-09-14 22:17:21 +08006171/*
6172 * Set pending fatal alert flag.
6173 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006174void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6175 unsigned char alert_type,
6176 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006177{
6178 ssl->send_alert = 1;
6179 ssl->alert_type = alert_type;
6180 ssl->alert_reason = alert_reason;
6181}
6182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006183#endif /* MBEDTLS_SSL_TLS_C */